Adaptable API Reference
Summary
- Adaptable API enables full run-time progammatic access to all functionality in AdapTable
- It also enables developers to retrieve and modify Adaptable State
- Every Adaptable Object can be added, edited, deleted, suspended or shared using the Adaptable API
- The Adaptable API is divided into a series of classes of related material:
- Many are grouped around an Adaptable Module (e.g. Alert, Calculated Column etc)
- Others are thematic groups of properties (e.g. Scope, Predicates, Grid)
- Also includes access to AG Grid's Grid Api object
- The Adaptable API contains an Event class which is used for subscribing to Adaptable Events
API Classes
There are many sections in Adaptable API - based around Modules or thematic functionality.
| API Section | Details |
|---|---|
| Action Column | Functions for accessing Action Columns |
| Alert | Contains methods for managing Alerts in Adaptable |
| Application | Used for saving Custom AdapTable State |
| Bulk Update | Functions to apply Bulk Updates programmatically |
| Calculated Column | Functions relating to Calculated Columns |
| Calendar | Manages Holidays and Working Days |
| Cell Summary | Accesses AG Grid Cell and Row Summary information |
| Charting | Enables persistence of Charts in AdapTable |
| Column | Numerous functions for managing Adaptable Columns |
| Column Menu | Manges the Column Menu |
| Column Scope | Enables progrommatic access to Column and DataType Scoping |
| Comments | Run-time access to Comments |
| Context Menu | Manages the Context Menu |
| Custom Sort | Contains methods for managing Custom Sorts |
| Dashboard | Contains methods for managing the AdapTable Dashboard |
| Data Change History | Functions enabling Data Change History to be configured |
| Data Import | Used for Importing Data into AdapTable |
| Data Set | Accesses Data Set functionality at runtime |
| Entitlement | Manages Entitlements and Permissions |
| Event | Used for publishing Adaptable Events |
| Export | Allows Reports to be run programmatically |
| Expression | Used for configuring Expressions in AdapTableQL |
| Event | Used for firing AdapTable's many Events |
| FDC3 | Functions relating to collaborating via FDC3 |
| Filter | Manages both Column Filters and the Grid Filter |
| Flashing Cell | Access the Flashing Cells functionality in AdapTable |
| Format Column | Function which access AdapTable Format Columns |
| Free Text Column | Contains methods for managing FreeText Columns |
| Grid | Contains functions for managing AG Grid and row data |
| Layout | Provides run-time access to Layouts |
| Named Query | Functions that manage Named Queries |
| Notes | Run-time access to Notes |
| Options | Provides access to Adaptable Options |
| Plus Minus | Functions enabling Plus Minus Nudges and Rules |
| Predicate | Configures Predicates in AdapTable |
| Quick Search | Applying and managing Quick Searches in AdapTable |
| Row Form | Methods for displaying Row Forms |
| Schedule | Functions for managing Schedules in AdapTable |
| Settings Panel | Accesses AdapTable's Settings Panel |
| Shortcut | Create Shortcut rules at runtime |
| Smart Edit | Functions to apply Smart Edits programmatically |
| State | Functions for accessing and manipulating AdapTable State |
| Status Bar | Programattic access to the Status Bar |
| Styled Column | Manges Styled Columns in Adaptable |
| System Status | Manages displaying System Status messages |
| Team Sharing | Enables Team Sharing to be managed programmatically |
| Theme | Contains methods for managing Themes in AdapTable |
| Tool Panel | Manages the AdapTable Tool Panel Component |
| User Interface | Configures AdapTable's User Inteface Components |
Plugin API Classes
| Plugin API Section | Details |
|---|---|
| Plugins | Manages access to the Plugins and individual plugin api classes |
| interop | Functions relating to the interop.io plugin |
| ipushpull | Runtime access to the ipushpull plugin |
| OpenFin | Functions relating to the OpenFin plugin |
AG Grid's Grid API Class
The AdapTable API also contains an agGridApi property.
As the name implies, this provides access to AG Grid's own Grid API giving full access to AG Grid features.
Caution
- As a general rule, we advise to always first to try to use the API methods provided by AdapTable where possible
- This will better ensure that AG Grid and AdapTable, and all related State, remain fully in sync at all times