Interface: IUpdatableAction

Charting Library.IUpdatableAction

Hierarchy

• IAction

  ↳ IUpdatableAction

Properties

id

• Readonly id: string

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

Inherited from

IAction.id

---

type

• Readonly type: Action

Menu item type

Inherited from

IAction.type

Methods

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

Inherited from

IAction.execute

---

getState

▸ getState(): Readonly<ActionState>

Returns

Readonly<ActionState>

Returns a state object of the action.

Inherited from

IAction.getState

---

onUpdate

▸ onUpdate(): ISubscription<OnActionUpdateHandler>

Returns

ISubscription<OnActionUpdateHandler>

A subscription for an event when an action is updated.

Inherited from

IAction.onUpdate

---

update

▸ update(options): void

Update the options for the Action

Parameters

Name	Type	Description
options	Partial<OmitActionId<ActionOptions>>	updated options

Returns

void