Skip to content

Interface: D3PMarker ​

Defined in: core/marker.ts:13

A marker shows what a renderer found under the pointer: a dot on a point, an outline around a bar, a slice pulled out. Each renderer provides a default one (or none) and can be given another; the probe of the chart calls show and hide as the pointer moves.

Methods ​

hide() ​

ts
hide(chart): void;

Defined in: core/marker.ts:19

The renderer has nothing under the pointer (or the pointer left the chart).

Parameters ​

chart ​

D3PChart

Returns ​

void


remove() ​

ts
remove(chart): void;

Defined in: core/marker.ts:21

Drop everything drawn on chart, at once.

Parameters ​

chart ​

D3PChart

Returns ​

void


show() ​

ts
show(
   chart, 
   hit, 
   event
): void;

Defined in: core/marker.ts:17

The renderer has a hit for the pointer.

Parameters ​

chart ​

D3PChart

hit ​

D3PProbeHit

event ​

D3PPointerEvent

Returns ​

void

Properties ​

interactive? ​

ts
readonly interactive?: boolean;

Defined in: core/marker.ts:15

The marker is a hover effect on its own: it asks for an interaction area, where dots wait for a tooltip or a cursor to ask.