UserInterfaceApi
Functions relating to User Interface section of Adaptable State
export interfaceMethods
| Method | Description |
|---|---|
| closeCustomWindowPopup(windowId) | Closes a custom window |
| getAdaptableObjectsWithTag(tag, adaptableModule) | Retrieves all objects in list which contain the given Tag |
| getAdaptableObjectTags() | Retrieves any Object Tags (provided in User Interface Options) |
| getColorPalette() | Retrieves Color Palette currently being used |
| getCustomIcons() | Retrieves Custom Icons provided by users |
| getEditableCellStyle() | Returns Style set for Editable cells |
| getEditedCellStyle() | Returns Style for Cells that have been edited |
| getReadOnlyCellStyle() | Returns Style set for ReadOnly Cells |
| getStyleClassNames() | Retrieves any Style Class Names from User Interface Options |
| getUserInterfaceState() | Retrieves the current User Interface State |
| hideAdaptableUI() | Hides all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.) |
| hideProgressIndicator() | Hides the progress indicator |
| isAdaptableUIVisible() | Returns whether the AdapTable UI is currently visible |
| openCustomWindowPopup(config) | Opens a custom window popup |
| showAdaptableUI() | Shows all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.) |
| showProgressIndicator(config) | Displays a progress indicator |
Method Details
closeCustomWindowPopup
Closes a custom window
closeCustomWindowPopup(windowId: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| windowId | string | window popup id |
Returns
void
getAdaptableObjectsWithTag
Retrieves all objects in list which contain the given Tag
getAdaptableObjectsWithTag(tag: AdaptableObjectTag, adaptableModule?: AdaptableModule): AdaptableObject[] | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| tag | AdaptableObjectTag | Tag to check |
| adaptableModule | AdaptableModule | optional Module to check |
Returns
AdaptableObject[] | undefined
getAdaptableObjectTags
Retrieves any Object Tags (provided in User Interface Options)
getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;Returns
AdaptableObjectTag[] | undefined
getColorPalette
Retrieves Color Palette currently being used
getColorPalette(): string[];Returns
string[]
getCustomIcons
Retrieves Custom Icons provided by users
getCustomIcons(): CustomIcon[];Returns
getEditableCellStyle
Returns Style set for Editable cells
getEditableCellStyle(): AdaptableStyle | undefined;Returns
AdaptableStyle | undefined
getEditedCellStyle
Returns Style for Cells that have been edited
getEditedCellStyle(): AdaptableStyle | undefined;Returns
AdaptableStyle | undefined
getReadOnlyCellStyle
Returns Style set for ReadOnly Cells
getReadOnlyCellStyle(): AdaptableStyle | undefined;Returns
AdaptableStyle | undefined
getStyleClassNames
Retrieves any Style Class Names from User Interface Options
getStyleClassNames(): string[] | undefined;Returns
string[] | undefined
getUserInterfaceState
Retrieves the current User Interface State
getUserInterfaceState(): UserInterfaceState;Returns
hideAdaptableUI
Hides all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.)
hideAdaptableUI(): void;Returns
void
hideProgressIndicator
Hides the progress indicator
hideProgressIndicator(): void;Returns
void
isAdaptableUIVisible
Returns whether the AdapTable UI is currently visible
isAdaptableUIVisible(): boolean;Returns
boolean
openCustomWindowPopup
Opens a custom window popup
openCustomWindowPopup(config: CustomWindowConfig): {
close: () => void;
};Parameters
| Parameter | Type | Description |
|---|---|---|
| config | CustomWindowConfig | The configuration for the custom window |
Returns
\{ close: () => void; \}
showAdaptableUI
Shows all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.)
showAdaptableUI(): void;Returns
void
showProgressIndicator
Displays a progress indicator
showProgressIndicator(config: ProgressIndicatorConfig): {
close: () => void;
};Parameters
| Parameter | Type |
|---|---|
| config | ProgressIndicatorConfig |
Returns
\{ close: () => void; \}