Types
Interfaces and type aliases exported by @reincharts/series.
import type { BarColor, BarLayout, BarStyleProps, ... } from "@reincharts/series";BarColor
A static color or a function of the datum (and theme), e.g. up/down volume colors.
type BarColor<T> = string | ((d: T, index: number, theme: Theme) => string);BarLayout
type BarLayout = "single" | "grouped" | "stacked" | "overlay";BarStyleProps
Props shared by every bar series.
Prop
Type
BrickDatum
A brick / box produced by the renko or line break transforms (one datum per brick):
{ date, open, close, fullyFormed? }. A brick is "up" when close >= open. fullyFormed: false
marks the last, still forming renko brick. Extra fields (high, low, volume, from, to...) are ignored.
Prop
Type
Curve
Line interpolation between points.
type Curve = "linear" | "step" | "stepAfter" | "stepBefore" | "monotone";KagiDatum
One vertical kagi line, as produced by the kagi transform. The line runs from
open to close; it starts as startAs and, when it breaks the previous peak / trough, switches
to changeTo at price changePoint. Consecutive lines are joined by a horizontal shoulder / waist at
the next line's open (= this line's close). Extra fields (high, low, volume, current, reverseAt...) are ignored.
Prop
Type
KagiType
type KagiType = "yang" | "yin";LegendHelpers
Passed to legendValues.
Prop
Type
Lod
Level-of-detail index for large series: min / max (and their indices) plus the first / last valid index of every block of BLOCK bars. Lets drawing and autoscale work per block instead of per bar when many bars share a pixel, so the cost of a frame depends on the chart width rather than on the size of the data.
Prop
Type
MarkerShape
Marker shapes for scatter / bubble series, SAR dots and annotations.
type MarkerShape = "circle" | "square" | "diamond" | "triangle" | "triangleDown" | "cross" | "x" | "star";MarkerStyle
Prop
Type
MultiBarProps
Prop
Type
OHLCAccessors
Prop
Type
Point
Prop
Type
PointAndFigureDatum
One point & figure column, as produced by the point & figure transform.
direction 1 is a column of X (rising), -1 a column of O (falling); boxes lists its boxes from the
first to the last, each spanning open → close (one box size). open / close are the first box's
open and the last box's close; high / low default to their max / min. Extra fields are ignored.
Prop
Type
ProfileRow
Prop
Type
SeriesProps
Props shared by every series.
Prop
Type
SeriesValues
type SeriesValues = number | readonly (number | undefined)[] | undefined;StackedValue
Lower / upper value of one stacked item.
Prop
Type
StackOptions
Prop
Type