Interface
The extension interface for ContextTool extension point.
Properties
| Property | Type | Notes |
|---|---|---|
(props: LayoutContextToolProps) => boolean | Check whether this tool is checked. | |
(props: LayoutContextToolProps) => boolean | Check whether this tool is disabled. | |
() => string | Return group id. | |
() => ComponentClass<SVGAttributes<SVGElement>, any> | Return the icon. | |
(props: LayoutContextToolProps) => FunctionComponent<any> | ComponentClass<any, 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. | |
(props: LayoutContextToolProps) => string | Return the title. | |
idinherited | string | The unique ID. For widget's provided extension, the id pattern is: widgetId + extensionName |
indexinherited | number | If an extension point supports multiple extensions, the index is used to determine the extension order. |
labelinherited | string | The extension label. |
nameinherited | string | The extension name. |
(props: LayoutContextToolProps, evt?: MouseEvent<any, MouseEvent>) => void | OnClick callback. | |
boolean | Check whether this tool should be opened by default when the toolbar opened. | |
(props: LayoutContextToolProps) => boolean | Check whether this tool is visible. | |
widgetIdinherited | string | The widget ID that provides the extension. No widget id means the extension is provided by Jimu. |
checked
checked: (props: LayoutContextToolProps) => booleanCheck whether this tool is checked.
Type declaration
function(props: LayoutContextToolProps): booleanParameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
booleandisabled
disabled: (props: LayoutContextToolProps) => booleanCheck whether this tool is disabled.
Type declaration
function(props: LayoutContextToolProps): booleanParameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
booleangetGroupId
Interface PropertygetGroupId: () => stringReturn group id.
Type declaration
function(): stringReturns
stringgetIcon
Interface PropertygetIcon: () => ComponentClass<SVGAttributes<SVGElement>, any>Return the icon.
Type declaration
function(): ComponentClass<SVGAttributes<SVGElement>, any>Returns
ComponentClass<SVGAttributes<SVGElement>, any>getSettingPanel
Interface PropertygetSettingPanel: (props: LayoutContextToolProps) => FunctionComponent<any> | ComponentClass<any, 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.
Type declaration
function(props: LayoutContextToolProps): FunctionComponent<any> | ComponentClass<any, any>Parameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
FunctionComponent<any> | ComponentClass<any, any>getTitle
Interface PropertygetTitle: (props: LayoutContextToolProps) => stringReturn the title.
Type declaration
function(props: LayoutContextToolProps): stringParameters
| 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>) => voidOnClick callback.
Type declaration
function(props: LayoutContextToolProps, evt?: MouseEvent<any, MouseEvent>): voidParameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
evt | MouseEvent<any, MouseEvent> |
Returns
voidopenWhenAdded
openWhenAdded: booleanCheck whether this tool should be opened by default when the toolbar opened.
visible
visible: (props: LayoutContextToolProps) => booleanCheck whether this tool is visible.
Type declaration
function(props: LayoutContextToolProps): booleanParameters
| Parameter | Type |
|---|---|
props | LayoutContextToolProps |
Returns
booleanwidgetId
widgetId: stringThe widget ID that provides the extension. No widget id means the extension is provided by Jimu.