Kap.regPluginBlock

Syntax

regPluginBlock({

    settings

});

Parameters

settings. JSON object with plugin registration parameters.

The following parameters are available:

Parameter name Type Brief description
Mandatory parameters:
Id string Plugin block identifier.
Name string Plugin block name.
View string Visualizer class name.
Master string Master class name.
Js string Path to *.js file for dynamic loading of script with plugin implementation.
Optional parameters:
Icon string Path to plugin icon (16*16).
SourceClass number Value of data source object type for object filtering on data source selection.
The default value is 2827 - Time series analysis. If the value is not set (null) or is equal to -1, the plugin does not use data source.
Props object Additional plugin parameters for setting default values.

Description

The regPluginBlock method registers plugin of dashboard.

Comments

It is used to connect dashboard plugin in the web application.

Example

The method use is given in the Connecting Dashboard Plugin in the Web Application section.

See also:

Kap