ContextToolExtension
Interface
The extension interface for ContextTool extension point.
Properties
| Property | Type | Notes |
|---|---|---|
(props: LayoutContextToolProps) => boolean | ||
(props: LayoutContextToolProps) => boolean | ||
() => string | ||
() => ComponentClass<SVGAttributes<SVGElement>, any> | ||
(props: LayoutContextToolProps) => ComponentClass<unknown, any> | ||
(props: LayoutContextToolProps) => string | ||
string | The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName | |
number | If an extension point supports multiple extensions, the index is used to determine the extension order. | |
string | The extension name. | |
(props: LayoutContextToolProps, evt?: MouseEvent<any, MouseEvent>) => void | ||
(props: LayoutContextToolProps) => boolean | ||
string | The widget id that provides the extension. No widget id means the extension is provided by Jimu. |
disabled
disabled: (props: LayoutContextToolProps) => booleanType declaration
function(props: LayoutContextToolProps): booleanCheck whether this tool is disabled.
Parameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
booleangetGroupId
Interface PropertygetGroupId: () => stringType declaration
function(): stringReturn group id.
Returns
stringgetIcon
Interface PropertygetIcon: () => ComponentClass<SVGAttributes<SVGElement>, any>Type declaration
function(): ComponentClass<SVGAttributes<SVGElement>, any>Return the icon.
Returns
ComponentClass<SVGAttributes<SVGElement>, any>getSettingPanel
Interface PropertygetSettingPanel: (props: LayoutContextToolProps) => ComponentClass<unknown, any>Type declaration
function(props: LayoutContextToolProps): ComponentClass<unknown, any>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
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
ComponentClass<unknown, any>getTitle
Interface PropertygetTitle: (props: LayoutContextToolProps) => stringType declaration
function(props: LayoutContextToolProps): stringReturn the title.
Parameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
stringid
id: stringThe unique id. For widget's provided extension, the id pattern is: widgetId + extensionName
index
index: numberIf an extension point supports multiple extensions, the index is used to determine the extension order.
onClick
onClick: (props: LayoutContextToolProps, evt?: MouseEvent<any, MouseEvent>) => voidType declaration
function(props: LayoutContextToolProps, evt?: MouseEvent<any, MouseEvent>): voidOnClick callback.
Parameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
evt | MouseEvent<any, MouseEvent> |
Returns
voidvisible
visible: (props: LayoutContextToolProps) => booleanType declaration
function(props: LayoutContextToolProps): booleanCheck whether this tool is visible.
Parameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
booleanwidgetId
widgetId: stringThe widget id that provides the extension. No widget id means the extension is provided by Jimu.
checked: (props: LayoutContextToolProps) => booleanType declaration
function(props: LayoutContextToolProps): booleanCheck whether this tool is checked.
Parameters
propsReturns
boolean