ContextToolExtension

Interface

The extension interface for ContextTool extension point.

Inheritance: ContextToolExtensionBaseExtension

Properties

Hide inherited properties
PropertyTypeNotes
id
 inherited 
string

The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName

index
 inherited 
number

If an extension point supports multiple extensions, the index is used to determine the extension order.

name
 inherited 
string

The extension name.

widgetId
 inherited 
string

The widget id that provides the extension. No widget id means the extension is provided by Jimu.

id

inherited
Interface Property
id: string

The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName

Inherited from BaseExtension.id

index

optionalinherited
Interface Property
index: number

If an extension point supports multiple extensions, the index is used to determine the extension order.

Inherited from BaseExtension.index

name

optionalinherited
Interface Property
name: string

The extension name.

Inherited from BaseExtension.name

widgetId

optionalinherited
Interface Property
widgetId: string

The widget id that provides the extension. No widget id means the extension is provided by Jimu.

Inherited from BaseExtension.widgetId

Methods

MethodReturnsNotes
checked(props)
boolean

Check whether this tool is checked.

disabled(props)
boolean

Check whether this tool is disabled.

string

Return group id.

ComponentClass<SVGAttributes<SVGElement>any>

Return the icon.

ComponentClass<unknownany>

The setting panel of the tool. Returning null means there is no setting panel for the tool. If the returned value is not null, the setting panel will be rendered.

getTitle(props)
string

Return the title.

onClick(props, evt?)
void

OnClick callback.

visible(props)
boolean

Check whether this tool is visible.

checked

optional
Interface Method
checked(propsLayoutContextToolProps): boolean

Check whether this tool is checked.

Parameters
ParameterType
props
LayoutContextToolProps
Returns 
boolean

disabled

optional
Interface Method
disabled(propsLayoutContextToolProps): boolean

Check whether this tool is disabled.

Parameters
ParameterType
props
LayoutContextToolProps
Returns 
boolean

getGroupId

Interface Method
getGroupId(): string

Return group id.

Returns 
string

getIcon

Interface Method
getIcon(): ComponentClass<SVGAttributes<SVGElement>any>

Return the icon.

Returns 
ComponentClass<SVGAttributes<SVGElement>any>

getSettingPanel

Interface Method
getSettingPanel(propsLayoutContextToolProps): ComponentClass<unknownany>

The setting panel of the tool. Returning null means there is no setting panel for the tool. If the returned value is not null, the setting panel will be rendered.

Parameters
ParameterType
props
LayoutContextToolProps
Returns 
ComponentClass<unknownany>

getTitle

Interface Method
getTitle(propsLayoutContextToolProps): string

Return the title.

Parameters
ParameterType
props
LayoutContextToolProps
Returns 
string

onClick

optional
Interface Method
onClick(propsLayoutContextToolProps, evt?MouseEvent<anyMouseEvent>): void

OnClick callback.

Parameters
ParameterType
props
LayoutContextToolProps
evt
MouseEvent<anyMouseEvent>
Returns 
void

visible

optional
Interface Method
visible(propsLayoutContextToolProps): boolean

Check whether this tool is visible.

Parameters
ParameterType
props
LayoutContextToolProps
Returns 
boolean

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.