The AdapTable API provides full, programmatic, run-time, access to all functionality provided by AdapTable.
The Adaptable API is essentially just a wrapper around the AdapTable Store but provides additional error-checking, logging, and auditing; it thereby ensures that the data in the store remains immutable.
Anything that can be done in the AdapTable UI is also available programatically via the Adaptable API.
This allows users to manage AdapTable objects in custom screens completely bypassing AdapTable's UI.
We try to keep the API as rich as possible so please contact Adaptable Support if a method is missing from the Adaptable API that would be benefical.
The Adaptable API should be all you need to access Adaptable programmatically and is the only public, documented interface that is guaranteed not to change between versions
Accessing the Adaptable API
The Adaptable API is the only object returned by the AdapTable static constructor.
Module-Related API classes
|alertApi||Adaptable Alerts provide bespoke notifications and messages|
|applicationApi||Use Application Data Entries to manage custom state and data|
|bulkUpdateApi||Run Bulk Update so mutliple selected cells are given same value|
|calculatedColumnApi||Manages Calculated Columns which contain custom expressions|
|cellSummaryApi||Choose which Cell Summaries to display when cells are selected|
|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|
|freeTextColumnApi||Configures FreeText Columns - special columns containing bespoke data|
|layoutApi||Manages Layouts - sets of column order and visibility|
|queryApi||Functions relating to the saveable, cross-column Queries|
|quickSearchApi||Functions for running and clearing Quick Search|
|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 Module to enable better editing|
|systemStatusApi||Manages how the System Status Module will display run-time messages|
|themeApi||Deals with Themes both AdapTable and Custom|
|toolPanelApi||Functions for working with the AdapTable ToolPanel Component|
General API classes
|columnApi||Large number of column-related functions|
|configApi||Series of functions managing Predefined Config and User State|
|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|