API Reference > ui-framework > ToolSettings > ToolUiProvider

ToolUiProvider Class

ToolUiProvider provides the Tool Settings and/or Tool Assistance UI for a tool. The ToolUiProvider is registered for the tool id via ConfigurableUiManager.registerControl.

Extends

Extended by

  • DefaultToolSettingsProvider

Implements

Methods

Name Description
constructor(info: ConfigurableCreateInfo, options: any): ToolUiProvider    
getType(): ConfigurableUiControlType Gets the type of ConfigurableUiControl, which is 'ToolUiProvider' in this case  

Inherited methods

Name Inherited from Description
onFrontstageDeactivated(): void ConfigurableUiControl Called when Frontstage is deactivated.
onFrontstageReady(): void ConfigurableUiControl Called when Frontstage is ready.
onInitialize(): void ConfigurableUiControl Called to initialize the ConfigurableUiControl.

Properties

Name Type Description
toolSettingsNode Accessor React.ReactNode Gets the Tool Settings React node  

Inherited properties

Name Type Inherited from Description
classId Accessor ReadOnly string ConfigurableBase Gets the class Id of configurable element
controlId Accessor ReadOnly string ConfigurableUiControl Returns the ID of this ConfigurableUiControl.
isReady Accessor ReadOnly Promise<void> ConfigurableUiControl Returns a promise that resolves when the control is ready for usage.
name Accessor ReadOnly string ConfigurableBase Get internal name of configurable element. If no name is defined in configuration
then the name will match the UniqueId.

Defined in

Last Updated: 08 January, 2020