ContextToolExtension

Interface

The extension interface for ContextTool extension point.

Inheritance: ContextToolExtensionBaseExtension

Properties

id
id: string

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

index optional
index: number

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

name optional
name: string

The extension name.

widgetId optional
widgetId: string

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

Methods

checked optional
checked(propsLayoutContextToolProps): boolean

Check whether this tool is checked.

Parameters
  • propsLayoutContextToolProps
Returns 
boolean
disabled optional
disabled(propsLayoutContextToolProps): boolean

Check whether this tool is disabled.

Parameters
  • propsLayoutContextToolProps
Returns 
boolean
getGroupId
getGroupId(): string

Return group id.

Returns 
string
getIcon
getIcon(): ComponentClass<SVGAttributes<SVGElement>any>

Return the icon.

Returns 
ComponentClass<SVGAttributes<SVGElement>any>
getSettingPanel
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
  • propsLayoutContextToolProps
Returns 
ComponentClass<unknownany>
getTitle
getTitle(propsLayoutContextToolProps): string

Return the title.

Parameters
  • propsLayoutContextToolProps
Returns 
string
onClick optional
onClick(propsLayoutContextToolProps, evt?MouseEvent<anyMouseEvent>): void

OnClick callback.

Parameters
  • propsLayoutContextToolProps
  • evtMouseEvent<anyMouseEvent>optional 
Returns 
void
visible optional
visible(propsLayoutContextToolProps): boolean

Check whether this tool is visible.

Parameters
  • propsLayoutContextToolProps
Returns 
boolean

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