AdaptableApi
The main Adaptable API.
You can get a reference to this either via useAdaptableApi hook or via the onReady callback prop.
TypeScript
declare classProperties
| Property | Description |
|---|---|
| adaptableQLApi | An API for managing and executing AdaptableQL queries |
| alertApi | API for managing alerts |
| calculatedColumnApi | |
| cellSummaryApi | |
| columnApi | |
| configApi | |
| customSortApi | |
| dashboardApi | API for managing the dashboard |
| dataSourceApi | API for managing the data source |
| exportApi | |
| filterApi | |
| flashingCellsApi | |
| getInfiniteDataSourceApi | See https://infinite-table.com/docs/reference/datasource-api for details |
| getInfiniteTableApi | See https://infinite-table.com/docs/reference/api for details |
| gridApi | |
| loggerApi | |
| notificationApi | |
| quickSearchApi | |
| settingsPanelApi | |
| stateApi | |
| styledCellsApi | |
| themeApi | API for changing the theme |
| viewApi | API for managing views - creating, switching the current view, editing, etc. |
Methods
| Method |
|---|
| destroy() |
| getAdaptableId() |
Property Details
adaptableQLApi
An API for managing and executing AdaptableQL queries
TypeScript
adaptableQLApi: AdaptableQLApi;Property Value
AdaptableQLApi
alertApi
API for managing alerts
TypeScript
alertApi: AlertApi;Property Value
calculatedColumnApi
TypeScript
calculatedColumnApi: CalculatedColumnApi;Property Value
CalculatedColumnApi
cellSummaryApi
TypeScript
cellSummaryApi: CellSummaryApi;Property Value
CellSummaryApi
columnApi
TypeScript
columnApi: ColumnApi;Property Value
ColumnApi
configApi
TypeScript
configApi: ConfigApi;Property Value
customSortApi
TypeScript
customSortApi: CustomSortApi;Property Value
dashboardApi
API for managing the dashboard
TypeScript
dashboardApi: DashboardApi;Property Value
dataSourceApi
API for managing the data source
TypeScript
dataSourceApi: AdaptableDataSourceApi;Property Value
exportApi
TypeScript
exportApi: ExportApi;Property Value
filterApi
TypeScript
filterApi: FilterApi;Property Value
FilterApi
flashingCellsApi
TypeScript
flashingCellsApi: FlashingCellsApi;Property Value
getInfiniteDataSourceApi
See https://infinite-table.com/docs/reference/datasource-api for details
TypeScript
getInfiniteDataSourceApi: () => _infinite_table_infinite_react.DataSourceApi<unknown>;Property Value
() => _infinite_table_infinite_react.DataSourceApi<unknown>
getInfiniteTableApi
See https://infinite-table.com/docs/reference/api for details
TypeScript
getInfiniteTableApi: () => _infinite_table_infinite_react.InfiniteTableApi<unknown>;Property Value
() => _infinite_table_infinite_react.InfiniteTableApi<unknown>
gridApi
TypeScript
gridApi: GridApi;Property Value
loggerApi
TypeScript
loggerApi: AdaptableLoggerApi;Property Value
AdaptableLoggerApi
notificationApi
TypeScript
notificationApi: NotificationsApi;Property Value
NotificationsApi
quickSearchApi
TypeScript
quickSearchApi: QuickSearchApi;Property Value
settingsPanelApi
TypeScript
settingsPanelApi: SettingsPopupApi;Property Value
SettingsPopupApi
stateApi
TypeScript
stateApi: StateApi;Property Value
StateApi
styledCellsApi
TypeScript
styledCellsApi: StyledCellApi;Property Value
themeApi
API for changing the theme
TypeScript
themeApi: ThemeApi;Property Value
viewApi
API for managing views - creating, switching the current view, editing, etc.
TypeScript
viewApi: ViewApi;Property Value
Method Details
destroy
TypeScript
destroy(): void;Returns
void
getAdaptableId
TypeScript
getAdaptableId(): string;Returns
string