Interface ChartClickEvent

Payload of the click event (chart.on('click', ...)). Its pressure is the pressure at the press, not the release, which always reads 0.

interface ChartClickEvent {
    ctrlKey: boolean;
    id: null | string;
    metaKey: boolean;
    modifiers: PointerModifiers;
    paneIndex: number;
    point: { x: number; y: number };
    pointerType: PointerKind;
    pressure: number;
    price: null | number;
    shiftKey: boolean;
    time: number;
    viaDrag?: boolean;
}

Hierarchy (View Summary)

Properties

ctrlKey id metaKey modifiers paneIndex point pointerType pressure price shiftKey time viaDrag?

Properties

ctrlKey

ctrlKey: boolean

Deprecated

Removed in 3.0.0. Read modifiers.ctrl (since 2.0.0), which carries the same state.

id

id: null | string

externalId of the hit primitive, or null on empty plot.

metaKey

metaKey: boolean

Deprecated

Removed in 3.0.0. Read modifiers.meta (since 2.0.0), which carries the same state.

modifiers

modifiers: PointerModifiers

paneIndex

paneIndex: number

point

point: { x: number; y: number }

Press position: container media x, pane-local media y.

pointerType

pointerType: PointerKind

pressure

pressure: number

price

price: null | number

Price under the press on that pane, or null off the plot.

shiftKey

shiftKey: boolean

Shift at the click: the same state as modifiers.shift, in the flat form the first click payloads carried.

Deprecated

Removed in 3.0.0. Read modifiers.shift (since 2.0.0), which carries the same state.

time

time: number

UTC seconds under the press, interpolated between bars and past the right edge.

OptionalviaDrag

viaDrag?: boolean

Set on the release half of a press-drag-release while a host is placing a shape.

Settings

Member Visibility

On This Page

Properties