API Reference > ui-ninezone > Widget > ToolSettings

ToolSettings<S, SS> Class

Beta

Tool settings widget is used to display Tool Settings and Tool Assistance (in Zone 2 of 9-Zone UI).

note Should be placed in Zone component.

Extends

Methods

Name Description
getBounds(): RectangleProps    
render(): Element    

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<ToolSettingsProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<ToolSettingsProps>, nextState: Readonly<S>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
componentDidCatch(error: Error, errorInfo: ErrorInfo): void Optional ComponentLifecycle Catches exceptions generated in descendant components.
componentDidMount(): void Optional ComponentLifecycle Called immediately after a component is mounted.
componentDidUpdate(prevProps: Readonly<ToolSettingsProps>, prevState: Readonly<S>, snapshot?: SS): void Optional NewLifecycle Called immediately after updating occurs.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<ToolSettingsProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUnmount(): void Optional ComponentLifecycle Called immediately before a component is destroyed.
componentWillUpdate(nextProps: Readonly<ToolSettingsProps>, nextState: Readonly<S>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
getSnapshotBeforeUpdate(prevProps: Readonly<ToolSettingsProps>, prevState: Readonly<S>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
returns an object to be given to componentDidUpdate.
shouldComponentUpdate(nextProps: Readonly<ToolSettingsProps>, nextState: Readonly<S>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Defined in

Last Updated: 08 January, 2020