minerva-design 1.2.0 → 1.4.0

package/dist/charts/engine/types.d.cts

@@ -1,37 +1,85 @@
 /** GPU / CPU backend that draws the data layer */
-export type ChartRendererKind = "webgpu" | "webgl2" | "canvas2d";
+export type ChartRendererKind = "webgpu" | "webgl2" | "webgl" | "canvas2d";
 /**
- * Requested backend: `auto` tries WebGPU, then WebGL2, then Canvas2D, and
- * skips GPU backends that run in software (no hardware acceleration)
+ * Requested backend: `auto` tries WebGPU, then WebGL2, then WebGL (1), then
+ * Canvas2D, and skips GPU backends that run in software (no hardware
+ * acceleration). A forced backend falls back along the same chain.
  */
 export type ChartRendererPreference = "auto" | ChartRendererKind;
 /** Scale of an axis */
 export type ChartAxisType = "linear" | "time" | "category";
 /** How a series is drawn */
-export type ChartSeriesType = "line" | "area" | "bar" | "scatter";
+export type ChartSeriesType = "line" | "area" | "bar" | "scatter" | "candlestick" | "heatmap" | "boxplot";
+/** Direction of the value axis: `horizontal` puts the x (category) axis on the left */
+export type ChartOrientation = "vertical" | "horizontal";
+/** Shape of a line (and of the edge of an area) between its points */
+export type ChartCurve = "linear" | "smooth" | "step";
 /** X value of a datum: a number, a `Date` (time axis) or a category name */
 export type ChartXValue = number | Date | string;
 /** One datum written as an object */
 export interface ChartPointDatum {
     /** X value; the datum index when omitted */
     x?: ChartXValue;
-    /** Y value; `null` leaves a gap */
-    y: number | null;
+    /**
+     * Y value; `null` leaves a gap. Candlesticks: the close. Heatmaps: the
+     * row (a number, or a category name of a `category` y axis)
+     */
+    y: number | string | null;
+    /**
+     * Start of a floating bar (waterfall steps, Gantt tasks) or lower edge of
+     * a range area (confidence bands, min-max ranges); dates are timestamps
+     */
+    y0?: number | Date | null;
     /** Diameter of the dot in CSS pixels (scatter) */
     size?: number;
-    /** Color of the dot (scatter); any CSS color */
+    /** Color of the dot or bar (scatter, bar); any CSS color */
     color?: string;
-    /** Text drawn next to the dot (scatter with `showLabels`) and shown in the tooltip */
+    /**
+     * Text drawn next to the dot (scatter with `showLabels`) or at the end of
+     * the bar instead of its value (bar with `showLabels`), and shown in the
+     * tooltip
+     */
     label?: string;
+    /** Candlestick: opening value */
+    open?: number;
+    /** Candlestick: highest value; box plot: upper whisker (the maximum) */
+    high?: number;
+    /** Candlestick: lowest value; box plot: lower whisker (the minimum) */
+    low?: number;
+    /** Box plot: first quartile (bottom of the box; `y` is the median) */
+    q1?: number;
+    /** Box plot: third quartile (top of the box) */
+    q3?: number;
+    /** Box plot: values beyond the whiskers, drawn as dots */
+    outliers?: readonly number[];
+    /**
+     * Heatmap: value of the cell, mapped to `colorScale`; scatter (bubbles):
+     * a value shown in the tooltip
+     */
+    value?: number | null;
 }
 /** Column-oriented data: the fastest form for large data sets (typed arrays are used as is) */
 export interface ChartColumnData {
     /** X values; the index when omitted */
     x?: ArrayLike<number> | readonly ChartXValue[];
-    /** Y values (`NaN` / `null` leave a gap) */
-    y: ArrayLike<number> | readonly (number | null)[];
+    /** Y values (`NaN` / `null` leave a gap); candlesticks: the closes; heatmaps: the rows */
+    y: ArrayLike<number> | readonly (number | string | null)[];
+    /** Starts of floating bars / lower edges of range areas (`NaN` / `null`: from zero) */
+    y0?: ArrayLike<number> | readonly (number | null)[];
     /** Per-point diameters in CSS pixels (scatter) */
     size?: ArrayLike<number>;
+    /** Candlestick: opening values */
+    open?: ArrayLike<number>;
+    /** Candlestick: highest values; box plots: the maximums */
+    high?: ArrayLike<number>;
+    /** Candlestick: lowest values; box plots: the minimums */
+    low?: ArrayLike<number>;
+    /** Box plots: first quartiles */
+    q1?: ArrayLike<number>;
+    /** Box plots: third quartiles */
+    q3?: ArrayLike<number>;
+    /** Heatmap: values of the cells; scatter: values shown in the tooltip */
+    value?: ArrayLike<number> | readonly (number | null)[];
 }
 /**
  * Data of a series: y values only (`[3, 5, 2]`, typed arrays included),
@@ -65,17 +113,60 @@ export interface ChartSeries {
     pointSize?: number;
     /** Fill opacity (area, scatter), 0-1 */
     opacity?: number;
