AdaptableApi provides developers with run-time access to AdapTable.
It offers ALL the functionality provided by the AdapTable UI through code.
This enables developers to access the AdapTable Store, and all AdapTable functionality, at run-time in a 'safe' way.
It also allows them to bypass the UI screens altogether if they so wish.
The AdaptableAPI is essentially just a wrapper around the AdapTable Store but provides additional error-checking, logging, and auditing. And it also ensures that the immutable "purity" of the store is maintained.
Note to AdapTable users: If there is a method missing from
AdaptableApi that you would like implemented, please contact
email@example.com and we will add it
The AdaptableApi 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.
AdaptableApi consists of over 40 sets of properties.
Each of these properties is a class that contains a set of Api methods grouped either by AdapTable Function (e.g.
AdvancedSearchAPI) or type (e.g.
The full list is:
|actionColumnApi||Manages Action Columns which contain buttons with bespoke click logic|
|advancedSearchApi||Functions relating to the saveable, cross-column Advanced Searches|
|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 expresssions|
|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|
|chartApi||Deals with the Chart functionality (available through a plugin)|
|columnCategoryApi||Manages putting columns into Column Categories for when dealing with many columns|
Provides access to the Action Column functionality, the ActionColumn object.
Provides access to the Advanced Search function, the AdvancedSearch object and Advanced Search State.
Provides access to the Alert function (enabling the displaying of Alerts) and Alerrt State.
Enables use of the Application Function which lets developers render their own toolbar and screen (if required).
Publishes the 3 Audit Events - onAuditStateChanged, onAuditCellEdited and onAuditFunctionApplied
These Events are fired through Audit Log when the auditAsEvent property for any of these properties is set to true.
Provides access to the Bulk Update function and Bulk Update State.
Provides access to the Calculated Column function (enabling the creation of Calculated Columns) and Calculated Column State.
Provides access to the Calendar function and Calendar State.
Provides access to the Cell Summary function and Cell Summary State.
Provides access to the Cell Validation function, the CellValidation object and Cell Validation State.
Provides access to the Chart function, the various Chart Definition objects and Chart State.
Provides access to the Column Category function, the Column Category object and Column Category State.
Provides access to the Column Chooser function.
Provides access to the Column Filter function, the Column Filter object and Column Filter State.
Provides access to the Conditional Style function, the Conditional Style object and Conditional Style State.
Methods that give access to the Predefined Config, State and Store.
Provides access to the Custom Sort function, the Custom Sort object and Custom Sort State.
Provides access to the Dashboard function, and Dashboard State.
Provides access to the Data Source function, the Data Source object and Data Source State.
Provides methods to manager User Entitlements (or Permissions)
The Api used for listenning / subscribing to the various Events fired / published by AdapTable e.g. the SearchChanged event.
Provides access to the Export function, the Report object and Export State.
Provides access to the Flashing Cell function, the Flashing Cell object and Flashing Cell State.
Provides access to the Format Column function, the Format Column object and Format Column State.
Provides access to the FreeText Column function, the FreeText Column object and FreeText Column State.
Provides access to Glue42 related functionality, the Glue42 object and Glue42 State.
Provides access to the Gradient Column function, the Gradient Column object and Gradient Column State.
Provides methods for managing the Grid directly e.g. setGridData which will replace the current DataSource with the one provided.
Provides access to ipushpull related functionality, the ipushpull object and ipushpull State.
API methods used internally within AdapTable.
This api class is not intended for developers to use and it is not recommended to use this section if accessing AdapTable at runtime through code
Provides access to the Named Filter function, the
NamedFilter object and NamedFilter State.
Provides access to the Percent Bar function, the Percent Bar object and Percent Bar State.
Provides access to the Plugins functionality of AdapTable - currently Charting and Finance, but with more to come in due course.
Provides access to the Plus Minus function, the Plus Minus object and Plus Minus State.
Provides access to the Quick Search function, the Quick Search object and Quick Search State.
Provides access to the Reminder function, the Reminder object and Reminder State.
Provides access to the Schedule function which allows you to create schedules for Reminders, Reports and ipushpull.
Provides access to the Shortcut function, the Shortcut object and Shortcut State.
Provides access to the Sparkline Column functionality
Only used if the Charts Plugin has been enabled.
Provides access to System Filter State that manages the Filters that AdapTable ships with.
Api methods related to the System Status function which displays information about the health of the application.
Api methods related to Theme management and Theme State.
Provides access to the ToolPanel function, and ToolPanel State.
Provides access to the Updated Row function and Updated Row State.
Provides access to the User Filter function, the User Filter object and User Filter State.
Provides access to User Interface State which allows you to set up colours, permitted values etc.
Generated using TypeDoc