Plugins Reference
Summary
- Plugins are groupings of functionality relevant to a particular use case or set of users
- Currently 5 plugins available with more to come in due course
AdapTable Plugins
AdapTable provides 5 plugins.
Note
- Plugins keep the AdapTable download to a manageable size
- They ensure developers only download the functionality which is needed
| Plugin | Description |
|---|---|
| AdapTable No Code | Create AdapTable and AG Grid instances on the fly |
| Master Detail | Leverages the Master / Detail grids provided by AG Grid |
| OpenFin | Additional functionality when using AdapTable inside the OpenFin container |
| interop.io | Leverages interop.io connect (previously Finsemble & Glue42) for AdapTable users |
| ipushpull | Promotes collaboration through ipushpull |
Breaking Change
- The Charts Plugin was removed in Version 11 in place of comprehensive support of AG Grid Charting
- The Finance Plugin was removed in Version 16 as FDC3 Support was moved into the core product
- The Finsemble & Glue Plugins were replaced in Version 18 with a new interop.io plugin
Configuring Plugins
There are a few steps required if you wish to use Plugins.
Developer Guide
Setting up Plugins in AdapTable
To use the AdapTable plugins you need to do the following:
Terminal
npm install @adaptabletools/adaptable-plugin-master-detail
1
Install the plugin packages you need
Do this via the usual npm install.
Only install pluings you wish to use in your application.
Important
- You must install the same version of the plugin as you use for the AdapTable Vanilla, React or Angular package
- AdapTable will send a warning message to the console if these are different
import nocode from "@adaptabletools/adaptable-plugin-nocode-aggrid";
import masterDetail from "@adaptabletools/adaptable-plugin-master-detail-aggrid";
import ipushpull from "@adaptabletools/adaptable-plugin-ipushpull";
import interop from "@adaptabletools/adaptable-plugin-interop";
import openfin from "@adaptabletools/adaptable-plugin-openfin";2
Import the plugin(s) in your code when instantiating AdapTable:
Assuming you are using all the plugins then you will need all these import statements:
const adaptableOptions: AdaptableOptions = {
primaryKey: "OrderId",
adaptableId: "Plugin Demo",
// call the plugins functions and pass them to plugins array
plugins: [masterdetail(), nocode(), openfin(openFinOptions)],
.....
}3
Add the plugins to Adaptable Options
Add the plugins to Adaptable Options via the plugins property.
Some plugins can optionally receive an Options object in the constructor, so provide this if required.
Accessing Plugins
The Plugins API section of Adaptable API can be used for accessing an individual plugin at run-time.
Most Plugins have a dedicated Api page which can be retrieved directly from PluginsApi, e.g.:
const ipushpullApi: IPushPullApi = adaptableApi.pluginsApi.getipushpullPluginApi();Full list of methods in Plugins API is:
| 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) |