AdaptableOptions
Large group of options enabling developers to set up AdapTable at design time to fit precise requirements
export interface AdaptableOptions<TData = any, TContext = Record<string,Properties
| Property | Description | Default |
|---|---|---|
| actionColumnOptions | Options for managing Action Columns | |
| adaptableContext | Application-specific context object - is included by AdapTable in all callbacks and Events | |
| adaptableId | Identifier for this instance of AdapTable | 'adaptable_id_$random_number' |
| adaptableStateKey | Identifier used as localStorage persistence key for AdaptableState | adaptableId value |
| alertOptions | Options for managing Alerts in AdapTable | |
| autogeneratePrimaryKey | Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities | false |
| calendarOptions | Options for managing Holidays and Working Days | |
| cellSummaryOptions | Options for adding custom Cell Summaries | |
| chartingOptions | Options for managing AG Grid's Charting | |
| columnMenuOptions | Options for managing AdapTable Column Menu | |
| columnOptions | Options related to Columns | |
| commentOptions | Options for managing collaborative Comments | |
| containerOptions | Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed | |
| contextMenuOptions | Options for managing AdapTable Context Menu | |
| customSortOptions | Options for using Custom Sort | |
| dashboardOptions | Options for managing the Dashboard in AdapTable | |
| dataChangeHistoryOptions | Options to manage Data Change History Module which provides an overview of all data changes | |
| dataImportOptions | Options for managing the Data Import function | |
| dataSetOptions | Options to manage Data Sets | |
| editOptions | Options related to Editing in AdapTable including Server Validation | |
| entitlementOptions | Options for managing Entitlements | |
| exportOptions | Options for managing Exporting and Reports in AdapTable | |
| expressionOptions | Options for managing AdapTableQL Expressions | |
| fdc3Options | Options for managing FDC3 in AdapTable | |
| filterOptions | Filtering Options - both Column Filters and the Grid Filter | |
| flashingCellOptions | Options for managing Flashing Cells - primarily default values | |
| formatColumnOptions | Options for providing Custom Display Formats | |
| initialState | Initial State set at design-time and shipped with AdapTable for first use; must include at least one Layout | undefined |
| layoutOptions | Options related to Layouts | |
| licenseKey | Commercial license key. If the license is not provided or is expired, various visual information notes will be displayed and some functionality may be limited. | |
| noteOptions | Options for managing personal Notes | |
| notificationsOptions | Options for managing Notifications in AdapTable | |
| plugins | Used for managing the AdapTable Plugins | |
| predicateOptions | Options for managing Predicates in AdapTableQL | |
| primaryKey | Name of Column in AdapTable guaranteed to contain unique values | n/a (Mandatory) |
| quickSearchOptions | Options for managing Search related functions in AdapTable | |
| rowFormOptions | Options for managing Row Forms | |
| settingsPanelOptions | Setting panel options | |
| stateOptions | Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage | |
| teamSharingOptions | Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues | |
| toolPanelOptions | Options related to managing the Tool Panel elements in AdapTable | |
| userInterfaceOptions | Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc. | |
| userName | Name of current AdapTable user | 'anonymous' |
Property Details
actionColumnOptions
Options for managing Action Columns
actionColumnOptions?: ActionColumnOptions<TData>;Property Value
ActionColumnOptions<TData>
adaptableContext
Application-specific context object - is included by AdapTable in all callbacks and Events
adaptableContext?: TContext;Property Value
TContext
adaptableId
Identifier for this instance of AdapTable
adaptableId?: string;Default Value
'adaptable_id_$random_number'
Property Value
string
adaptableStateKey
Identifier used as localStorage persistence key for AdaptableState
adaptableStateKey?: string;Default Value
adaptableId value
Property Value
string
alertOptions
Options for managing Alerts in AdapTable
alertOptions?: AlertOptions<TData>;Property Value
AlertOptions<TData>
autogeneratePrimaryKey
Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities
autogeneratePrimaryKey?: boolean;Default Value
false
Property Value
boolean
calendarOptions
Options for managing Holidays and Working Days
calendarOptions?: CalendarOptions;Property Value
cellSummaryOptions
Options for adding custom Cell Summaries
cellSummaryOptions?: CellSummaryOptions<TData>;Property Value
CellSummaryOptions<TData>
chartingOptions
Options for managing AG Grid's Charting
chartingOptions?: ChartingOptions;Property Value
columnMenuOptions
Options for managing AdapTable Column Menu
columnMenuOptions?: ColumnMenuOptions<TData>;Property Value
ColumnMenuOptions<TData>
columnOptions
Options related to Columns
columnOptions?: ColumnOptions;Property Value
commentOptions
Options for managing collaborative Comments
commentOptions?: CommentOptions<TData>;Property Value
CommentOptions<TData>
containerOptions
Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed
containerOptions?: ContainerOptions;Property Value
contextMenuOptions
Options for managing AdapTable Context Menu
contextMenuOptions?: ContextMenuOptions<TData>;Property Value
ContextMenuOptions<TData>
customSortOptions
Options for using Custom Sort
customSortOptions?: CustomSortOptions;Property Value
dashboardOptions
Options for managing the Dashboard in AdapTable
dashboardOptions?: DashboardOptions;Property Value
dataChangeHistoryOptions
Options to manage Data Change History Module which provides an overview of all data changes
dataChangeHistoryOptions?: DataChangeHistoryOptions<TData>;Property Value
DataChangeHistoryOptions<TData>
dataImportOptions
Options for managing the Data Import function
dataImportOptions?: DataImportOptions;Property Value
dataSetOptions
Options to manage Data Sets
dataSetOptions?: DataSetOptions<TData>;Property Value
DataSetOptions<TData>
editOptions
Options related to Editing in AdapTable including Server Validation
editOptions?: EditOptions<TData>;Property Value
EditOptions<TData>
entitlementOptions
Options for managing Entitlements
entitlementOptions?: EntitlementOptions;Property Value
exportOptions
Options for managing Exporting and Reports in AdapTable
exportOptions?: ExportOptions<TData>;Property Value
ExportOptions<TData>
expressionOptions
Options for managing AdapTableQL Expressions
expressionOptions?: ExpressionOptions<TData>;Property Value
ExpressionOptions<TData>
fdc3Options
Options for managing FDC3 in AdapTable
fdc3Options?: Fdc3Options;Property Value
filterOptions
Filtering Options - both Column Filters and the Grid Filter
filterOptions?: FilterOptions<TData>;Property Value
FilterOptions<TData>
flashingCellOptions
Options for managing Flashing Cells - primarily default values
flashingCellOptions?: FlashingCellOptions;Property Value
formatColumnOptions
Options for providing Custom Display Formats
formatColumnOptions?: FormatColumnOptions;Property Value
initialState
Initial State set at design-time and shipped with AdapTable for first use; must include at least one Layout
initialState: InitialState;Default Value
undefined
Property Value
layoutOptions
Options related to Layouts
layoutOptions?: LayoutOptions;Property Value
licenseKey
Commercial license key. If the license is not provided or is expired, various visual information notes will be displayed and some functionality may be limited.
licenseKey?: string;Property Value
string
noteOptions
Options for managing personal Notes
noteOptions?: NoteOptions;Property Value
notificationsOptions
Options for managing Notifications in AdapTable
notificationsOptions?: NotificationsOptions;Property Value
plugins
Used for managing the AdapTable Plugins
plugins?: AdaptablePlugin[];Property Value
predicateOptions
Options for managing Predicates in AdapTableQL
predicateOptions?: PredicateOptions;Property Value
primaryKey
Name of Column in AdapTable guaranteed to contain unique values
primaryKey: string;Default Value
n/a (Mandatory)
Property Value
string
quickSearchOptions
Options for managing Search related functions in AdapTable
quickSearchOptions?: QuickSearchOptions<TData>;Property Value
QuickSearchOptions<TData>
rowFormOptions
Options for managing Row Forms
rowFormOptions?: RowFormOptions<TData>;Property Value
RowFormOptions<TData>
settingsPanelOptions
Setting panel options
settingsPanelOptions?: SettingsPanelOptions;Property Value
stateOptions
Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage
stateOptions?: StateOptions;Property Value
teamSharingOptions
Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues
teamSharingOptions?: TeamSharingOptions;Property Value
toolPanelOptions
Options related to managing the Tool Panel elements in AdapTable
toolPanelOptions?: ToolPanelOptions;Property Value
userInterfaceOptions
Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.
userInterfaceOptions?: UserInterfaceOptions<TData>;Property Value
UserInterfaceOptions<TData>
userName
Name of current AdapTable user
userName?: string;Default Value
'anonymous'
Property Value
string