Skip to main content

Interface: IAction

Charting Library.IAction

Hierarchy​

Properties​

id​

• Readonly id: string

An unique ID of an action item. Could be used to distinguish actions between each other.

Inherited from​

IMenuItem.id

type​

• Readonly type: Action

Menu item type

Overrides​

IMenuItem.type

Methods​

destroy​

▸ destroy(): void

Clean up (destroy) any subscriptions, intervals, or other resources that this IDestroyable instance has.

Returns​

void

Inherited from​

IDestroyable.destroy

execute​

▸ execute(): void

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

Returns​

void

getState​

▸ getState(): Readonly<ActionState>

Returns​

Readonly<ActionState>

Returns a state object of the action.

onUpdate​

▸ onUpdate(): ISubscription<OnActionUpdateHandler>

Returns​

ISubscription<OnActionUpdateHandler>

A subscription for an event when an action is updated.