ChartContextMenu

Documentation / @elitechart/core / ChartContextMenu

Right-click context menu for the chart background (not over a drawing). Provides the canonical "Reset view / Copy price / Create alert / Settings…" entries.

Example

code

const menu = new ChartContextMenu({ mount: chartContainer });
menu.showFor(binding, { x: 240, y: 180 });

Constructors

Constructor

code

new ChartContextMenu(config): ChartContextMenu;

Defined in: ui/chart-context-menu.ts:87

Parameters

config

ChartContextMenuConfig

Returns

ChartContextMenu

Accessors

element

Get Signature

code

get element(): HTMLElement;

Defined in: ui/chart-context-menu.ts:123

Returns

HTMLElement

visible

Get Signature

code

get visible(): boolean;

Defined in: ui/chart-context-menu.ts:119

Returns

boolean

Methods

close()

code

close(): void;

Defined in: ui/chart-context-menu.ts:113

Returns

void

destroy()

code

destroy(): void;

Defined in: ui/chart-context-menu.ts:127

Returns

void

showFor()

code

showFor(binding, pos): void;

Defined in: ui/chart-context-menu.ts:97

Show the menu at pos (local to the mount) with the supplied binding.

Parameters

binding

ChartContextMenuBinding

pos

ContextMenuPosition

Returns

void