@finchart

Appearance

Documentation / @finchart/core / index / SeriesSample

Interface: SeriesSample ​

Defined in: packages/core/src/plot/series-list.ts:24

What probe answers for one registration — raw material for tooltips and legends.

Properties ​

color ​

color: string | null

Defined in: packages/core/src/plot/series-list.ts:28

index ​

index: number

Defined in: packages/core/src/plot/series-list.ts:59

Which index the chosen point sits at in the registration's own points — the array the registration holds, which for a derived registration is the derived output, not its source. The consumer's key back to that array — the core seals off the point type so it can't hand back OHLC, but it can hand back a position: bars[sample.index] (or bricks[sample.index] under a transform). Without this the consumer has to hand-roll a binary search, and then the tooltip and the header can end up naming different bars.

max ​

max: number | null

Defined in: packages/core/src/plot/series-list.ts:40

min ​

min: number | null

Defined in: packages/core/src/plot/series-list.ts:39

That point's data value span (CoordinateAccessor.getYRange) — low and high for a candle. null for series whose accessor omits it (line, derived) — the point's value is value alone. These three are the candidates for snapping.

name ​

name: string | null

Defined in: packages/core/src/plot/series-list.ts:27

Registration metadata. null if none.

readout? ​

optional readout?: false

Defined in: packages/core/src/plot/series-list.ts:48

false when the registration is drawn for the eye and readouts should leave it out (SeriesRegistration.readout). Present only then — a readout skips sample.readout === false.

rows? ​

optional rows?: readonly SeriesRow[]

Defined in: packages/core/src/plot/series-list.ts:42

What the series says about that point — a candle's O/H/L/C/V. Absent when the series does not describe itself.

series ​

series: unknown

Defined in: packages/core/src/plot/series-list.ts:25

value ​

value: number | null

Defined in: packages/core/src/plot/series-list.ts:32

That point's value (by accessor — close, for a candle). null on a gap.

x ​

x: number

Defined in: packages/core/src/plot/series-list.ts:30

The x of the point actually hit — not the queried x. Between bars, it's the neighboring bar's.