AdaptableApi
Provides developers with run-time access to AdapTable. Contains many classes each dedicated to a specific AdapTable Module or functionality
export interfaceProperties
| Property | Type | Description |
|---|---|---|
| actionColumnApi | ActionColumnApi | Provides access to Action Columns |
| agGridApi | AgGridApi | AG Grid API; try to use the API methods provided by Adaptable instead of using this directly |
| alertApi | AlertApi | Provides access to the Alert Module |
| applicationApi | ApplicationApi | Provides access to the Application Module |
| bulkUpdateApi | BulkUpdateApi | Provides access to the Bulk Update Module |
| calculatedColumnApi | CalculatedColumnApi | Provides access to the Calculated Column Module |
| calendarApi | CalendarApi | Functions for managing Holidays |
| cellSummaryApi | CellSummaryApi | Provides access to the Cell Summary Module |
| chartingApi | ChartingApi | Provides run-time access to Charting Module and state |
| columnApi | ColumnApi | Provides a number of column-related methods |
| columnMenuApi | ColumnMenuApi | Provides access to Column Menu |
| columnScopeApi | ColumnScopeApi | Manages the Scope object - used widely to determine where objects are applied |
| commentApi | CommentApi | Provides access to the Comment Module |
| contextMenuApi | ContextMenuApi | Provides access to Context Menu |
| customSortApi | CustomSortApi | Provides access to the Custom Sort Module |
| dashboardApi | DashboardApi | Provides access to the Dashboard |
| dataChangeHistoryApi | DataChangeHistoryApi | Provides run-time access to the Data Changes Module |
| dataImportApi | DataImportApi | Provides access to the Data Import Module |
| dataSetApi | DataSetApi | Provides access to Data Sets |
| destroy | (config?:DestroyConfig) => void | Cleanup method - call only for vanilla JavaScript components, as framework components handle cleanup on destroy/unmount. By default, it unmounts the Adaptable component and destroys the AG Grid instance. |
| entitlementApi | EntitlementApi | Functions for managing Entitlements and Permissions |
| eventApi | EventApi | Used for listening / subscribing to the Events published by AdapTable |
| exportApi | ExportApi | Provides access to the Export Module and Reports |
| expressionApi | ExpressionApi | Manages AdapTableQL Expressions |
| fdc3Api | Fdc3Api | Manages the FDC3 capabilities of AdapTable |
| filterApi | FilterApi | Provides access to Filtering in AdapTable |
| flashingCellApi | FlashingCellApi | Provides access to the Flashing Cell Module |
| formatColumnApi | FormatColumnApi | Provides access to the Format Column Module |
| freeTextColumnApi | FreeTextColumnApi | Provides access to the FreeText Column Module |
| gridApi | GridApi | Provides methods for managing the Grid, and Grid data, directly |
| isDestroyed | () => boolean | Whether the Adaptable instance has been destroyed |
| layoutApi | LayoutApi | Provides access to the Layout Module |
| namedQueryApi | NamedQueryApi | Provides access to the Named Query Module |
| noteApi | NoteApi | Provides access to the Note Module |
| optionsApi | OptionsApi | Provides access to Adaptable Options |
| pluginsApi | PluginsApi | Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc) |
| plusMinusApi | PlusMinusApi | Provides access to the Plus Minus Module |
| predicateApi | PredicateApi | Manages the Predicate - a boolean-return function used in Filters and Alerts |
| quickSearchApi | QuickSearchApi | Provides access to the Quick Search Module |
| rowFormApi | RowFormApi | Creates Row Forms |
| settingsPanelApi | SettingsPanelApi | Provides access to the Settings Panel |
| shortcutApi | ShortcutApi | Provides access to the Shortcut Module |
| smartEditApi | SmartEditApi | Provides access to the Smart Edit Module |
| stateApi | StateApi | Methods giving access to Adaptable State |
| statusBarApi | StatusBarApi | Provides run-time access to the AdapTable Status Bar |
| styledColumnApi | StyledColumnApi | Provides access to the Styled Column Module |
| systemStatusApi | SystemStatusApi | Methods related to displaying System Status and application health messages |
| teamSharingApi | TeamSharingApi | Functions related to run-time Team Sharing of AdapTable objects between colleagues |
| themeApi | ThemeApi | Api methods related to Theme management |
| toolPanelApi | ToolPanelApi | Provides access to the AdapTable Tool Panel on the right hand side of the grid |
| userInterfaceApi | UserInterfaceApi | Manages User Interface Options where colours, styles and custom column values are configured |
Property Details
actionColumnApi
Provides access to Action Columns
actionColumnApi: ActionColumnApi;Property Value
agGridApi
AG Grid API; try to use the API methods provided by Adaptable instead of using this directly
agGridApi: AgGridApi;Property Value
AgGridApi
alertApi
Provides access to the Alert Module
alertApi: AlertApi;Property Value
applicationApi
Provides access to the Application Module
applicationApi: ApplicationApi;Property Value
bulkUpdateApi
Provides access to the Bulk Update Module
bulkUpdateApi: BulkUpdateApi;Property Value
calculatedColumnApi
Provides access to the Calculated Column Module
calculatedColumnApi: CalculatedColumnApi;Property Value
calendarApi
Functions for managing Holidays
calendarApi: CalendarApi;Property Value
cellSummaryApi
Provides access to the Cell Summary Module
cellSummaryApi: CellSummaryApi;Property Value
chartingApi
Provides run-time access to Charting Module and state
chartingApi: ChartingApi;Property Value
columnApi
Provides a number of column-related methods
columnApi: ColumnApi;Property Value
columnMenuApi
Provides access to Column Menu
columnMenuApi: ColumnMenuApi;Property Value
columnScopeApi
Manages the Scope object - used widely to determine where objects are applied
columnScopeApi: ColumnScopeApi;Property Value
commentApi
Provides access to the Comment Module
commentApi: CommentApi;Property Value
contextMenuApi
Provides access to Context Menu
contextMenuApi: ContextMenuApi;Property Value
customSortApi
Provides access to the Custom Sort Module
customSortApi: CustomSortApi;Property Value
dashboardApi
Provides access to the Dashboard
dashboardApi: DashboardApi;Property Value
dataChangeHistoryApi
Provides run-time access to the Data Changes Module
dataChangeHistoryApi: DataChangeHistoryApi;Property Value
dataImportApi
Provides access to the Data Import Module
dataImportApi: DataImportApi;Property Value
dataSetApi
Provides access to Data Sets
dataSetApi: DataSetApi;Property Value
destroy
Cleanup method - call only for vanilla JavaScript components, as framework components handle cleanup on destroy/unmount. By default, it unmounts the Adaptable component and destroys the AG Grid instance.
destroy: (config?: DestroyConfig) => void;Property Value
(config?:DestroyConfig) => void
entitlementApi
Functions for managing Entitlements and Permissions
entitlementApi: EntitlementApi;Property Value
eventApi
Used for listening / subscribing to the Events published by AdapTable
eventApi: EventApi;Property Value
exportApi
Provides access to the Export Module and Reports
exportApi: ExportApi;Property Value
expressionApi
Manages AdapTableQL Expressions
expressionApi: ExpressionApi;Property Value
fdc3Api
Manages the FDC3 capabilities of AdapTable
fdc3Api: Fdc3Api;Property Value
filterApi
Provides access to Filtering in AdapTable
filterApi: FilterApi;Property Value
flashingCellApi
Provides access to the Flashing Cell Module
flashingCellApi: FlashingCellApi;Property Value
formatColumnApi
Provides access to the Format Column Module
formatColumnApi: FormatColumnApi;Property Value
freeTextColumnApi
Provides access to the FreeText Column Module
freeTextColumnApi: FreeTextColumnApi;Property Value
gridApi
Provides methods for managing the Grid, and Grid data, directly
gridApi: GridApi;Property Value
isDestroyed
Whether the Adaptable instance has been destroyed
isDestroyed: () => boolean;Property Value
() => boolean
layoutApi
Provides access to the Layout Module
layoutApi: LayoutApi;Property Value
namedQueryApi
Provides access to the Named Query Module
namedQueryApi: NamedQueryApi;Property Value
noteApi
Provides access to the Note Module
noteApi: NoteApi;Property Value
optionsApi
Provides access to Adaptable Options
optionsApi: OptionsApi;Property Value
pluginsApi
Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc)
pluginsApi: PluginsApi;Property Value
plusMinusApi
Provides access to the Plus Minus Module
plusMinusApi: PlusMinusApi;Property Value
predicateApi
Manages the Predicate - a boolean-return function used in Filters and Alerts
predicateApi: PredicateApi;Property Value
quickSearchApi
Provides access to the Quick Search Module
quickSearchApi: QuickSearchApi;Property Value
rowFormApi
Creates Row Forms
rowFormApi: RowFormApi;Property Value
settingsPanelApi
Provides access to the Settings Panel
settingsPanelApi: SettingsPanelApi;Property Value
shortcutApi
Provides access to the Shortcut Module
shortcutApi: ShortcutApi;Property Value
smartEditApi
Provides access to the Smart Edit Module
smartEditApi: SmartEditApi;Property Value
stateApi
Methods giving access to Adaptable State
stateApi: StateApi;Property Value
statusBarApi
Provides run-time access to the AdapTable Status Bar
statusBarApi: StatusBarApi;Property Value
styledColumnApi
Provides access to the Styled Column Module
styledColumnApi: StyledColumnApi;Property Value
systemStatusApi
Methods related to displaying System Status and application health messages
systemStatusApi: SystemStatusApi;Property Value
teamSharingApi
Functions related to run-time Team Sharing of AdapTable objects between colleagues
teamSharingApi: TeamSharingApi;Property Value
themeApi
Api methods related to Theme management
themeApi: ThemeApi;Property Value
toolPanelApi
Provides access to the AdapTable Tool Panel on the right hand side of the grid
toolPanelApi: ToolPanelApi;Property Value
userInterfaceApi
Manages User Interface Options where colours, styles and custom column values are configured
userInterfaceApi: UserInterfaceApi;