AdapTable API Overview

The AdapTable API provides full, programmatic, run-time, access to all functionality provided by AdapTable.

It enables developers to access the AdapTable State, and AdapTable Modules, at run-time in a 'safe' way.

note

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.

important

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.

warning

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.

tip

If you are using one of the Framework Wrappers then the Adaptable API is available in the AdaptableReadyInfo object provided by the AdaptableReady event.

API Classes

The Adaptable API consists of a large set of properties; each is a class that contains a set of API methods grouped either by AdapTable Module (e.g. conditionalStyleApi) or type (e.g. predicateApi).

In addition there are a few api classes designed primarily for internal use which deal with how AdapTable itself works (e.g. gridApi or columnApi).

Module-Related API classes

caution

The Audit Event API class was removed in Version 9 in favour of the Adaptable State Changed Event

API ClassDetails
alertApiAdaptable Alerts provide bespoke notifications and messages
applicationApiUse Application Data Entries to manage custom state and data
bulkUpdateApiRun Bulk Update so mutliple selected cells are given same value
calculatedColumnApiManages Calculated Columns which contain custom expressions
cellSummaryApiChoose which Cell Summaries to display when cells are selected
conditionalStyleApiSet bespoke Conditional Styles for rows and columns depending on cell data
customSortApiManages Custom Sorts allowing bespoke column sorting
dashboardApiLarge series of functions allowing full customisation of AdapTable's Dashboard
dataSourceApiDeals with Data Sources used in Server Searching
exportApiExport reports either manually or at scheduled times
filterApiManages various Filters provided by AdapTable
freeTextColumnApiConfigures FreeText Columns - special columns containing bespoke data
layoutApiManages Layouts - sets of column order and visibility
queryApiFunctions relating to the saveable, cross-column Queries
quickSearchApiFunctions for running and clearing Quick Search
scheduleApiSupports Schedules for running Actions at set time
shortcutApiDeals with Shortcuts for faster & safer data entry
smartEditApiFunctions for managing the Smart Edit Module to enable better editing
systemStatusApiManages how the System Status Module will display run-time messages
themeApiDeals with Themes both AdapTable and Custom
toolPanelApiFunctions for working with the AdapTable ToolPanel Component

General API classes

API ClassDetails
columnApiLarge number of column-related functions
configApiSeries of functions managing Predefined Config and User State
eventApiSubscribe to some of the many Events that AdapTable fires
gridApiSeries of Grid-management related functions e.g. get/set data
predicateApiHelper functions for the Predicate - boolean return function
scopeApiMany methods to manage the Scope object
userInterfaceApiMany properties and methods to manage the User Interface

Plugin-related API classes

API ClassDetails
pluginsApiSeries of functions for when using Plugins
chartApiDeals with the Chart functionality (available through a plugin)
glue42ApiFunctions to faciliate using the Glue42 plugin
ipushpullApiFunctions to help export data from AdapTable to ipushull
openfinApiUsed in conjunction with the OpenFin plugin

More Information