Skip to main content

Interface: ActionOptions

Charting Library.ActionOptions

Hierarchy​

Properties​

actionId​

actionId: ActionId

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

Inherited from​

Pick.actionId

active​

Optional

active: boolean

Is active

Inherited from​

Partial.active

checkable​

Optional

checkable: boolean

Whether an action should have a checkbox next to it.

Inherited from​

Partial.checkable

checked​

Optional

checked: boolean

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

Inherited from​

Partial.checked

disabled​

Optional

disabled: boolean

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

Inherited from​

Partial.disabled

doNotCloseOnClick​

Optional

doNotCloseOnClick: boolean

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

Inherited from​

Partial.doNotCloseOnClick

hint​

Optional

hint: string

A hint of an action.

Inherited from​

Partial.hint

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).

Inherited from​

Partial.icon

iconChecked​

Optional

iconChecked: string

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

Inherited from​

Partial.iconChecked

label​

Optional

label: string

Text title of an action

Inherited from​

Partial.label

loading​

Optional

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.

Inherited from​

Partial.loading

noInteractive​

Optional

noInteractive: boolean

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

Inherited from​

Partial.noInteractive

onExecute​

Optional

onExecute: OnActionExecuteHandler

A function which will be called when an action should be executed (e.g. when a user clicks on the item).

shortcutHint​

Optional

shortcutHint: string

A string that represents a shortcut hint for this action.

Inherited from​

Partial.shortcutHint

styledLabel​

Optional

styledLabel: StyledText[]

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

Inherited from​

Partial.styledLabel

subItems​

Optional

subItems: IActionVariant[]

Sub-items of an action

Inherited from​

Partial.subItems