AbstractToolItemProps Interface
Beta
Definition for a Tool item with a tool id.
Extends
Properties
Name | Type | Description | |
---|---|---|---|
toolId | string | Id of Tool item |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
applicationData | undefined | any | AbstractItemProps | can be used by application to store miscellaneous data. |
badgeType | undefined | BadgeType | AbstractItemProps | Badge to be overlaid on the item. |
description | string | StringGetter | DescriptionProps | if set, it is used to explicitly set the description shown by a component. |
descriptionKey | undefined | string | DescriptionProps | if set, it is used to define a key that is used to look up a localized string. |
execute | undefined | (args?: any) => any | CommandHandler | Function to execute |
getCommandArgs | undefined | () => any[] | CommandHandler | Function to get the parameters passed to the function |
iconSpec | undefined | string | AbstractIconProps | Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. |
isActive | undefined | false | true | AbstractItemProps | if set, component will be considered "active" an will display an "active stripe" - defaults to false |
isEnabled | undefined | false | true | AbstractItemProps | if set, component will be enabled - defaults to true |
isPressed | undefined | false | true | AbstractItemProps | if set, component will be considered selected but will NOT display an "active stripe" - defaults to false. |
isVisible | undefined | false | true | AbstractItemProps | if set, component will be visible - defaults to true |
label | string | StringGetter | LabelProps | if set, it is used to explicitly set the label shown by a component. |
labelKey | undefined | string | LabelProps | if set, it is used to define a key that is used to look up a localized string. |
parameters | undefined | any | CommandHandler | Parameters passed to the function |
stateFunc | undefined | (state: Readonly<BaseItemState>) => BaseItemState | SyncUiProps | Function called to get the new items state |
stateSyncIds | undefined | string[] | SyncUiProps | Synchronize Ids to listen for |
tooltip | string | StringGetter | TooltipProps | used to explicitly set the tooltip shown by a component. |
tooltipKey | undefined | string | TooltipProps | if set, it is used to define a key that is used to look up a localized string. |
Defined in
Last Updated: 08 January, 2020