PluginsApi
API methods dealing with AdapTable plugins
TypeScript
export interfaceMethods
| Method | Description |
|---|---|
| getInteropioPluginApi() | Returns Interopio API class in Adaptable API |
| getipushpullPluginApi() | Returns ipushpull API class in Adaptable API |
| getOpenFinPluginApi() | Returns OpenFin API class in Adaptable API |
| getPluginsState() | Retrieves the Plugin State (internal only) |
| getPluginState(pluginId) | Gets the State for a given Plugin |
| registerPlugin(pluginId, initialPluginState) | Registers a Plugin (internal method) |
| setPluginState(pluginId, pluginState) | Sets the initial state for a given plugin (internal method) |
Method Details
getInteropioPluginApi
Returns Interopio API class in Adaptable API
TypeScript
getInteropioPluginApi(): InteropioPluginApi;Returns
getipushpullPluginApi
Returns ipushpull API class in Adaptable API
TypeScript
getipushpullPluginApi(): IPushPullApi;Returns
getOpenFinPluginApi
Returns OpenFin API class in Adaptable API
TypeScript
getOpenFinPluginApi(): OpenFinApi;Returns
getPluginsState
Retrieves the Plugin State (internal only)
TypeScript
getPluginsState(): PluginsState;Returns
PluginsState
getPluginState
Gets the State for a given Plugin
TypeScript
getPluginState(pluginId: string): any;Parameters
| Parameter | Type | Description |
|---|---|---|
| pluginId | string | plugin state to retrieve |
Returns
any
registerPlugin
Registers a Plugin (internal method)
TypeScript
registerPlugin(pluginId: string, initialPluginState: any): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| pluginId | string | Plugin to register |
| initialPluginState | any | any state the Plugin requires |
Returns
void
setPluginState
Sets the initial state for a given plugin (internal method)
TypeScript
setPluginState(pluginId: string, pluginState: any): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| pluginId | string | Plugin to set state for |
| pluginState | any | State to set |
Returns
void