Interface: D3PProbeHit ​

Defined in: core/probe.ts:14

What a renderer finds under the pointer: the data tooltips show and markers highlight.

Properties ​

base? ​

ts
base?: number;

Defined in: core/probe.ts:36

Where the point starts, for renderers that draw between two values (a range area, a layer of a stack).

cell? ​

ts
cell?: object;

Defined in: core/probe.ts:46

The cell under the pointer in range units (a bar, a heatmap cell), for markers that outline it.

a0 ​

ts
a0: number;

a1 ​

ts
a1: number;

b0 ​

ts
b0: number;

b1 ​

ts
b1: number;

color ​

ts
color: string;

Defined in: core/probe.ts:26

Color of the point in the tooltip.

fields? ​

ts
fields?: object[];

Defined in: core/probe.ts:34

Every value column of the point, in the order of the series' input, when it has several.

format ​

ts
format: (v) => string;
Parameters ​
v ​

any

Returns ​

string

name ​

ts
name: string;

value ​

ts
value: unknown;

index? ​

ts
index?: number;

Defined in: core/probe.ts:38

Index of the data point in the series, for renderers that draw from one.

key? ​

ts
key?: string;

Defined in: core/probe.ts:40

Which part of the renderer was hit (the key of a slice, a stage).

label? ​

ts
label?: string;

Defined in: core/probe.ts:28

What to call the point in the tooltip (a slice's name); default: the renderer's name.

percent? ​

ts
percent?: number;

Defined in: core/probe.ts:30

Share of a total (0 to 1), when the renderer splits one.

range? ​

ts
range?: [number, number];

Defined in: core/probe.ts:44

The position of the hit in range units, along with system.

renderer ​

ts
renderer: D3PSeriesRenderer;

Defined in: core/probe.ts:16

The renderer that was hit.

system? ​

ts
system?: D3PCoordinateSystem<any>;

Defined in: core/probe.ts:42

System of the hit and its position in range units; the tooltip anchors there. Without them it follows the pointer.

value? ​

ts
value?: number;

Defined in: core/probe.ts:32

What to show as the value when it is not y (a stack positions its marker at the top of the layer).

x ​

ts
x: D3PDomainValue;

Defined in: core/probe.ts:18

Data point values (domain space), or a category and its magnitude for renderers without axes.

xFormatter ​

ts
xFormatter: (v) => string;

Defined in: core/probe.ts:22

Writes the x value.

Parameters ​

v ​

any

Returns ​

string

y ​

ts
y: number;

Defined in: core/probe.ts:20

The value of the point.

yFormatter ​

ts
yFormatter: (v) => string;

Defined in: core/probe.ts:24

Writes the y value.

Parameters ​

v ​

any

Returns ​

string