minerva-design 1.3.0 → 1.4.0

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

@@ -1,7 +1,7 @@
 import { CSSProperties, ReactNode, Ref } from 'react';
-import { ChartAnnotation, ChartAxisOptions, ChartCurve, ChartHoverEvent, ChartInstance, ChartLegendOptions, ChartInteractionOptions, ChartPadding, ChartPlotClickEvent, ChartRendererKind, ChartRendererPreference, ChartSeries, ChartTooltipOptions, ChartView } from '../engine/types.cjs';
-import { HeatmapConfig, QuadrantConfig, QuadrantCorner, QuadrantPoint, SparklineConfig } from '../engine/presets.cjs';
-export type { HeatmapCell, HeatmapConfig, QuadrantAxisLabels, QuadrantConfig, QuadrantCorner, QuadrantPoint, QuadrantRegion, QuadrantRegions, SparklineConfig, } from '../engine/presets.cjs';
+import { ChartAnnotation, ChartAxisOptions, ChartCurve, ChartHoverEvent, ChartInstance, ChartLabels, ChartLegendOptions, ChartInteractionOptions, ChartOrientation, ChartPadding, ChartPlotClickEvent, ChartRendererKind, ChartRendererPreference, ChartSeries, ChartTooltipOptions, ChartView } from '../engine/types.cjs';
+import { BinOptions, BoxplotGroup, BoxplotStatsOptions, BubbleOptions, GanttOptions, GanttTask, HeatmapConfig, QuadrantConfig, QuadrantCorner, QuadrantPoint, SparklineConfig, WaterfallOptions, WaterfallStep } from '../engine/presets.cjs';
+export type { BinOptions, BoxplotGroup, BoxplotStats, BoxplotStatsOptions, BubbleOptions, GanttOptions, GanttSeries, GanttTask, HistogramBinning, HistogramBins, HistogramSeriesOptions, WaterfallOptions, WaterfallStep, HeatmapCell, HeatmapConfig, QuadrantAxisLabels, QuadrantConfig, QuadrantCorner, QuadrantPoint, QuadrantRegion, QuadrantRegions, SparklineConfig, } from '../engine/presets.cjs';
 /** Imperative handle of the chart components (`ref`) */
 export interface ChartHandle {
     /** Shows the whole data range */
@@ -32,7 +32,7 @@ export interface ChartCommonProps {
     /** Y axis */
     yAxis?: ChartAxisOptions;
     /**
-     * Backend of the data layer: `auto` tries WebGPU, then WebGL2, then Canvas2D
+     * Backend of the data layer: `auto` tries WebGPU, then WebGL2, then WebGL, then Canvas2D
      * @default "auto"
      */
     renderer?: ChartRendererPreference;
@@ -55,6 +55,14 @@ export interface ChartCommonProps {
     palette?: readonly string[];
     /** Accessible name of the chart */
     ariaLabel?: string;
+    /**
+     * Locale of the texts and numbers the chart writes (tooltip rows, compact
+     * units `k` / `万`, separators, month and weekday names of time axes)
+     * @default the page language (`<html lang>`), else the browser language
+     */
+    locale?: string;
+    /** Overrides of the built-in texts of the `locale` */
+    labels?: Partial<ChartLabels>;
     /** Called when the hovered (or keyboard-focused) points change */
     onHover?: (event: ChartHoverEvent | null) => void;
     /** Called when a point (or bar) is clicked */
@@ -74,7 +82,7 @@ export interface ChartCommonProps {
     /** Imperative handle */
     ref?: Ref<ChartHandle>;
 }
-/** Props of Chart: any mix of line, area, bar, scatter, candlestick and heatmap series */
+/** Props of Chart: any mix of line, area, bar, scatter, candlestick, heatmap and box plot series */
 export interface ChartProps extends ChartCommonProps {
     /** Data series; each sets its own `type` */
     series: readonly ChartSeries[];
@@ -83,6 +91,17 @@ export interface ChartProps extends ChartCommonProps {
      * @default "normal"
      */
     stackMode?: "normal" | "percent";
+    /**
+     * Right value axis of the series with `yAxis: "right"`; its range is
+     * aligned on the left ticks (vertical charts)
+     */
+    yAxis2?: ChartAxisOptions;
+    /**
+     * `horizontal` puts the x axis (categories) down the left side and the
+     * values along the bottom
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
 }
 /** Props of LineChart */
 export interface LineChartProps extends ChartCommonProps {
@@ -129,8 +148,11 @@ export interface AreaChartProps extends ChartCommonProps {
      */
     percent?: boolean;
 }
-/** Props of BarChart */
-export interface BarChartProps extends ChartCommonProps {
+/**
+ * Props of BarChart (`labels` writes the values: override the tooltip texts
+ * with `tooltip.labels`)
+ */
+export interface BarChartProps extends Omit<ChartCommonProps, "labels"> {
     /** Series drawn as bars unless they set a `type` (e.g. a `line` overlay) */
     series: readonly ChartSeries[];
     /**
@@ -148,6 +170,108 @@ export interface BarChartProps extends ChartCommonProps {
      * @default false
      */
     labels?: boolean;
+    /**
+     * `horizontal` draws the bars from the left, the categories down the left side
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
+}
+/** Props of HorizontalBarChart */
+export interface HorizontalBarChartProps extends Omit<BarChartProps, "orientation"> {
+    /**
+     * Series drawn as bars from the left unless they set a `type`; the x
+     * values (categories) run from top to bottom
+     */
+    series: readonly ChartSeries[];
+}
+/** Props of RangeAreaChart */
+export interface RangeAreaChartProps extends ChartCommonProps {
+    /**
+     * Bands between `y0` (lower edge) and `y` (upper edge) of every point,
+     * unless a series sets a `type` (e.g. a `line` for the forecast itself)
+     */
+    series: readonly ChartSeries[];
+    /**
+     * Shape of the edges: straight, smooth (monotone) or steps
+     * @default "smooth"
+     */
+    curve?: ChartCurve;
+}
+/** Props of MixedChart */
+export interface MixedChartProps extends ChartProps {
+    /**
+     * Bars, lines, areas and dots, each with its `type`; `yAxis: "right"`
+     * plots a series against `yAxis2`
+     */
+    series: readonly ChartSeries[];
+}
+/** Props of BubbleChart */
+export interface BubbleChartProps extends ChartCommonProps, BubbleOptions {
+    /** Series of points with a `value` sizing their bubble (area ∝ value) */
+    series: readonly ChartSeries[];
+}
+/** Props of HistogramChart */
+export interface HistogramChartProps extends ChartCommonProps, BinOptions {
+    /** Raw samples (typed arrays are counted without copies) */
+    values: ArrayLike<number>;
+    /**
+     * Name of the counts (legend, tooltip)
+     * @default "Count"
+     */
+    name?: string;
+    /** Bar color (any CSS color) */
+    color?: string;
+    /** Formats the edges of the bins in the tooltip */
+    formatBin?: (value: number) => string;
+    /** More series drawn over the bins (e.g. a density `line`) */
+    series?: readonly ChartSeries[];
+}
+/** Props of BoxPlotChart */
+export interface BoxPlotChartProps extends ChartCommonProps, BoxplotStatsOptions {
+    /**
+     * Series of box plots: data points with `low`, `q1`, `y` (the median),
+     * `q3`, `high` and `outliers` (see `boxplotData` / `boxplotStats`)
+     */
+    series?: readonly ChartSeries[];
+    /** Raw samples, one box each (an alternative to `series`) */
+    groups?: readonly BoxplotGroup[];
+    /**
+     * Name of the series built from `groups`
+     * @default "Values"
+     */
+    name?: string;
+    /**
+     * `horizontal` lays the boxes out in rows
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
+}
+/** Props of WaterfallChart */
+export interface WaterfallChartProps extends Omit<ChartCommonProps, "crosshair" | "labels">, Omit<WaterfallOptions, "labels"> {
+    /** Changes, subtotals and totals, in order */
+    steps: readonly WaterfallStep[];
+    /**
+     * Writes the change (or the total) at the end of every bar
+     * @default true
+     */
+    labels?: boolean;
+    /**
+     * `horizontal` lays the steps out in rows
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
+}
+/** Props of GanttChart */
+export interface GanttChartProps extends Omit<ChartCommonProps, "crosshair">, GanttOptions {
+    /** Tasks and milestones, from top to bottom */
+    tasks: readonly GanttTask[];
+    /**
+     * Draws a line at this date (`true`: now)
+     * @default false
+     */
+    today?: boolean | number | Date;
+    /** Label of the today line */
+    todayLabel?: string;
 }
 /** Props of CandlestickChart */
 export interface CandlestickChartProps extends ChartCommonProps {
@@ -161,7 +285,7 @@ export interface CandlestickChartProps extends ChartCommonProps {
 export interface HeatmapChartProps extends Omit<ChartCommonProps, "crosshair">, HeatmapConfig {
 }
 /** Props of Sparkline */
-export interface SparklineProps extends Pick<ChartCommonProps, "width" | "renderer" | "tooltip" | "palette" | "ariaLabel" | "onHover" | "renderTooltip" | "className" | "style" | "ref">, SparklineConfig {
+export interface SparklineProps extends Pick<ChartCommonProps, "width" | "renderer" | "tooltip" | "palette" | "ariaLabel" | "locale" | "labels" | "onHover" | "renderTooltip" | "className" | "style" | "ref">, SparklineConfig {
     /**
      * Height of the sparkline; numbers are pixels
      * @default 48

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

@@ -1,7 +1,7 @@
 import { CSSProperties, ReactNode, Ref } from 'react';
-import { ChartAnnotation, ChartAxisOptions, ChartCurve, ChartHoverEvent, ChartInstance, ChartLegendOptions, ChartInteractionOptions, ChartPadding, ChartPlotClickEvent, ChartRendererKind, ChartRendererPreference, ChartSeries, ChartTooltipOptions, ChartView } from '../engine/types.js';
-import { HeatmapConfig, QuadrantConfig, QuadrantCorner, QuadrantPoint, SparklineConfig } from '../engine/presets.js';
-export type { HeatmapCell, HeatmapConfig, QuadrantAxisLabels, QuadrantConfig, QuadrantCorner, QuadrantPoint, QuadrantRegion, QuadrantRegions, SparklineConfig, } from '../engine/presets.js';
+import { ChartAnnotation, ChartAxisOptions, ChartCurve, ChartHoverEvent, ChartInstance, ChartLabels, ChartLegendOptions, ChartInteractionOptions, ChartOrientation, ChartPadding, ChartPlotClickEvent, ChartRendererKind, ChartRendererPreference, ChartSeries, ChartTooltipOptions, ChartView } from '../engine/types.js';
+import { BinOptions, BoxplotGroup, BoxplotStatsOptions, BubbleOptions, GanttOptions, GanttTask, HeatmapConfig, QuadrantConfig, QuadrantCorner, QuadrantPoint, SparklineConfig, WaterfallOptions, WaterfallStep } from '../engine/presets.js';
+export type { BinOptions, BoxplotGroup, BoxplotStats, BoxplotStatsOptions, BubbleOptions, GanttOptions, GanttSeries, GanttTask, HistogramBinning, HistogramBins, HistogramSeriesOptions, WaterfallOptions, WaterfallStep, HeatmapCell, HeatmapConfig, QuadrantAxisLabels, QuadrantConfig, QuadrantCorner, QuadrantPoint, QuadrantRegion, QuadrantRegions, SparklineConfig, } from '../engine/presets.js';
 /** Imperative handle of the chart components (`ref`) */
 export interface ChartHandle {
     /** Shows the whole data range */
@@ -32,7 +32,7 @@ export interface ChartCommonProps {
     /** Y axis */
     yAxis?: ChartAxisOptions;
     /**
-     * Backend of the data layer: `auto` tries WebGPU, then WebGL2, then Canvas2D
+     * Backend of the data layer: `auto` tries WebGPU, then WebGL2, then WebGL, then Canvas2D
      * @default "auto"
      */
     renderer?: ChartRendererPreference;
@@ -55,6 +55,14 @@ export interface ChartCommonProps {
     palette?: readonly string[];
     /** Accessible name of the chart */
     ariaLabel?: string;
+    /**
+     * Locale of the texts and numbers the chart writes (tooltip rows, compact
+     * units `k` / `万`, separators, month and weekday names of time axes)
+     * @default the page language (`<html lang>`), else the browser language
+     */
+    locale?: string;
+    /** Overrides of the built-in texts of the `locale` */
+    labels?: Partial<ChartLabels>;
     /** Called when the hovered (or keyboard-focused) points change */
     onHover?: (event: ChartHoverEvent | null) => void;
     /** Called when a point (or bar) is clicked */
@@ -74,7 +82,7 @@ export interface ChartCommonProps {
     /** Imperative handle */
     ref?: Ref<ChartHandle>;
 }
-/** Props of Chart: any mix of line, area, bar, scatter, candlestick and heatmap series */
+/** Props of Chart: any mix of line, area, bar, scatter, candlestick, heatmap and box plot series */
 export interface ChartProps extends ChartCommonProps {
     /** Data series; each sets its own `type` */
     series: readonly ChartSeries[];
@@ -83,6 +91,17 @@ export interface ChartProps extends ChartCommonProps {
      * @default "normal"
      */
     stackMode?: "normal" | "percent";
+    /**
+     * Right value axis of the series with `yAxis: "right"`; its range is
+     * aligned on the left ticks (vertical charts)
+     */
+    yAxis2?: ChartAxisOptions;
+    /**
+     * `horizontal` puts the x axis (categories) down the left side and the
+     * values along the bottom
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
 }
 /** Props of LineChart */
 export interface LineChartProps extends ChartCommonProps {
@@ -129,8 +148,11 @@ export interface AreaChartProps extends ChartCommonProps {
      */
     percent?: boolean;
 }
-/** Props of BarChart */
-export interface BarChartProps extends ChartCommonProps {
+/**
+ * Props of BarChart (`labels` writes the values: override the tooltip texts
+ * with `tooltip.labels`)
+ */
+export interface BarChartProps extends Omit<ChartCommonProps, "labels"> {
     /** Series drawn as bars unless they set a `type` (e.g. a `line` overlay) */
     series: readonly ChartSeries[];
     /**
@@ -148,6 +170,108 @@ export interface BarChartProps extends ChartCommonProps {
      * @default false
      */
     labels?: boolean;
+    /**
+     * `horizontal` draws the bars from the left, the categories down the left side
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
+}
+/** Props of HorizontalBarChart */
+export interface HorizontalBarChartProps extends Omit<BarChartProps, "orientation"> {
+    /**
+     * Series drawn as bars from the left unless they set a `type`; the x
+     * values (categories) run from top to bottom
+     */
+    series: readonly ChartSeries[];
+}
+/** Props of RangeAreaChart */
+export interface RangeAreaChartProps extends ChartCommonProps {
+    /**
+     * Bands between `y0` (lower edge) and `y` (upper edge) of every point,
+     * unless a series sets a `type` (e.g. a `line` for the forecast itself)
+     */
+    series: readonly ChartSeries[];
+    /**
+     * Shape of the edges: straight, smooth (monotone) or steps
+     * @default "smooth"
+     */
+    curve?: ChartCurve;
+}
+/** Props of MixedChart */
+export interface MixedChartProps extends ChartProps {
+    /**
+     * Bars, lines, areas and dots, each with its `type`; `yAxis: "right"`
+     * plots a series against `yAxis2`
+     */
+    series: readonly ChartSeries[];
+}
+/** Props of BubbleChart */
+export interface BubbleChartProps extends ChartCommonProps, BubbleOptions {
+    /** Series of points with a `value` sizing their bubble (area ∝ value) */
+    series: readonly ChartSeries[];
+}
+/** Props of HistogramChart */
+export interface HistogramChartProps extends ChartCommonProps, BinOptions {
+    /** Raw samples (typed arrays are counted without copies) */
+    values: ArrayLike<number>;
+    /**
+     * Name of the counts (legend, tooltip)
+     * @default "Count"
+     */
+    name?: string;
+    /** Bar color (any CSS color) */
+    color?: string;
+    /** Formats the edges of the bins in the tooltip */
+    formatBin?: (value: number) => string;
+    /** More series drawn over the bins (e.g. a density `line`) */
+    series?: readonly ChartSeries[];
+}
+/** Props of BoxPlotChart */
+export interface BoxPlotChartProps extends ChartCommonProps, BoxplotStatsOptions {
+    /**
+     * Series of box plots: data points with `low`, `q1`, `y` (the median),
+     * `q3`, `high` and `outliers` (see `boxplotData` / `boxplotStats`)
+     */
+    series?: readonly ChartSeries[];
+    /** Raw samples, one box each (an alternative to `series`) */
+    groups?: readonly BoxplotGroup[];
+    /**
+     * Name of the series built from `groups`
+     * @default "Values"
+     */
+    name?: string;
+    /**
+     * `horizontal` lays the boxes out in rows
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
+}
+/** Props of WaterfallChart */
+export interface WaterfallChartProps extends Omit<ChartCommonProps, "crosshair" | "labels">, Omit<WaterfallOptions, "labels"> {
+    /** Changes, subtotals and totals, in order */
+    steps: readonly WaterfallStep[];
+    /**
+     * Writes the change (or the total) at the end of every bar
+     * @default true
+     */
+    labels?: boolean;
+    /**
+     * `horizontal` lays the steps out in rows
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
+}
+/** Props of GanttChart */
+export interface GanttChartProps extends Omit<ChartCommonProps, "crosshair">, GanttOptions {
+    /** Tasks and milestones, from top to bottom */
+    tasks: readonly GanttTask[];
+    /**
+     * Draws a line at this date (`true`: now)
+     * @default false
+     */
+    today?: boolean | number | Date;
+    /** Label of the today line */
+    todayLabel?: string;
 }
 /** Props of CandlestickChart */
 export interface CandlestickChartProps extends ChartCommonProps {
@@ -161,7 +285,7 @@ export interface CandlestickChartProps extends ChartCommonProps {
 export interface HeatmapChartProps extends Omit<ChartCommonProps, "crosshair">, HeatmapConfig {
 }
 /** Props of Sparkline */
-export interface SparklineProps extends Pick<ChartCommonProps, "width" | "renderer" | "tooltip" | "palette" | "ariaLabel" | "onHover" | "renderTooltip" | "className" | "style" | "ref">, SparklineConfig {
+export interface SparklineProps extends Pick<ChartCommonProps, "width" | "renderer" | "tooltip" | "palette" | "ariaLabel" | "locale" | "labels" | "onHover" | "renderTooltip" | "className" | "style" | "ref">, SparklineConfig {
     /**
      * Height of the sparkline; numbers are pixels
      * @default 48