UserInterfaceOptions
Options for managing the User Interface of AdapTable
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| alternativeModuleNames | AlternativeModuleName[] | Alternative names to use for Adaptable Modules in the UI | null |
| applicationIcon | AdaptableIcon | The application icon to appear in Dashboard and elsewhere (e.g. in Notifications) | null |
| customIcons | CustomIcon[] | (() =>CustomIcon[]) | Bespoke icons that can be used in AdapTable (e.g. Badge Styles and Buttons) | |
| dateInputOptions | DateInputOptions | Options for managing and customizing date inputs in AdapTable | |
| disableDeleteConfirmation | boolean | Hides confirmation dialog which displays whenever an AdaptableObject is deleted | false |
| editableCellStyle | AdaptableStyle | Style to set for editable Cells | |
| editedCellStyle | AdaptableStyle | Style to set for Cells which have been edited | |
| englishVariant | 'GB' | 'US' | English variant to use in AdapTable UI | 'GB' |
| loadingScreenOptions | LoadingScreenOptions | Options for showing Loading Screen (during initialisation) | |
| objectTags | AdaptableObjectTag[] | ((context:ObjectTagsContext) =>AdaptableObjectTag[]) | Optional list of AdaptableObjectTags that can be associated with AdaptableObjects | |
| readOnlyCellStyle | AdaptableStyle | Style to set for non-editable Cells | |
| showAdapTableVersion | boolean | Displays the AdapTable version in Grid Info section of Settings Panel | true |
| showAgGridVersion | boolean | Displays the AG Grid version in Grid Info section of Settings Panel | true |
| showDocumentationLinks | boolean | Provide links to AdapTable documentation (in Module popups and Expression Editor) | true |
| styleClassNames | string[] | Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Format Column and other Modules) | [] |
| useCustomMacLikeScrollbars | boolean | Show Mac-like scrollbars; size is configurable via CSS variable --ab-custom-scrollbar-size (default: 10px) | false |
Property Details
alternativeModuleNames
Alternative names to use for Adaptable Modules in the UI
alternativeModuleNames?: AlternativeModuleName[];Default Value
null
Property Value
applicationIcon
The application icon to appear in Dashboard and elsewhere (e.g. in Notifications)
applicationIcon?: AdaptableIcon;Default Value
null
Property Value
colorPalette
colorPalette?: string[] | ((currentTheme: string) => string[]);Deprecated
Override --ab-color-swatch-*, --ab-color-palette-*, and semantic --ab-color-* variables in light/dark theme instead; will be removed in future release
Property Value
string[] | ((currentTheme: string) => string[])
customIcons
Bespoke icons that can be used in AdapTable (e.g. Badge Styles and Buttons)
customIcons?: CustomIcon[] | (() => CustomIcon[]);Property Value
CustomIcon[] | (() =>CustomIcon[])
dateInputOptions
Options for managing and customizing date inputs in AdapTable
dateInputOptions?: DateInputOptions;Property Value
disableDeleteConfirmation
Hides confirmation dialog which displays whenever an AdaptableObject is deleted
disableDeleteConfirmation?: boolean;Default Value
false
Property Value
boolean
editableCellStyle
Style to set for editable Cells
editableCellStyle?: AdaptableStyle;Property Value
editedCellStyle
Style to set for Cells which have been edited
editedCellStyle?: AdaptableStyle;Property Value
englishVariant
English variant to use in AdapTable UI
englishVariant?: 'GB' | 'US';Default Value
'GB'
Property Value
'GB' | 'US'
loadingScreenOptions
Options for showing Loading Screen (during initialisation)
loadingScreenOptions?: LoadingScreenOptions;Property Value
objectTags
Optional list of AdaptableObjectTags that can be associated with AdaptableObjects
objectTags?: AdaptableObjectTag[] | ((context: ObjectTagsContext) => AdaptableObjectTag[]);Property Value
AdaptableObjectTag[] | ((context:ObjectTagsContext) =>AdaptableObjectTag[])
readOnlyCellStyle
Style to set for non-editable Cells
readOnlyCellStyle?: AdaptableStyle;Property Value
showAdapTableVersion
Displays the AdapTable version in Grid Info section of Settings Panel
showAdapTableVersion?: boolean;Default Value
true
Property Value
boolean
showAgGridVersion
Displays the AG Grid version in Grid Info section of Settings Panel
showAgGridVersion?: boolean;Default Value
true
Property Value
boolean
showDocumentationLinks
Provide links to AdapTable documentation (in Module popups and Expression Editor)
showDocumentationLinks?: boolean;Default Value
true
Property Value
boolean
styleClassNames
Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Format Column and other Modules)
styleClassNames?: string[];Default Value
[]
Property Value
string[]
useCustomMacLikeScrollbars
Show Mac-like scrollbars; size is configurable via CSS variable --ab-custom-scrollbar-size (default: 10px)
useCustomMacLikeScrollbars?: boolean;Default Value
false
Property Value
boolean