Types

Interfaces and type aliases exported by @reincharts/core.

import type { Accessor, AxisRegistration, ChartEventMap, ... } from "@reincharts/core";

Accessor

A field name or a function reading a value from a datum, e.g. "close" or (d) => d.close.

type Accessor<T, R = number> = keyof T | ((d: T, index: number) => R);

AxisRegistration

Prop

Type

ChartEventMap

Prop

Type

ChartEventType

type ChartEventType =
    | "pointerdown"
    | "pointermove"
    | "pointerup"
    | "pointerleave"
    | "drag"
    | "dragend"
    | "click"
    | "dblclick"
    | "contextmenu";

ChartOptions

Prop

Type

ChartPointerEvent

Prop

Type

ChartState

Immutable snapshot consumed by React (useChartState).

Prop

Type

Clamp

type Clamp =
    boolean | "left" | "right" | "both" | ((range: [number, number], data: [number, number]) => [number, number]);

CrosshairState

Prop

Type

DeepPartial

type DeepPartial<T> = {
    [K in keyof T]?: T[K] extends readonly unknown[] ? T[K] : T[K] extends object ? DeepPartial<T[K]> : T[K];
};

DrawScope

Everything a renderable needs to draw one frame.

Prop

Type

Functor

A static value or a function of the datum, e.g. a color.

type Functor<T, R> = R | ((d: T, index: number) => R);

HitTarget

Prop

Type

HitTargetSpec

Prop

Type

LabelOptions

Prop

Type

Layer

type Layer = "scene" | "top";

Layout

Prop

Type

LegendItem

Prop

Type

LegendValue

Prop

Type

LineDash

Canvas helpers shared by series, axes, coordinates and drawings.

type LineDash = "solid" | "dashed" | "dotted" | "longDash" | readonly number[];

PaneLayout

Prop

Type

PaneOptions

Prop

Type

PriceScaleMode

type PriceScaleMode = "linear" | "log" | "percent" | "indexed";

PriceScaleOptions

Prop

Type

PriceTick

Prop

Type

Region

type Region =
    | { type: "plot"; paneId: string }
    | { type: "priceAxis"; paneId: string; side: "left" | "right" }
    | { type: "timeAxis" }
    | { type: "separator"; paneId: string }
    | { type: "none" };

Renderable

Prop

Type

RenderableSpec

Prop

Type

StrokeStyle

Prop

Type

Theme

Visual theme shared by every Reincharts component. Components read their default colors from it.

Prop

Type

TimeFormatterOptions

Prop

Type

TimeParts

Prop

Type

TimeTick

Prop

Type

VisibleRange

Prop

Type

XMode

type XMode = "index" | "linear";

XType

type XType = "time" | "number" | "category";

ZoomAnchor

type ZoomAnchor = "mouse" | "right" | "lastVisible";

On this page