minerva-design 1.3.0 → 1.5.0

package/dist/taro/charts.d.ts

@@ -1,6 +1,6 @@
 import { CSSProperties } from 'react';
-import { CanvasChartInstance, ChartAnnotation, ChartAxisOptions, ChartHoverEvent, ChartInteractionOptions, ChartLegendOptions, ChartPadding, ChartPlotClickEvent, ChartSeries, ChartTooltipOptions, ChartView, QuadrantConfig, QuadrantCorner, QuadrantPoint } from '../charts/core.js';
-export type { CanvasChartInstance, ChartAnnotation, ChartAxisOptions, ChartDragEvent, ChartHoverEvent, ChartHoverItem, ChartInteractionOptions, ChartLegendOptions, ChartOptions, ChartPadding, ChartPlotClickEvent, ChartSeries, ChartThemeInput, ChartTooltipOptions, ChartView, QuadrantAxisLabels, QuadrantConfig, QuadrantCorner, QuadrantPoint, QuadrantRegion, QuadrantRegions, } from '../charts/core.js';
+import { BinOptions, BoxplotGroup, BoxplotStatsOptions, BubbleOptions, CanvasChartInstance, ChartAnnotation, ChartAxisOptions, ChartCurve, ChartHoverEvent, ChartInteractionOptions, ChartLabels, ChartLegendOptions, ChartOrientation, ChartPadding, ChartPlotClickEvent, ChartSeries, ChartTooltipOptions, ChartView, GanttOptions, GanttTask, HeatmapConfig, QuadrantConfig, QuadrantCorner, QuadrantPoint, SparklineConfig, WaterfallOptions, WaterfallStep } from '../charts/core.js';
+export type { BinOptions, BoxplotGroup, BoxplotStatsOptions, BubbleOptions, CanvasChartInstance, ChartAnnotation, ChartAxisOptions, ChartCurve, ChartDragEvent, ChartHoverEvent, ChartHoverItem, ChartInteractionOptions, ChartLabels, ChartLegendOptions, ChartOptions, ChartOrientation, ChartPadding, ChartPlotClickEvent, ChartSeries, ChartThemeInput, ChartTooltipOptions, ChartView, GanttOptions, GanttTask, HeatmapCell, HeatmapConfig, QuadrantAxisLabels, QuadrantConfig, QuadrantCorner, QuadrantPoint, QuadrantRegion, QuadrantRegions, SparklineConfig, WaterfallOptions, WaterfallStep, } from '../charts/core.js';
 /** Imperative handle of the chart components (`ref`) */
 export interface ChartHandle {
     /** Shows the whole data range */
@@ -49,6 +49,15 @@ 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).
+     * Mini-programs have no `<html lang>`: pass the app language
+     * @default the system language (`navigator.language` when there is one), else English
+     */
+    locale?: string;
+    /** Overrides of the built-in texts of the `locale` */
+    labels?: Partial<ChartLabels>;
     /**
      * Keeps the page from scrolling while a finger moves on the chart
      * (needed to pan a zoomed chart or drag points)
@@ -70,10 +79,22 @@ export interface ChartCommonProps {
     /** Id of the `<Canvas>` (generated by default) */
     id?: string;
 }
-/** Props of Chart: any mix of line, area, bar and scatter 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[];
+    /** Right value axis of the series with `yAxis: "right"` (dual axis charts) */
+    yAxis2?: ChartAxisOptions;
+    /**
+     * `percent` scales every stack to 100% at each x
+     * @default "normal"
+     */
+    stackMode?: "normal" | "percent";
+    /**
+     * `horizontal` puts the x axis (categories) down the left side
+     * @default "vertical"
+     */
+    orientation?: ChartOrientation;
 }
 /** Props of LineChart */
 export interface LineChartProps extends ChartCommonProps {
@@ -100,6 +121,168 @@ export interface ScatterChartProps extends ChartCommonProps {
     /** Series drawn as dots unless they set a `type` */
     series: readonly ChartSeries[];
 }
+/** Props of AreaChart */
+export interface AreaChartProps extends ChartCommonProps {
+    /** Series drawn as areas unless they set a `type` */
+    series: readonly ChartSeries[];
+    /**
+     * Shape of the edges: straight, smooth (monotone) or steps
+     * @default "smooth"
+     */
+    curve?: ChartCurve;
+    /**
+     * Stacks the areas on top of each other
+     * @default false
+     */
+    stacked?: boolean;
+    /**
+     * Scales the stacks to 100% (implies `stacked`)
+     * @default false
+     */
+    percent?: boolean;
+}
+/** Props of HorizontalBarChart */
+export interface HorizontalBarChartProps extends Omit<ChartCommonProps, "labels"> {
+    /**
+     * Series drawn as bars from the left unless they set a `type`; the x
+     * values (categories) run from top to bottom
+     */
+    series: readonly ChartSeries[];
+    /**
+     * Stacks the bars of every series
+     * @default false
+     */
+    stacked?: boolean;
+    /**
+     * Scales the stacks to 100% (implies `stacked`)
+     * @default false
+     */
+    percent?: boolean;
+    /**
+     * Writes the value at the end of every bar
+     * @default false
+     */
+    labels?: boolean;
+}
+/** Props of CandlestickChart */
+export interface CandlestickChartProps extends ChartCommonProps {
+    /**
+     * Series drawn as candles unless they set a `type` (e.g. a moving average
+     * `line`); data points carry `open`, `high`, `low` and `y` (the close)
+     */
+    series: readonly ChartSeries[];
+}
+/** Props of HeatmapChart */
+export interface HeatmapChartProps extends Omit<ChartCommonProps, "crosshair">, HeatmapConfig {
+}
+/** Props of Sparkline */
+export interface SparklineProps extends Pick<ChartCommonProps, "width" | "tooltip" | "palette" | "ariaLabel" | "locale" | "labels" | "onHover" | "className" | "style" | "id">, SparklineConfig {
+    /**
+     * Height of the sparkline; numbers are pixels
+     * @default 48
+     */
+    height?: number | string;
+}
+/** 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`
+     */
+    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;
+    /**
+     * Outliers drawn as rings of the series color or as filled dots (series
+     * may set their own `outlierShape`)
+     * @default "hollow"
+     */
+    outlierShape?: "hollow" | "filled";
+    /**
+     * Diameter of the outliers in pixels
+     * @default 7
+     */
+    outlierSize?: number;
+}
+/** 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;
+}
 /** Where a dragged QuadrantChart point was dropped */
 export interface QuadrantDropTarget {
     /** Data coordinates of the drop */
@@ -128,7 +311,7 @@ export interface QuadrantChartProps extends Omit<ChartCommonProps, "onPointClick
      */
     disableScroll?: boolean;
 }
