ToolPanelApi
Functions for managing the AdapTable ToolPanel Component (at side of grid)
export interfaceMethods
| Method | Description |
|---|---|
| closeAdapTableToolPanel() | Closes the Tool Panel section (irrespective of which toolpanel is showing) |
| getCustomToolPanelButtons() | Retrieves all Custom Tool Panel Buttons defined in ToolPanelOptions |
| getCustomToolPanelByName(name) | Retrieves the CustomToolPanel with the given name (or undefined if no match is found) |
| getCustomToolPanels() | Retrieves all Custom Tool Panels defined in ToolPanelOptions |
| getModuleButtons() | Sets the Module buttons from the Adaptable ToolPanel |
| getToolPanelState() | Retrieves Tool Panel section from Tool Panel State |
| openAdapTableToolPanel() | Opens the Adaptable ToolPanel Component |
| setAdaptableToolPanelVisibilityMode(adaptableToolPanel, visibilityMode) | Sets the given Adaptable ToolPanel with the provided visibilityMode (expanded / collapsed) |
| setCustomToolPanelVisibilityMode(customToolPanelName, visibilityMode) | Sets the Custom ToolPanel with the given name with the provided visibilityMode (expanded / collapsed) |
| setModuleButtons(moduleButtons) | Sets the Module buttons in the Adaptable ToolPanel |
| showToolPanelPopup() | Opens Settings Panel with Tool Panel section selected and visible |
Method Details
closeAdapTableToolPanel
Closes the Tool Panel section (irrespective of which toolpanel is showing)
closeAdapTableToolPanel(): void;Returns
void
getCustomToolPanelButtons
Retrieves all Custom Tool Panel Buttons defined in ToolPanelOptions
getCustomToolPanelButtons(): AdaptableButton<ToolPanelButtonContext>[];Returns
AdaptableButton<ToolPanelButtonContext>[]
getCustomToolPanelByName
Retrieves the CustomToolPanel with the given name (or undefined if no match is found)
getCustomToolPanelByName(name: string): CustomToolPanel | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | the CustomToolPanel name |
Returns
CustomToolPanel | undefined
getCustomToolPanels
Retrieves all Custom Tool Panels defined in ToolPanelOptions
getCustomToolPanels(): CustomToolPanel[];Returns
getModuleButtons
Sets the Module buttons from the Adaptable ToolPanel
getModuleButtons(): AdaptableModuleButtons;Returns
AdaptableModuleButtons
getToolPanelState
Retrieves Tool Panel section from Tool Panel State
getToolPanelState(): ToolPanelState;Returns
openAdapTableToolPanel
Opens the Adaptable ToolPanel Component
openAdapTableToolPanel(): void;Returns
void
setAdaptableToolPanelVisibilityMode
Sets the given Adaptable ToolPanel with the provided visibilityMode (expanded / collapsed)
setAdaptableToolPanelVisibilityMode(adaptableToolPanel: AdaptableToolPanel, visibilityMode: ToolPanelVisibilityMode): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| adaptableToolPanel | AdaptableToolPanel | |
| visibilityMode | ToolPanelVisibilityMode |
Returns
void
setCustomToolPanelVisibilityMode
Sets the Custom ToolPanel with the given name with the provided visibilityMode (expanded / collapsed)
setCustomToolPanelVisibilityMode(customToolPanelName: string, visibilityMode: ToolPanelVisibilityMode): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| customToolPanelName | string | |
| visibilityMode | ToolPanelVisibilityMode |
Returns
void
setModuleButtons
Sets the Module buttons in the Adaptable ToolPanel
setModuleButtons(moduleButtons: AdaptableModuleButtons): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| moduleButtons | AdaptableModuleButtons | the module buttons |
Returns
void
showToolPanelPopup
Opens Settings Panel with Tool Panel section selected and visible
showToolPanelPopup(): void;Returns
void