ToolSettingsManager Class
Deprecated in 3.7. Use UiFramework.toolSettings property.
Tool Settings Manager class. Used to generate UI components for Tool Settings.
Methods
| Name | Description | |
|---|---|---|
| constructor(): ToolSettingsManager | ||
| clearToolSettingsData(): void Static | clear cached Tool Settings properties. | |
| focusIntoToolSettings(): boolean Static | ||
| initialize(): void Static | Initializes the ToolSettingsManager | Deprecated |
| initializeDataForTool(tool: InteractiveTool): void Static | Set of data used in Tool Settings for the specified tool. | |
| initializeToolSettingsData(toolSettingsProperties: undefined | DialogItem[], toolId?: string, toolLabel?: string, toolDescription?: string): boolean Static | Cache Tool Settings properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
| activeToolDescription Accessor StaticReadOnly | string | Returns the description of the active tool. | |
| activeToolLabel Accessor Static | string | The name of the active tool. | |
| onReloadToolSettingsProperties Accessor StaticReadOnly | UiEvent<void> | ||
| onSyncToolSettingsProperties Accessor StaticReadOnly | SyncToolSettingsPropertiesEvent | Get ToolSettings Properties sync event. | |
| toolIdForToolSettings Accessor StaticReadOnly | string | Gets the Id of the active tool. | |
| toolSettingsProperties Accessor StaticReadOnly | DialogItem[] | Returns the toolSettings properties that can be used to populate the tool settings widget. | |
| useDefaultToolSettingsProvider Accessor Static | boolean | Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties. |
Defined in
Last Updated: 20 June, 2023