Skip to main content

Interface: ActionState

Charting Library.ActionState

Properties​

actionId​

actionId: ActionId

Human-readable, non-unique ID of an action item. Similar to label, but language-agnostic.

active​

active: boolean

Is active

checkable​

checkable: boolean

Whether an action should have a checkbox next to it.

checked​

checked: boolean

If checkable is true then whether current state is checked or not.

disabled​

disabled: boolean

Whether an action is disabled or not (disabled actions are usually cannot be executed and displayed grayed out)

doNotCloseOnClick​

doNotCloseOnClick: boolean

A flag indicating whether the menu should remain open after clicking on the item. When true the menu will remain open.

hint​

Optional

hint: string

A hint of an action.

icon​

Optional

icon: string

A string of SVG icon for an action. A string should be a string representation of SVG (not a path/URL).

iconChecked​

Optional

iconChecked: string

If checkable is true then an icon to be used when checked is true.

label​

label: string

Text title of an action

loading​

loading: boolean

Whether an action is still in loading state (it means that it's data is not ready yet). Usually in this case a spinner/loader will be displayed instead of this action.

noInteractive​

Optional

noInteractive: boolean

This flag indicates that this action is static content only and is not interactive.

shortcutHint​

Optional

shortcutHint: string

A string that represents a shortcut hint for this action.

styledLabel​

Optional

styledLabel: StyledText[]

Text title of an action consisting of several styled sections. If not defined then label is used instead.

subItems​

subItems: IActionVariant[]

Sub-items of an action