-/** Chart mixing line, area, bar and scatter series (each sets its `type`) */
+/** Chart mixing line, area, bar, scatter, candlestick, heatmap and box plot series (each sets its `type`) */
 export declare const Chart: import('react').ForwardRefExoticComponent<ChartProps & import('react').RefAttributes<ChartHandle>>;
 /** Line (or area) chart */
 export declare const LineChart: import('react').ForwardRefExoticComponent<LineChartProps & import('react').RefAttributes<ChartHandle>>;
@@ -142,3 +325,45 @@ export declare const ScatterChart: import('react').ForwardRefExoticComponent<Sca
  * overlapping labels. Dots can be dragged to another quadrant.
  */
 export declare const QuadrantChart: import('react').ForwardRefExoticComponent<QuadrantChartProps & import('react').RefAttributes<ChartHandle>>;
+/** Area chart: smooth by default, stacked or 100% stacked */
+export declare const AreaChart: import('react').ForwardRefExoticComponent<AreaChartProps & import('react').RefAttributes<ChartHandle>>;
+/**
+ * Horizontal bar chart: categories down the left side, values from the
+ * left (rankings, long names, surveys, stacked progress)
+ */
+export declare const HorizontalBarChart: import('react').ForwardRefExoticComponent<HorizontalBarChartProps & import('react').RefAttributes<ChartHandle>>;
+/** Candlestick (OHLC) chart: rising and falling candles, pinch to zoom */
+export declare const CandlestickChart: import('react').ForwardRefExoticComponent<CandlestickChartProps & import('react').RefAttributes<ChartHandle>>;
+/** Heatmap: a grid of cells colored by value (categories or numbers on both axes) */
+export declare const HeatmapChart: import('react').ForwardRefExoticComponent<HeatmapChartProps & import('react').RefAttributes<ChartHandle>>;
+/** Word-sized chart without axes: a trend in a list row, a KPI card, ... */
+export declare const Sparkline: import('react').ForwardRefExoticComponent<SparklineProps & import('react').RefAttributes<ChartHandle>>;
+/**
+ * Range area chart: bands between a lower (`y0`) and an upper edge
+ * (confidence intervals, min-max ranges), mixable with lines
+ */
+export declare const RangeAreaChart: import('react').ForwardRefExoticComponent<RangeAreaChartProps & import('react').RefAttributes<ChartHandle>>;
+/**
+ * Combination chart: bars, lines and areas on one or two value axes
+ * (`yAxis: "right"` series use `yAxis2`)
+ */
+export declare const MixedChart: import('react').ForwardRefExoticComponent<MixedChartProps & import('react').RefAttributes<ChartHandle>>;
+/** Bubble chart: x, y and a value sized by area (√value diameters) */
+export declare const BubbleChart: import('react').ForwardRefExoticComponent<BubbleChartProps & import('react').RefAttributes<ChartHandle>>;
+/** Histogram: the distribution of raw samples in bins of equal width */
+export declare const HistogramChart: import('react').ForwardRefExoticComponent<HistogramChartProps & import('react').RefAttributes<ChartHandle>>;
+/**
+ * Box plot: medians, quartiles, whiskers and outliers of samples, from raw
+ * values (`groups`) or computed statistics (`series`)
+ */
+export declare const BoxPlotChart: import('react').ForwardRefExoticComponent<BoxPlotChartProps & import('react').RefAttributes<ChartHandle>>;
+/**
+ * Waterfall (bridge) chart: how changes take a value from a start to an
+ * end, with subtotals and totals
+ */
+export declare const WaterfallChart: import('react').ForwardRefExoticComponent<WaterfallChartProps & import('react').RefAttributes<ChartHandle>>;
+/**
+ * Gantt chart: tasks as bars on a time axis with their progress, groups,
+ * milestones and a today line; pinch to zoom along the time
+ */
+export declare const GanttChart: import('react').ForwardRefExoticComponent<GanttChartProps & import('react').RefAttributes<ChartHandle>>;

package/dist/taro/index.d.ts

@@ -7,3 +7,4 @@ export * from './data.js';
 export * from './theme.js';
 export * from './date-picker.js';
 export * from './charts.js';
+export * from './shape-charts.js';