User Interface Technical Reference
User Interface State
UserInterfaceState
User Interface section of Adaptable State, including Initial State.
HideAdaptableUI hides the Dashboard, Tool Panel, Status Bar, and the column and context menus. The default is false.
boolean
Hides all AdapTable UI elements (i.e. Dashboard, Tool Panel, Status Bar, Column & Context Menus etc.)
false
User Interface Options
UserInterfaceOptions
Options for managing the User Interface of AdapTable
Alternative icons to use for Adaptable Modules in the UI (Settings Panel,
Dashboard / Tool Panel buttons, Status Bar, menus, etc.)
null
Alternative names to use for Adaptable Modules in the UI
null
The application icon to appear in Dashboard and elsewhere (e.g. in Notifications)
null
Options for the Colour Picker, including which colours to display
CustomIcon[] | (() =>CustomIcon[])
Bespoke icons that can be used in AdapTable (e.g. Badge Styles and Buttons)
Options for managing and customizing date inputs in AdapTable
boolean
Hides confirmation dialog which displays whenever an AdaptableObject is deleted
false
Style to set for editable Cells
Style to set for Cells which have been edited
Options for showing Loading Screen (during initialisation)
Style to set for non-editable Cells
boolean
Displays the AdapTable version in Grid Info section of Settings Panel
true
boolean
Displays the AG Grid version in Grid Info section of Settings Panel
true
boolean
Provide links to AdapTable documentation (in Module popups and Expression Editor)
true
string[]
Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Format Column and other Modules)
[]
boolean
Show Mac-like scrollbars; size is configurable via CSS variable --ab-custom-scrollbar-size (default: 10px)
false
Loading Screen Options
LoadingScreenOptions
Options for the Loading Screen shown when AdapTable is initialising
string
Text to display in Loading Screen.
'Retrieving your settings and setting up the grid...'
Find Out More
See Configuring the Loading Screen for full instructions
Date Input Options
DateInputOptions
Options for managing and customizing the date inputs.
boolean
Display outside days (i.e. those falling in next or previous month)
true
boolean
Use browser specific date input instead of AdapTable's Date Picker
false
Find Out More
The dateInputOptions are described in greater detail in the Date Picker Guide
Colour Picker Options
ColourPickerOptions
Options for the Colour Picker.
(context:ColourPickerFilterContext) =>ColourPickerFilterResult | void
Chooses which of the supplied colours (theme & colour palette) the Palette tab shows
boolean
Orders Palette swatches around the colour wheel; if false, each colour stays the order supplied
true
boolean
Show Theme and Palette headings on the Palette tab (if both have colours)
false
Colour Picker tabs to display in order provided; Custom, Palette, or both
['Custom', 'Palette']
Find Out More
See Configuring the Colour Picker for the full guide
User Interface API
UserInterfaceApi
Icons, editable and read-only styles, the progress indicator, custom windows, and showing or hiding the UI.
void
Closes a custom window
AdaptableObject[] | undefined
Retrieves all objects in list which contain the given Tag
Retrieves Custom Icons provided by users
AdaptableStyle | undefined
Returns Style set for Editable cells
AdaptableStyle | undefined
Returns Style for Cells that have been edited
AdaptableStyle | undefined
Returns Style set for ReadOnly Cells
string[] | undefined
Retrieves any Style Class Names from User Interface Options
Retrieves the current User Interface State
void
Hides all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.)
void
Hides the progress indicator
boolean
Returns whether the AdapTable UI is currently visible
{ close: () => void; }
Opens a custom window popup
void
Shows all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.)
{ close: () => void; }
Displays a progress indicator