-    /** Bars with the same stack id are stacked */
+    /**
+     * Series with the same stack id are stacked (bars, areas and lines; see
+     * `stackMode` for 100% stacks)
+     */
     stack?: string;
     /** Hides the series (it stays in the legend) */
     hidden?: boolean;
-    /** Draws the `label` of each point next to it (scatter) */
+    /**
+     * Draws the `label` of each point next to it (scatter) or the value above
+     * each bar (bar)
+     */
     showLabels?: boolean;
+    /**
+     * Shape of the line between the points: straight, smooth (monotone, never
+     * overshoots the data) or steps (line / area)
+     * @default "linear"
+     */
+    curve?: ChartCurve;
+    /** Candlestick: color of the rising candles (close >= open); `--success-color` by default */
+    upColor?: string;
+    /** Candlestick: color of the falling candles; `--danger-color` by default */
+    downColor?: string;
+    /**
+     * Heatmap: colors from the lowest to the highest value (two or more)
+     * @default a ramp from the background to the series color
+     */
+    colorScale?: readonly string[];
+    /** Heatmap: values mapped to the ends of `colorScale`; the data range by default */
+    valueRange?: readonly [number, number];
+    /** Bar / heatmap: corner radius in CSS pixels (bars: 3, heatmap cells: 2) */
+    radius?: number;
+    /** Formats the values of this series in the tooltip (the y axis format by default) */
+    format?: (value: number) => string;
+    /**
+     * Value axis of the series: `right` plots it against `yAxis2` (dual axis
+     * charts; vertical orientation only)
+     * @default "left"
+     */
+    yAxis?: "left" | "right";
+    /**
+     * Bars / box plots: share of the space of a category taken by the bars,
+     * 0-1 (`1` makes them touch, e.g. histograms); the widest value of the
+     * visible series is used
+     * @default 0.62 (one series), 0.78 (groups)
+     */
+    barWidth?: number;
+    /** Scatter: name of the `value` of the points in the tooltip (bubble charts) */
+    valueName?: string;
 }
 /** Options of an axis */
 export interface ChartAxisOptions {
     /**
-     * Scale of the axis: `linear` numbers, `time` timestamps / dates, `category` names
+     * Scale of the axis: `linear` numbers, `time` timestamps / dates, `category`
+     * names (x axis, and y axis of heatmaps)
      * @default "linear"
      */
     type?: ChartAxisType;
@@ -110,7 +201,15 @@ export interface ChartAxisOptions {
     reverse?: boolean;
     /** Rounds the automatic range to tick values; on by default except for category axes */
     nice?: boolean;
+    /**
+     * Calendar of a `time` axis: steps and labels of the ticks and tooltips in
+     * local time or in UTC (UTC data aligned on UTC midnights / months)
+     * @default "local"
+     */
+    timeZone?: ChartTimeZone;
 }
+/** Calendar of a time axis */
+export type ChartTimeZone = "local" | "utc";
 /** Position of an annotation label inside its area */
 export type ChartLabelPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right" | "center";
 /** Area annotation: a rectangle in data coordinates (omitted bounds extend to the plot edges) */
@@ -131,7 +230,10 @@ export interface ChartRectAnnotation {
     /** Label color (defaults to `color`) */
     labelColor?: string;
 }
-/** Reference line annotation at a value of the x or y axis */
+/**
+ * Reference line annotation at a value of the x or y axis (`y` lines are
+ * vertical in horizontal charts)
+ */
 export interface ChartLineAnnotation {
     type: "line";
     axis: "x" | "y";
@@ -205,6 +307,75 @@ export interface ChartTooltipOptions {
     mode?: "nearest" | "axis";
     /** Renders the tooltip content (a string is set as text) */
     render?: (event: ChartHoverEvent) => string | Node | null;
+    /**
+     * Names of the rows of the default tooltip; alias of the matching
+     * `ChartOptions.labels` (which win)
+     */
+    labels?: ChartTooltipLabels;
+}
+/** Row names of the default tooltip (candlesticks, box plots, ranges, bubbles) */
+export interface ChartTooltipLabels {
+    /** @default "Open" */
+    open?: string;
+    /** @default "High" */
+    high?: string;
+    /** @default "Low" */
+    low?: string;
+    /** @default "Close" */
+    close?: string;
+    /** Box plot upper whisker @default "Max" */
+    max?: string;
+    /** @default "Q3" */
+    q3?: string;
+    /** @default "Median" */
+    median?: string;
+    /** @default "Q1" */
+    q1?: string;
+    /** Box plot lower whisker @default "Min" */
+    min?: string;
+    /** Number of outliers @default "Outliers" */
+    outliers?: string;
+    /** Scatter `value` (bubbles) when the series has no `valueName` @default "Value" */
+    value?: string;
+}
+/**
+ * Texts the engine writes itself, built in for English, Chinese, Japanese
+ * and French (the language of `locale`); override any of them with
+ * `ChartOptions.labels`
+ */
+export interface ChartLabels {
+    /** Candlestick open @default "Open" */
+    open: string;
+    /** Candlestick high @default "High" */
+    high: string;
+    /** Candlestick low @default "Low" */
+    low: string;
+    /** Candlestick close @default "Close" */
+    close: string;
+    /** Box plot upper whisker @default "Max" */
+    max: string;
+    /** Box plot third quartile @default "Q3" */
+    q3: string;
+    /** Box plot median @default "Median" */
+    median: string;
+    /** Box plot first quartile @default "Q1" */
+    q1: string;
+    /** Box plot lower whisker @default "Min" */
+    min: string;
+    /** Number of outliers of a box @default "Outliers" */
+    outliers: string;
+    /** Scatter `value` (bubbles) when the series has no `valueName` @default "Value" */
+    value: string;
+    /** Tooltip row of the x of a scatter point when the axis has no title @default "x" */
+    x: string;
+    /** Tooltip row of the y of a scatter point when the axis has no title @default "y" */
+    y: string;
+    /** Default series names: `"Series 1"`, `"Series 2"`... @default "Series" */
+    series: string;
+    /** Accessible name of a chart without named series @default "Chart" */
+    chart: string;
+    /** Accessible name of a chart; `{series}` is the list of the series names @default "Chart: {series}" */
+    chartOf: string;
 }
 /** Legend options */
 export interface ChartLegendOptions {
@@ -234,6 +405,18 @@ export interface ChartOptions {
     xAxis?: ChartAxisOptions;
     /** Y axis */
     yAxis?: ChartAxisOptions;
+    /**
+     * Second value axis on the right, for the series with `yAxis: "right"`;
+     * its range is aligned on the ticks of the left axis (the grid follows
+     * the left axis). Ignored by horizontal charts
+     */
+    yAxis2?: ChartAxisOptions;
+    /**
+     * `horizontal` swaps the axes: the x axis (categories) runs down the
+     * left side, the values along the bottom (horizontal bars, Gantt charts)
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
     /**
      * Backend of the data layer
      * @default "auto"
@@ -243,7 +426,7 @@ export interface ChartOptions {
     legend?: boolean | ChartLegendOptions;
     /** Tooltip; `false` disables it */
     tooltip?: boolean | ChartTooltipOptions;
-    /** Vertical guide line following the pointer (default on for `axis` tooltips) */
+    /** Guide line following the pointer across the x axis (default on for `axis` tooltips of lines / areas) */
     crosshair?: boolean;
     /** Background areas and reference lines */
     annotations?: readonly ChartAnnotation[];
@@ -255,6 +438,21 @@ export interface ChartOptions {
     palette?: readonly string[];
     /** Accessible name of the chart */
     ariaLabel?: string;
+    /**
+     * Locale of the texts and numbers the engine writes (tooltip rows, compact
+     * units `k` / `万`, separators, month and weekday names of time axes);
+     * resolved at every options update
+     * @default the page language (`<html lang>`), else the browser language
+     */
+    locale?: string;
+    /** Overrides of the built-in texts of the `locale` */
+    labels?: Partial<ChartLabels>;
+    /**
+     * `percent` scales every stack to 100% at each x (the axis shows percents,
+     * the tooltip the actual values)
+     * @default "normal"
+     */
+    stackMode?: "normal" | "percent";
 }
 /** A point under the pointer */
 export interface ChartHoverItem {
@@ -268,6 +466,20 @@ export interface ChartHoverItem {
     /** Resolved color of the point */
     color: string;
     label?: string;
+    /** Candlestick: open / high / low (`y` is the close) */
+    open?: number;
+    high?: number;
+    low?: number;
+    /** Heatmap: value of the cell; scatter: the `value` of the point (bubbles) */
+    value?: number;
+    /** Floating bars / range areas: the start (or lower edge); `y` is the end */
+    y0?: number;
+    /** Box plot: first quartile (`y` is the median, `low` / `high` the whiskers) */
+    q1?: number;
+    /** Box plot: third quartile */
+    q3?: number;
+    /** Box plot: number of outliers */
+    outliers?: number;
 }
 /** Hover / click payload */
 export interface ChartHoverEvent {

package/dist/charts/engine/types.d.ts

@@ -1,37 +1,85 @@
 /** GPU / CPU backend that draws the data layer */
-export type ChartRendererKind = "webgpu" | "webgl2" | "canvas2d";
+export type ChartRendererKind = "webgpu" | "webgl2" | "webgl" | "canvas2d";
 /**
- * Requested backend: `auto` tries WebGPU, then WebGL2, then Canvas2D, and
- * skips GPU backends that run in software (no hardware acceleration)
+ * Requested backend: `auto` tries WebGPU, then WebGL2, then WebGL (1), then
+ * Canvas2D, and skips GPU backends that run in software (no hardware
+ * acceleration). A forced backend falls back along the same chain.
  */
 export type ChartRendererPreference = "auto" | ChartRendererKind;
 /** Scale of an axis */
 export type ChartAxisType = "linear" | "time" | "category";
 /** How a series is drawn */
-export type ChartSeriesType = "line" | "area" | "bar" | "scatter";
+export type ChartSeriesType = "line" | "area" | "bar" | "scatter" | "candlestick" | "heatmap" | "boxplot";
+/** Direction of the value axis: `horizontal` puts the x (category) axis on the left */
+export type ChartOrientation = "vertical" | "horizontal";
+/** Shape of a line (and of the edge of an area) between its points */
+export type ChartCurve = "linear" | "smooth" | "step";
 /** X value of a datum: a number, a `Date` (time axis) or a category name */
 export type ChartXValue = number | Date | string;
 /** One datum written as an object */
 export interface ChartPointDatum {
     /** X value; the datum index when omitted */
     x?: ChartXValue;
-    /** Y value; `null` leaves a gap */
-    y: number | null;
+    /**
+     * Y value; `null` leaves a gap. Candlesticks: the close. Heatmaps: the
+     * row (a number, or a category name of a `category` y axis)
+     */
+    y: number | string | null;
+    /**
+     * Start of a floating bar (waterfall steps, Gantt tasks) or lower edge of
+     * a range area (confidence bands, min-max ranges); dates are timestamps
+     */
+    y0?: number | Date | null;
     /** Diameter of the dot in CSS pixels (scatter) */
     size?: number;
-    /** Color of the dot (scatter); any CSS color */
+    /** Color of the dot or bar (scatter, bar); any CSS color */
     color?: string;
-    /** Text drawn next to the dot (scatter with `showLabels`) and shown in the tooltip */
+    /**
+     * Text drawn next to the dot (scatter with `showLabels`) or at the end of
+     * the bar instead of its value (bar with `showLabels`), and shown in the
+     * tooltip
+     */
     label?: string;
+    /** Candlestick: opening value */
+    open?: number;
+    /** Candlestick: highest value; box plot: upper whisker (the maximum) */
+    high?: number;
+    /** Candlestick: lowest value; box plot: lower whisker (the minimum) */
+    low?: number;
+    /** Box plot: first quartile (bottom of the box; `y` is the median) */
+    q1?: number;
+    /** Box plot: third quartile (top of the box) */
+    q3?: number;
+    /** Box plot: values beyond the whiskers, drawn as dots */
+    outliers?: readonly number[];
+    /**
+     * Heatmap: value of the cell, mapped to `colorScale`; scatter (bubbles):
+     * a value shown in the tooltip
+     */
+    value?: number | null;
 }
 /** Column-oriented data: the fastest form for large data sets (typed arrays are used as is) */
 export interface ChartColumnData {
     /** X values; the index when omitted */
     x?: ArrayLike<number> | readonly ChartXValue[];
-    /** Y values (`NaN` / `null` leave a gap) */
-    y: ArrayLike<number> | readonly (number | null)[];
+    /** Y values (`NaN` / `null` leave a gap); candlesticks: the closes; heatmaps: the rows */
+    y: ArrayLike<number> | readonly (number | string | null)[];
+    /** Starts of floating bars / lower edges of range areas (`NaN` / `null`: from zero) */
+    y0?: ArrayLike<number> | readonly (number | null)[];
     /** Per-point diameters in CSS pixels (scatter) */
     size?: ArrayLike<number>;
+    /** Candlestick: opening values */
+    open?: ArrayLike<number>;
+    /** Candlestick: highest values; box plots: the maximums */
+    high?: ArrayLike<number>;
+    /** Candlestick: lowest values; box plots: the minimums */
+    low?: ArrayLike<number>;
+    /** Box plots: first quartiles */
+    q1?: ArrayLike<number>;
+    /** Box plots: third quartiles */
+    q3?: ArrayLike<number>;
+    /** Heatmap: values of the cells; scatter: values shown in the tooltip */
+    value?: ArrayLike<number> | readonly (number | null)[];
 }
 /**
  * Data of a series: y values only (`[3, 5, 2]`, typed arrays included),
@@ -65,17 +113,60 @@ export interface ChartSeries {
     pointSize?: number;
     /** Fill opacity (area, scatter), 0-1 */
     opacity?: number;
-    /** Bars with the same stack id are stacked */
+    /**
+     * Series with the same stack id are stacked (bars, areas and lines; see
+     * `stackMode` for 100% stacks)
+     */
     stack?: string;
     /** Hides the series (it stays in the legend) */
     hidden?: boolean;
-    /** Draws the `label` of each point next to it (scatter) */
+    /**
+     * Draws the `label` of each point next to it (scatter) or the value above
+     * each bar (bar)
+     */
     showLabels?: boolean;
+    /**
+     * Shape of the line between the points: straight, smooth (monotone, never
+     * overshoots the data) or steps (line / area)
+     * @default "linear"
+     */
+    curve?: ChartCurve;
+    /** Candlestick: color of the rising candles (close >= open); `--success-color` by default */
+    upColor?: string;
+    /** Candlestick: color of the falling candles; `--danger-color` by default */
+    downColor?: string;
+    /**
+     * Heatmap: colors from the lowest to the highest value (two or more)
+     * @default a ramp from the background to the series color
+     */
+    colorScale?: readonly string[];
+    /** Heatmap: values mapped to the ends of `colorScale`; the data range by default */
+    valueRange?: readonly [number, number];
+    /** Bar / heatmap: corner radius in CSS pixels (bars: 3, heatmap cells: 2) */
+    radius?: number;
+    /** Formats the values of this series in the tooltip (the y axis format by default) */
+    format?: (value: number) => string;
+    /**
+     * Value axis of the series: `right` plots it against `yAxis2` (dual axis
+     * charts; vertical orientation only)
+     * @default "left"
+     */
+    yAxis?: "left" | "right";
+    /**
+     * Bars / box plots: share of the space of a category taken by the bars,
+     * 0-1 (`1` makes them touch, e.g. histograms); the widest value of the
+     * visible series is used
+     * @default 0.62 (one series), 0.78 (groups)
+     */
+    barWidth?: number;
+    /** Scatter: name of the `value` of the points in the tooltip (bubble charts) */
+    valueName?: string;
 }
 /** Options of an axis */
 export interface ChartAxisOptions {
     /**
-     * Scale of the axis: `linear` numbers, `time` timestamps / dates, `category` names
+     * Scale of the axis: `linear` numbers, `time` timestamps / dates, `category`
+     * names (x axis, and y axis of heatmaps)
      * @default "linear"
      */
     type?: ChartAxisType;
@@ -110,7 +201,15 @@ export interface ChartAxisOptions {
     reverse?: boolean;
     /** Rounds the automatic range to tick values; on by default except for category axes */
     nice?: boolean;
+    /**
+     * Calendar of a `time` axis: steps and labels of the ticks and tooltips in
+     * local time or in UTC (UTC data aligned on UTC midnights / months)
+     * @default "local"
+     */
+    timeZone?: ChartTimeZone;
 }
+/** Calendar of a time axis */
+export type ChartTimeZone = "local" | "utc";
 /** Position of an annotation label inside its area */
 export type ChartLabelPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right" | "center";
 /** Area annotation: a rectangle in data coordinates (omitted bounds extend to the plot edges) */
@@ -131,7 +230,10 @@ export interface ChartRectAnnotation {
     /** Label color (defaults to `color`) */
     labelColor?: string;
 }
-/** Reference line annotation at a value of the x or y axis */
+/**
+ * Reference line annotation at a value of the x or y axis (`y` lines are
+ * vertical in horizontal charts)
+ */
 export interface ChartLineAnnotation {
     type: "line";
     axis: "x" | "y";
@@ -205,6 +307,75 @@ export interface ChartTooltipOptions {
     mode?: "nearest" | "axis";
     /** Renders the tooltip content (a string is set as text) */
     render?: (event: ChartHoverEvent) => string | Node | null;
+    /**
+     * Names of the rows of the default tooltip; alias of the matching
+     * `ChartOptions.labels` (which win)
+     */
+    labels?: ChartTooltipLabels;
+}
+/** Row names of the default tooltip (candlesticks, box plots, ranges, bubbles) */
+export interface ChartTooltipLabels {
+    /** @default "Open" */
+    open?: string;
+    /** @default "High" */
+    high?: string;
+    /** @default "Low" */
+    low?: string;
+    /** @default "Close" */
+    close?: string;
+    /** Box plot upper whisker @default "Max" */
+    max?: string;
+    /** @default "Q3" */
+    q3?: string;
+    /** @default "Median" */
+    median?: string;
+    /** @default "Q1" */
+    q1?: string;
+    /** Box plot lower whisker @default "Min" */
+    min?: string;
+    /** Number of outliers @default "Outliers" */
+    outliers?: string;
+    /** Scatter `value` (bubbles) when the series has no `valueName` @default "Value" */
+    value?: string;
+}
+/**
+ * Texts the engine writes itself, built in for English, Chinese, Japanese
+ * and French (the language of `locale`); override any of them with
+ * `ChartOptions.labels`
+ */
+export interface ChartLabels {
+    /** Candlestick open @default "Open" */
+    open: string;
+    /** Candlestick high @default "High" */
+    high: string;
+    /** Candlestick low @default "Low" */
+    low: string;
+    /** Candlestick close @default "Close" */
+    close: string;
+    /** Box plot upper whisker @default "Max" */
+    max: string;
+    /** Box plot third quartile @default "Q3" */
+    q3: string;
+    /** Box plot median @default "Median" */
+    median: string;
+    /** Box plot first quartile @default "Q1" */
+    q1: string;
+    /** Box plot lower whisker @default "Min" */
+    min: string;
+    /** Number of outliers of a box @default "Outliers" */
+    outliers: string;
+    /** Scatter `value` (bubbles) when the series has no `valueName` @default "Value" */
+    value: string;
+    /** Tooltip row of the x of a scatter point when the axis has no title @default "x" */
+    x: string;
+    /** Tooltip row of the y of a scatter point when the axis has no title @default "y" */
+    y: string;
+    /** Default series names: `"Series 1"`, `"Series 2"`... @default "Series" */
+    series: string;
+    /** Accessible name of a chart without named series @default "Chart" */
+    chart: string;
+    /** Accessible name of a chart; `{series}` is the list of the series names @default "Chart: {series}" */
+    chartOf: string;
 }
 /** Legend options */
 export interface ChartLegendOptions {
@@ -234,6 +405,18 @@ export interface ChartOptions {
     xAxis?: ChartAxisOptions;
     /** Y axis */
     yAxis?: ChartAxisOptions;
+    /**
+     * Second value axis on the right, for the series with `yAxis: "right"`;
+     * its range is aligned on the ticks of the left axis (the grid follows
+     * the left axis). Ignored by horizontal charts
+     */
+    yAxis2?: ChartAxisOptions;
+    /**
+     * `horizontal` swaps the axes: the x axis (categories) runs down the
+     * left side, the values along the bottom (horizontal bars, Gantt charts)
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
     /**
      * Backend of the data layer
      * @default "auto"
@@ -243,7 +426,7 @@ export interface ChartOptions {
     legend?: boolean | ChartLegendOptions;
     /** Tooltip; `false` disables it */
     tooltip?: boolean | ChartTooltipOptions;
-    /** Vertical guide line following the pointer (default on for `axis` tooltips) */
+    /** Guide line following the pointer across the x axis (default on for `axis` tooltips of lines / areas) */
     crosshair?: boolean;
     /** Background areas and reference lines */
     annotations?: readonly ChartAnnotation[];
@@ -255,6 +438,21 @@ export interface ChartOptions {
     palette?: readonly string[];
     /** Accessible name of the chart */
     ariaLabel?: string;
+    /**
+     * Locale of the texts and numbers the engine writes (tooltip rows, compact
+     * units `k` / `万`, separators, month and weekday names of time axes);
+     * resolved at every options update
+     * @default the page language (`<html lang>`), else the browser language
+     */
+    locale?: string;
+    /** Overrides of the built-in texts of the `locale` */
+    labels?: Partial<ChartLabels>;
+    /**
+     * `percent` scales every stack to 100% at each x (the axis shows percents,
+     * the tooltip the actual values)
+     * @default "normal"
+     */
+    stackMode?: "normal" | "percent";
 }
 /** A point under the pointer */
 export interface ChartHoverItem {
@@ -268,6 +466,20 @@ export interface ChartHoverItem {
     /** Resolved color of the point */
     color: string;
     label?: string;
+    /** Candlestick: open / high / low (`y` is the close) */
+    open?: number;
+    high?: number;
+    low?: number;
+    /** Heatmap: value of the cell; scatter: the `value` of the point (bubbles) */
+    value?: number;
+    /** Floating bars / range areas: the start (or lower edge); `y` is the end */
+    y0?: number;
+    /** Box plot: first quartile (`y` is the median, `low` / `high` the whiskers) */
+    q1?: number;
+    /** Box plot: third quartile */
+    q3?: number;
+    /** Box plot: number of outliers */
+    outliers?: number;
 }
 /** Hover / click payload */
 export interface ChartHoverEvent {

package/dist/charts/index.cjs

@@ -1 +1 @@
-"use client";Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./engine/format.cjs"),t=require("./engine/chart.cjs"),n=require("./react/Chart.cjs"),r=require("./engine/presets.cjs"),i=require("./react/charts.cjs"),a=require("./engine/controller.cjs"),o=require("./engine/canvas.cjs");require("./core.cjs"),exports.BarChart=i.BarChart,exports.Chart=n.Chart,exports.LineChart=i.LineChart,exports.QuadrantChart=i.QuadrantChart,exports.ScatterChart=i.ScatterChart,exports.createCanvasChart=o.createCanvasChart,exports.createChart=t.createChart,exports.createChartController=a.createChartController,exports.formatCompact=e.formatCompact,exports.quadrantCenter=r.quadrantCenter,exports.quadrantChartOptions=r.quadrantChartOptions,exports.quadrantOf=r.quadrantOf,exports.scenePrimitives=a.scenePrimitives;
+"use client";Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./engine/format.cjs"),t=require("./engine/chart.cjs"),n=require("./react/Chart.cjs"),r=require("./engine/presets.cjs"),i=require("./react/charts.cjs"),a=require("./engine/shapes/chart.cjs"),o=require("./react/shapes.cjs"),s=require("./engine/trading/indicators.cjs"),c=require("./engine/trading/chart.cjs"),l=require("./react/trading.cjs"),u=require("./engine/orderbook/book.cjs"),d=require("./engine/orderbook/depth.cjs"),f=require("./engine/orderbook/heatmap.cjs"),p=require("./engine/orderbook/ladder.cjs"),m=require("./engine/orderbook/tape.cjs"),h=require("./react/orderbook.cjs"),g=require("./engine/three-d/chart.cjs"),_=require("./react/three-d.cjs"),v=require("./engine/shapes/canvas.cjs"),y=require("./engine/controller.cjs"),b=require("./engine/canvas.cjs");require("./core.cjs"),exports.AreaChart=i.AreaChart,exports.Bar3DChart=_.Bar3DChart,exports.BarChart=i.BarChart,exports.BoxPlotChart=i.BoxPlotChart,exports.BubbleChart=i.BubbleChart,exports.BulletChart=o.BulletChart,exports.CalendarHeatmap=o.CalendarHeatmap,exports.CandlestickChart=i.CandlestickChart,exports.Chart=n.Chart,exports.DepthChart=h.DepthChart,exports.DonutChart=o.DonutChart,exports.FunnelChart=o.FunnelChart,exports.GanttChart=i.GanttChart,exports.GaugeChart=o.GaugeChart,exports.HeatmapChart=i.HeatmapChart,exports.HistogramChart=i.HistogramChart,exports.HorizontalBarChart=i.HorizontalBarChart,exports.Line3DChart=_.Line3DChart,exports.LineChart=i.LineChart,exports.MixedChart=i.MixedChart,exports.OrderBook=h.OrderBook,exports.OrderBookHeatmap=h.OrderBookHeatmap,exports.PieChart=o.PieChart,exports.QuadrantChart=i.QuadrantChart,exports.RadarChart=o.RadarChart,exports.RadialBarChart=o.RadialBarChart,exports.RangeAreaChart=i.RangeAreaChart,exports.SankeyChart=o.SankeyChart,exports.Scatter3DChart=_.Scatter3DChart,exports.ScatterChart=i.ScatterChart,exports.Sparkline=i.Sparkline,exports.SunburstChart=o.SunburstChart,exports.Surface3DChart=_.Surface3DChart,exports.TimeAndSales=h.TimeAndSales,exports.TradingChart=l.TradingChart,exports.TreemapChart=o.TreemapChart,exports.WaterfallChart=i.WaterfallChart,exports.areaSeries=r.areaSeries,exports.atr=s.atr,exports.barSeries=r.barSeries,exports.binValues=r.binValues,exports.bollinger=s.bollinger,exports.boxplotData=r.boxplotData,exports.boxplotSeries=r.boxplotSeries,exports.boxplotStats=r.boxplotStats,exports.bubbleSeries=r.bubbleSeries,exports.candlestickSeries=r.candlestickSeries,exports.createCanvasChart=b.createCanvasChart,exports.createCanvasShapeChart=v.createCanvasShapeChart,exports.createChart=t.createChart,exports.createChart3D=g.createChart3D,exports.createChartController=y.createChartController,exports.createDepthChart=d.createDepthChart,exports.createOrderBook=p.createOrderBook,exports.createOrderBookHeatmap=f.createOrderBookHeatmap,exports.createOrderBookStore=u.createOrderBookStore,exports.createShapeChart=a.createShapeChart,exports.createTimeAndSales=m.createTimeAndSales,exports.createTradingChart=c.createTradingChart,exports.ema=s.ema,exports.formatCompact=e.formatCompact,exports.formatValue=e.formatValue,exports.ganttSeries=r.ganttSeries,exports.heatmapChartOptions=r.heatmapChartOptions,exports.heikinAshi=s.heikinAshi,exports.histogramSeries=r.histogramSeries,exports.kdj=s.kdj,exports.lineSeries=r.lineSeries,exports.macd=s.macd,exports.quadrantCenter=r.quadrantCenter,exports.quadrantChartOptions=r.quadrantChartOptions,exports.quadrantOf=r.quadrantOf,exports.quantiles=r.quantiles,exports.rangeAreaSeries=r.rangeAreaSeries,exports.resampleBars=s.resampleBars,exports.rsi=s.rsi,exports.scatterSeries=r.scatterSeries,exports.scenePrimitives=y.scenePrimitives,exports.sma=s.sma,exports.sparklineOptions=r.sparklineOptions,exports.vwap=s.vwap,exports.waterfallSeries=r.waterfallSeries,exports.withSeriesType=r.withSeriesType,exports.wma=s.wma;