Skip to content

charton API


charton API / @chart-on/ui / index / ContextMenuOptions

Interface: ContextMenuOptions ​

Defined in: ui/src/context-menu.ts:30

Options for createContextMenu: how to build each menu's items from the defaults, and where errors from an item's onSelect go.

Methods ​

items()? ​

optional items(event, defaults, chart): ContextMenuItem[]

Defined in: ui/src/context-menu.ts:35

The items for one menu. Receives the default items for the event's target, so it can add to, remove from or reorder them. Return [] for no menu.

Parameters ​

event ​

ChartContextMenuEvent

defaults ​

ContextMenuItem[]

chart ​

Chart

Returns ​

ContextMenuItem[]


onError()? ​

optional onError(error, itemId): void

Defined in: ui/src/context-menu.ts:40

An item's onSelect threw or its promise rejected, e.g. the clipboard refused "Copy price". Defaults to console.error.

Parameters ​

error ​

unknown

itemId ​

string

Returns ​

void