# User Interface Technical Reference Canonical page: https://www.adaptabletools.com/docs/technical-reference-ui ## User Interface State | Property | Type | Description | Default | | --- | --- | --- | --- | | [HideAdaptableUI](https://www.adaptabletools.com/docs/reference/userinterfacestate.md#hideadaptableui) | `boolean` | Hides all AdapTable UI elements (i.e. Dashboard, Tool Panel, Status Bar, Column & Context Menus etc.) | false | --- ## User Interface Options | Property | Type | Description | Default | | --- | --- | --- | --- | | [alternativeModuleIcons](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#alternativemoduleicons) | [`AlternativeModuleIcon`](https://www.adaptabletools.com/docs/reference/alternativemoduleicon.md)`[]` | Alternative icons to use for Adaptable Modules in the UI (Settings Panel,
Dashboard / Tool Panel buttons, Status Bar, menus, etc.) | null | | [alternativeModuleNames](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#alternativemodulenames) | [`AlternativeModuleName`](https://www.adaptabletools.com/docs/reference/alternativemodulename.md)`[]` | Alternative names to use for Adaptable Modules in the UI | null | | [applicationIcon](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#applicationicon) | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md) | The application icon to appear in Dashboard and elsewhere (e.g. in Notifications) | null | | [colourPickerOptions](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#colourpickeroptions) | [`ColourPickerOptions`](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md) | Options for the Colour Picker, including which colours to display | | | [customIcons](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#customicons) | [`CustomIcon`](https://www.adaptabletools.com/docs/reference/customicon.md)`[] \| (() => `[`CustomIcon`](https://www.adaptabletools.com/docs/reference/customicon.md)`[])` | Bespoke icons that can be used in AdapTable (e.g. Badge Styles and Buttons) | | | [dateInputOptions](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#dateinputoptions) | [`DateInputOptions`](https://www.adaptabletools.com/docs/reference/dateinputoptions.md) | Options for managing and customizing date inputs in AdapTable | | | [disableDeleteConfirmation](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#disabledeleteconfirmation) | `boolean` | Hides confirmation dialog which displays whenever an AdaptableObject is deleted | false | | [editableCellStyle](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#editablecellstyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md) | Style to set for editable Cells | | | [editedCellStyle](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#editedcellstyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md) | Style to set for Cells which have been edited | | | [englishVariant](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#englishvariant) | `'GB' \| 'US'` | English variant to use in AdapTable UI | 'GB' | | [loadingScreenOptions](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#loadingscreenoptions) | [`LoadingScreenOptions`](https://www.adaptabletools.com/docs/reference/loadingscreenoptions.md) | Options for showing Loading Screen (during initialisation) | | | [objectTags](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#objecttags) | [`AdaptableObjectTag`](https://www.adaptabletools.com/docs/reference/adaptableobjecttag.md)`[] \| ((context: `[`ObjectTagsContext`](https://www.adaptabletools.com/docs/reference/objecttagscontext.md)`) => `[`AdaptableObjectTag`](https://www.adaptabletools.com/docs/reference/adaptableobjecttag.md)`[] \| undefined)` | Optional list of AdaptableObjectTags that can be associated with AdaptableObjects.

When provided as a function, return `undefined` to provide no tags. | | | [readOnlyCellStyle](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#readonlycellstyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md) | Style to set for non-editable Cells | | | [showAdapTableVersion](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#showadaptableversion) | `boolean` | Displays the AdapTable version in Grid Info section of Settings Panel | true | | [showAgGridVersion](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#showaggridversion) | `boolean` | Displays the AG Grid version in Grid Info section of Settings Panel | true | | [showDocumentationLinks](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#showdocumentationlinks) | `boolean` | Provide links to AdapTable documentation (in Module popups and Expression Editor) | true | | [styleClassNames](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#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](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md#usecustommaclikescrollbars) | `boolean` | Show Mac-like scrollbars; size is configurable via CSS variable `--ab-custom-scrollbar-size` (default: `10px`) | false | ### Loading Screen Options | Property | Type | Description | Default | | --- | --- | --- | --- | | [loadingScreenDelay](https://www.adaptabletools.com/docs/reference/loadingscreenoptions.md#loadingscreendelay) | `number` | Delay in ms before Loading Screen appears | 200 | | [loadingScreenText](https://www.adaptabletools.com/docs/reference/loadingscreenoptions.md#loadingscreentext) | `string` | Text to display in Loading Screen. | 'Retrieving your settings and setting up the grid...' | | [loadingScreenTitle](https://www.adaptabletools.com/docs/reference/loadingscreenoptions.md#loadingscreentitle) | `string` | Title to display in Loading Screen. | 'Initialising Grid' | | [showLoadingScreen](https://www.adaptabletools.com/docs/reference/loadingscreenoptions.md#showloadingscreen) | `boolean` | Display Loading Screen when AdapTable initialises | true | See [Configuring the Loading Screen](https://www.adaptabletools.com/docs/ui-loading-screen/index.md) for full instructions ### Date Input Options | Property | Type | Description | Default | | --- | --- | --- | --- | | [dateFormat](https://www.adaptabletools.com/docs/reference/dateinputoptions.md#dateformat) | `string` | Format string for formatting date input field | 'yyyy-MM-dd' (ISO 8601 format) | | [datepickerButtons](https://www.adaptabletools.com/docs/reference/dateinputoptions.md#datepickerbuttons) | `DatepickerButton[]` | List of buttons which are displayed in the datepicker overlay in the given order (provide empty array to display no buttons); custom button layout and positioning is achievable with the special elements `-` and `\|` | ['close','today'] | | [locale](https://www.adaptabletools.com/docs/reference/dateinputoptions.md#locale) | `any` | Locale object (to localize Date Picker) | `en-US` | | [showOutsideDays](https://www.adaptabletools.com/docs/reference/dateinputoptions.md#showoutsidedays) | `boolean` | Display outside days (i.e. those falling in next or previous month) | true | | [showWeekNumber](https://www.adaptabletools.com/docs/reference/dateinputoptions.md#showweeknumber) | `boolean` | Display the week numbers column | false | | [useNativeInput](https://www.adaptabletools.com/docs/reference/dateinputoptions.md#usenativeinput) | `boolean` | Use browser specific date input instead of AdapTable's Date Picker | false | The `dateInputOptions` are described in greater detail in the [Date Picker](https://www.adaptabletools.com/docs/handbook-cell-editors-date-picker/index.md) Guide ### Colour Picker Options | Property | Type | Description | Default | | --- | --- | --- | --- | | [filterColours](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#filtercolours) | `(context: `[`ColourPickerFilterContext`](https://www.adaptabletools.com/docs/reference/colourpickerfiltercontext.md)`) => `[`ColourPickerFilterResult`](https://www.adaptabletools.com/docs/reference/colourpickerfilterresult.md)` \| void` | Chooses which of the supplied colours (theme & colour palette) the Palette tab shows | | | [orderPaletteColours](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#orderpalettecolours) | `boolean` | Orders Palette swatches around the colour wheel; if `false`, each colour stays the order supplied | true | | [removeDuplicates](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#removeduplicates) | `boolean` | Leave out duplicates of swatches already displayed | true | | [showGroupLabels](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#showgrouplabels) | `boolean` | Show **Theme** and **Palette** headings on the Palette tab (if both have colours) | false | | [tabs](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#tabs) | [`ColourPickerTab`](https://www.adaptabletools.com/docs/reference/colourpickertab.md)`[]` | Colour Picker tabs to display in order provided; `Custom`, `Palette`, or both | ['Custom', 'Palette'] | See [Configuring the Colour Picker](https://www.adaptabletools.com/docs/ui-tutorial-custom-colour-palette/index.md) for the full guide --- ## User Interface API | Method | Returns | Description | | --- | --- | --- | | [closeCustomWindowPopup(windowId)](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#closecustomwindowpopup) | `void` | Closes a custom window | | [getAdaptableObjectsWithTag(tag, adaptableModule)](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#getadaptableobjectswithtag) | [`AdaptableObject`](https://www.adaptabletools.com/docs/reference/adaptableobject.md)`[] \| undefined` | Retrieves all objects in list which contain the given Tag | | [getAdaptableObjectTags()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#getadaptableobjecttags) | [`AdaptableObjectTag`](https://www.adaptabletools.com/docs/reference/adaptableobjecttag.md)`[] \| undefined` | Retrieves any Object Tags (provided in User Interface Options) | | [getCustomIcons()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#getcustomicons) | [`CustomIcon`](https://www.adaptabletools.com/docs/reference/customicon.md)`[]` | Retrieves Custom Icons provided by users | | [getEditableCellStyle()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#geteditablecellstyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md)` \| undefined` | Returns Style set for Editable cells | | [getEditedCellStyle()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#geteditedcellstyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md)` \| undefined` | Returns Style for Cells that have been edited | | [getReadOnlyCellStyle()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#getreadonlycellstyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md)` \| undefined` | Returns Style set for ReadOnly Cells | | [getStyleClassNames()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#getstyleclassnames) | `string[] \| undefined` | Retrieves any Style Class Names from User Interface Options | | [getUserInterfaceState()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#getuserinterfacestate) | [`UserInterfaceState`](https://www.adaptabletools.com/docs/reference/userinterfacestate.md) | Retrieves the current User Interface State | | [hideAdaptableUI()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#hideadaptableui) | `void` | Hides all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.) | | [hideProgressIndicator()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#hideprogressindicator) | `void` | Hides the progress indicator | | [isAdaptableUIVisible()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#isadaptableuivisible) | `boolean` | Returns whether the AdapTable UI is currently visible | | [openCustomWindowPopup(config)](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#opencustomwindowpopup) | `\{ close: () => void; \}` | Opens a custom window popup | | [showAdaptableUI()](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#showadaptableui) | `void` | Shows all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.) | | [showProgressIndicator(config)](https://www.adaptabletools.com/docs/reference/userinterfaceapi.md#showprogressindicator) | `\{ close: () => void; \}` | Displays a progress indicator |