OptionsApi
Range of functions to access Adaptable Options
export interfaceMethods
| Method | Returns | Description |
|---|---|---|
| addToAdaptableContext(key, value) | void | Adds a key-value pair to the AdaptableContext |
| clearAdaptableContext() | void | Clears all key-value pairs from the AdaptableContext |
| getActionColumnOptions() | Readonly<ActionColumnOptions> | Returns AdaptableOptions.actionColumnOptions |
| getAdaptableContext() | TContext | Returns AdaptableOptions.adaptableContext |
| getAdaptableId() | string | Returns AdaptableOptions.adaptableId |
| getAdaptableOptions() | Readonly<AdaptableOptions> | Returns provided AdaptableOptions |
| getAdaptableStateKey() | string | Returns AdaptableOptions.adaptableStateKey |
| getAlertOptions() | Readonly<AlertOptions> | Returns AdaptableOptions.alertOptions |
| getCalendarOptions() | Readonly<CalendarOptions> | Returns AdaptableOptions.calendarOptions |
| getCellSummaryOptions() | Readonly<CellSummaryOptions> | Returns AdaptableOptions.cellSummaryOptions |
| getChartingOptions() | Readonly<ChartingOptions> | Returns AdaptableOptions.chartingOptions |
| getColumnMenuOptions() | Readonly<ColumnMenuOptions> | Returns AdaptableOptions.columnMenuOptions |
| getColumnOptions() | Readonly<ColumnOptions> | Returns AdaptableOptions.columnOptions |
| getCommentOptions() | Readonly<CommentOptions> | Returns AdaptableOptions.commentOptions |
| getContainerOptions() | Readonly<ContainerOptions> | Returns AdaptableOptions.containerOptions |
| getContextMenuOptions() | Readonly<ContextMenuOptions> | Returns AdaptableOptions.contextMenuOptions |
| getCustomSortOptions() | Readonly<CustomSortOptions> | Returns AdaptableOptions.customSortOptions |
| getDashboardOptions() | Readonly<DashboardOptions> | Returns AdaptableOptions.dashboardOptions |
| getDataChangeHistoryOptions() | Readonly<DataChangeHistoryOptions> | Returns AdaptableOptions.dataChangeHistoryOptions |
| getDataImportOptions() | Readonly<DataImportOptions> | Returns AdaptableOptions.dataImportOptions |
| getDataSetOptions() | Readonly<DataSetOptions> | Returns AdaptableOptions.dataSetOptions |
| getEditOptions() | Readonly<EditOptions> | Returns AdaptableOptions.editOptions |
| getEntitlementOptions() | Readonly<EntitlementOptions> | Returns AdaptableOptions.entitlementOptions |
| getExportOptions() | Readonly<ExportOptions> | Returns AdaptableOptions.exportOptions |
| getExpressionOptions() | Readonly<ExpressionOptions> | Returns AdaptableOptions.expressionOptions |
| getFdc3Options() | Readonly<Fdc3Options> | Returns AdaptableOptions.fdc3Options |
| getFilterOptions() | Readonly<FilterOptions> | Returns AdaptableOptions.filterOptions |
| getFlashingCellOptions() | Readonly<FlashingCellOptions> | Returns AdaptableOptions.flashingCellOptions |
| getFormatColumnOptions() | Readonly<FormatColumnOptions> | Returns AdaptableOptions.formatColumnOptions |
| getLayoutOptions() | Readonly<LayoutOptions> | Returns AdaptableOptions.layoutOptions |
| getLicenseKey() | string | Returns AdaptableOptions.licenseKey |
| getNoteOptions() | Readonly<NoteOptions> | Returns AdaptableOptions.noteOptions |
| getNotificationsOptions() | Readonly<NotificationsOptions> | Returns AdaptableOptions.notificationsOptions |
| getPredicateOptions() | Readonly<PredicateOptions> | Returns AdaptableOptions.predicateOptions |
| getPrimaryKey() | string | Returns AdaptableOptions.primaryKey |
| getQuickSearchOptions() | Readonly<QuickSearchOptions> | Returns AdaptableOptions.quickSearchOptions |
| getRowFormOptions() | Readonly<RowFormOptions> | Returns AdaptableOptions.rowFormOptions |
| getSettingsPanelOptions() | Readonly<SettingsPanelOptions> | Returns AdaptableOptions.settingsPanelOptions |
| getStateOptions() | Readonly<StateOptions> | Returns AdaptableOptions.stateOptions |
| getTeamSharingOptions() | Readonly<TeamSharingOptions> | Returns AdaptableOptions.teamSharingOptions |
| getToolPanelOptions() | Readonly<ToolPanelOptions> | Returns AdaptableOptions.toolPanelOptions |
| getUserInterfaceOptions() | Readonly<UserInterfaceOptions> | Returns AdaptableOptions.userInterfaceOptions |
| getUserName() | string | Returns AdaptableOptions.userName |
| isAutogeneratePrimaryKey() | boolean | Returns AdaptableOptions.autogeneratePrimaryKey |
| removeFromAdaptableContext(key) | void | Removes a key from the AdaptableContext |
Method Details
addToAdaptableContext
Adds a key-value pair to the AdaptableContext
addToAdaptableContext<TContext = Record<string, any>>(key: keyof TContext, value: TContext[keyof TContext]): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| key | keyof TContext | The key to add |
| value | TContext[keyof TContext] | The value to add |
Returns
void
clearAdaptableContext
Clears all key-value pairs from the AdaptableContext
clearAdaptableContext(): void;Returns
void
getActionColumnOptions
Returns AdaptableOptions.actionColumnOptions
getActionColumnOptions(): Readonly<ActionColumnOptions>;Returns
Readonly<ActionColumnOptions>
getAdaptableContext
Returns AdaptableOptions.adaptableContext
getAdaptableContext<TContext = Record<string, any>>(): TContext;Returns
TContext
getAdaptableId
Returns AdaptableOptions.adaptableId
getAdaptableId(): string;Returns
string
getAdaptableOptions
Returns provided AdaptableOptions
getAdaptableOptions(): Readonly<AdaptableOptions>;Returns
Readonly<AdaptableOptions>
getAdaptableStateKey
Returns AdaptableOptions.adaptableStateKey
getAdaptableStateKey(): string;Returns
string
getAlertOptions
Returns AdaptableOptions.alertOptions
getAlertOptions(): Readonly<AlertOptions>;Returns
Readonly<AlertOptions>
getCalendarOptions
Returns AdaptableOptions.calendarOptions
getCalendarOptions(): Readonly<CalendarOptions>;Returns
Readonly<CalendarOptions>
getCellSummaryOptions
Returns AdaptableOptions.cellSummaryOptions
getCellSummaryOptions(): Readonly<CellSummaryOptions>;Returns
Readonly<CellSummaryOptions>
getChartingOptions
Returns AdaptableOptions.chartingOptions
getChartingOptions(): Readonly<ChartingOptions>;Returns
Readonly<ChartingOptions>
getColumnMenuOptions
Returns AdaptableOptions.columnMenuOptions
getColumnMenuOptions(): Readonly<ColumnMenuOptions>;Returns
Readonly<ColumnMenuOptions>
getColumnOptions
Returns AdaptableOptions.columnOptions
getColumnOptions(): Readonly<ColumnOptions>;Returns
Readonly<ColumnOptions>
getCommentOptions
Returns AdaptableOptions.commentOptions
getCommentOptions(): Readonly<CommentOptions>;Returns
Readonly<CommentOptions>
getContainerOptions
Returns AdaptableOptions.containerOptions
getContainerOptions(): Readonly<ContainerOptions>;Returns
Readonly<ContainerOptions>
getContextMenuOptions
Returns AdaptableOptions.contextMenuOptions
getContextMenuOptions(): Readonly<ContextMenuOptions>;Returns
Readonly<ContextMenuOptions>
getCustomSortOptions
Returns AdaptableOptions.customSortOptions
getCustomSortOptions(): Readonly<CustomSortOptions>;Returns
Readonly<CustomSortOptions>
getDashboardOptions
Returns AdaptableOptions.dashboardOptions
getDashboardOptions(): Readonly<DashboardOptions>;Returns
Readonly<DashboardOptions>
getDataChangeHistoryOptions
Returns AdaptableOptions.dataChangeHistoryOptions
getDataChangeHistoryOptions(): Readonly<DataChangeHistoryOptions>;Returns
Readonly<DataChangeHistoryOptions>
getDataImportOptions
Returns AdaptableOptions.dataImportOptions
getDataImportOptions(): Readonly<DataImportOptions>;Returns
Readonly<DataImportOptions>
getDataSetOptions
Returns AdaptableOptions.dataSetOptions
getDataSetOptions(): Readonly<DataSetOptions>;Returns
Readonly<DataSetOptions>
getEditOptions
Returns AdaptableOptions.editOptions
getEditOptions(): Readonly<EditOptions>;Returns
Readonly<EditOptions>
getEntitlementOptions
Returns AdaptableOptions.entitlementOptions
getEntitlementOptions(): Readonly<EntitlementOptions>;Returns
Readonly<EntitlementOptions>
getExportOptions
Returns AdaptableOptions.exportOptions
getExportOptions(): Readonly<ExportOptions>;Returns
Readonly<ExportOptions>
getExpressionOptions
Returns AdaptableOptions.expressionOptions
getExpressionOptions(): Readonly<ExpressionOptions>;Returns
Readonly<ExpressionOptions>
getFdc3Options
Returns AdaptableOptions.fdc3Options
getFdc3Options(): Readonly<Fdc3Options>;Returns
Readonly<Fdc3Options>
getFilterOptions
Returns AdaptableOptions.filterOptions
getFilterOptions(): Readonly<FilterOptions>;Returns
Readonly<FilterOptions>
getFlashingCellOptions
Returns AdaptableOptions.flashingCellOptions
getFlashingCellOptions(): Readonly<FlashingCellOptions>;Returns
Readonly<FlashingCellOptions>
getFormatColumnOptions
Returns AdaptableOptions.formatColumnOptions
getFormatColumnOptions(): Readonly<FormatColumnOptions>;Returns
Readonly<FormatColumnOptions>
getLayoutOptions
Returns AdaptableOptions.layoutOptions
getLayoutOptions(): Readonly<LayoutOptions>;Returns
Readonly<LayoutOptions>
getLicenseKey
Returns AdaptableOptions.licenseKey
getLicenseKey(): string;Returns
string
getNoteOptions
Returns AdaptableOptions.noteOptions
getNoteOptions(): Readonly<NoteOptions>;Returns
Readonly<NoteOptions>
getNotificationsOptions
Returns AdaptableOptions.notificationsOptions
getNotificationsOptions(): Readonly<NotificationsOptions>;Returns
Readonly<NotificationsOptions>
getPredicateOptions
Returns AdaptableOptions.predicateOptions
getPredicateOptions(): Readonly<PredicateOptions>;Returns
Readonly<PredicateOptions>
getPrimaryKey
Returns AdaptableOptions.primaryKey
getPrimaryKey(): string;Returns
string
getQuickSearchOptions
Returns AdaptableOptions.quickSearchOptions
getQuickSearchOptions(): Readonly<QuickSearchOptions>;Returns
Readonly<QuickSearchOptions>
getRowFormOptions
Returns AdaptableOptions.rowFormOptions
getRowFormOptions(): Readonly<RowFormOptions>;Returns
Readonly<RowFormOptions>
getSettingsPanelOptions
Returns AdaptableOptions.settingsPanelOptions
getSettingsPanelOptions(): Readonly<SettingsPanelOptions>;Returns
Readonly<SettingsPanelOptions>
getStateOptions
Returns AdaptableOptions.stateOptions
getStateOptions(): Readonly<StateOptions>;Returns
Readonly<StateOptions>
getTeamSharingOptions
Returns AdaptableOptions.teamSharingOptions
getTeamSharingOptions(): Readonly<TeamSharingOptions>;Returns
Readonly<TeamSharingOptions>
getToolPanelOptions
Returns AdaptableOptions.toolPanelOptions
getToolPanelOptions(): Readonly<ToolPanelOptions>;Returns
Readonly<ToolPanelOptions>
getUserInterfaceOptions
Returns AdaptableOptions.userInterfaceOptions
getUserInterfaceOptions(): Readonly<UserInterfaceOptions>;Returns
Readonly<UserInterfaceOptions>
getUserName
Returns AdaptableOptions.userName
getUserName(): string;Returns
string
isAutogeneratePrimaryKey
Returns AdaptableOptions.autogeneratePrimaryKey
isAutogeneratePrimaryKey(): boolean;Returns
boolean
removeFromAdaptableContext
Removes a key from the AdaptableContext
removeFromAdaptableContext<TContext = Record<string, any>>(key: keyof TContext): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| key | keyof TContext | The key to remove |
Returns
void