The AdapTable API provides a full, rich, programmatic access to all the functionality and state inside AdapTable.
It enables developers to access the AdapTable Store, and all AdapTable functionality, at run-time in a 'safe' way.
And it allows users to create, save and delete AdapTable objects in their our screens bypassing AdapTable's UI.
Anything that can be done in AdapTable through the UI is also available progmatically via the Adaptable API
The AdaptableApiApi is essentially just a wrapper around the AdapTable Store but provides additional error-checking, logging, and auditing; it also ensures that the data in the store remains immutable.
Contact Adaptable Support if a method is missing from the Adaptable Api that would be benefical.
Accessing the Adaptable API
The Adaptable API is the only object returned by the AdapTable static constructor.
If you are using one of the Framework Wrappers then the AdaptableApi is available to you through the AdaptableReady event.
The Adaptable API consists of over 50 sets of properties; each is each a class that contains a set of Api methods grouped either by AdapTable Function (e.g. conditionalStyleApi) or type (e.g. predicateApi).
Function-Related API classes
|actionColumnApi||Manages Action Columns which contain buttons with bespoke click logic|
|alertApi||Adaptable Alerts provide bespoke notifications and messages|
|applicationApi||Use Application Data Entries to manage custom state and data|
|auditEventApi||Listen to the Audit Events published by the Audit Log|
|bulkUpdateApi||Run Bulk Update so mutliple selected cells are given same value|
|calculatedColumnApi||Manages Calculated Columns which contain custom expressions|
|calendarApi||Allows you to choose which Calendar AdapTable will use in its date filters|
|cellSummaryApi||Choose which Cell Summaries to display when cells are selected|
|cellValidationApi||Manages the Cell Validation function so that Grid cell edits are validated|
|conditionalStyleApi||Set bespoke Conditional Styles for rows and columns depending on cell data|
|customSortApi||Manages Custom Sorts allowing bespoke column sorting|
|dashboardApi||Large series of functions allowing full customisation of AdapTable's Dashboard|
|dataSourceApi||Deals with Data Sources used in Server Searching|
|exportApi||Export reports either manually or at scheduled times|
|filterApi||Manages various Filters provided by AdapTable|
|flashingCellApi||Manages the Flashing Cell|
|freeTextColumnApi||Configures FreeText Columns - special columns containing bespoke data|
|gradientColumnApi||Aids creation of visual Gradient Columns|
|layoutApi||Manages Layouts - sets of column order and visibility|
|percentBarApi||Aids creation and editing of visual Percent Bars|
|queryApi||Functions relating to the saveable, cross-column Queries|
|quickSearchApi||Functions for running and clearing Quick Search|
|reminderApi||Manages Reminders (scheduled Alerts)|
|scheduleApi||Supports Schedules for running Actions at set time|
|shortcutApi||Deals with Shortcuts for faster & safer data entry|
|smartEditApi||Functions for managing the Smart Edit function to enable better editing|
|systemStatusApi||Manages how the System Status function will display run-time messages|
|themeApi||Deals with Themes both AdapTable and Custom|
|toolPanelApi||Functions for working with the AdapTable Tool Panel|
|updatedRowApi||Manges Updated Rows which indicated which rows have updated|
General API classes
|columnApi||Large number of column-related functions|
|configApi||Series of functions managing Predefined Config and User State|
|entitlementsApi||Manages User Entitlements (essentially Permissions)|
|eventApi||Subscribe to some of the many Events that AdapTable fires|
|gridApi||Series of Grid-management related functions e.g. get/set data|
|predicateApi||Helper functions for the Predicate - boolean return function|
|scopeApi||Many methods to manage the Scope object|
|userInterfaceApi||Many properties and methods to manage the User Interface|
Plugin-related API classes
|pluginsApi||Series of functions for when using Plugins|
|chartApi||Deals with the Chart functionality (available through a plugin)|
|glue42Api||Functions to faciliate using the Glue42 plugin|
|ipushpullApi||Functions to help export data from AdapTable to ipushull|
|openfinApi||Used in conjunction with the OpenFin plugin|