minerva-design 1.4.0 → 1.5.0

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

@@ -2,7 +2,7 @@ import { ColorResolver, Rgba } from './color.cjs';
 import { SeriesColumns } from './data.cjs';
 import { GridIndex } from './spatial.cjs';
 import { ChartTheme } from './theme.cjs';
-import { ChartAxisType, ChartCurve, ChartOptions, ChartSeriesData, ChartLabels, ChartSeriesType, ChartTimeZone } from './types.cjs';
+import { ChartAxisType, ChartColorScheme, ChartCurve, ChartOptions, ChartSeriesData, ChartLabels, ChartSeriesType, ChartTimeZone } from './types.cjs';
 import { Range } from './viewport.cjs';
 export interface AxisModel {
     type: ChartAxisType;
@@ -67,6 +67,21 @@ export interface SeriesModel {
     /** Heatmaps: ramp of the colors and the values at its ends */
     colorScale: Rgba[];
     valueRange: Range;
+    /** Heatmaps: value at the middle of the ramp (`null`: linear over the range) */
+    colorMidpoint: number | null;
+    /** Heatmaps: 256 packed colors along the ramp (OKLab) */
+    colorLut: Uint32Array | null;
+    /** Hit tests and tooltips include the series */
+    tooltip: boolean;
+    /** Box plots: outlier rings or dots, and their diameter */
+    outlierShape: "hollow" | "filled";
+    outlierSize: number;
+    /** Bars: lines from the end of every bar to the next one */
+    connector: {
+        color: Rgba;
+        dash: number[];
+        width: number;
+    } | null;
     /** Corner radius in CSS pixels (bars, heatmap cells) */
     radius: number;
     /** Tooltip format of the values */
@@ -74,10 +89,15 @@ export interface SeriesModel {
     /** Scatter: name of the `value` of the points */
     valueName?: string;
 }
-/** Linear map of the right axis onto the left one: `left = right * scale + offset` */
+/**
+ * Map of the values of a series onto the plotted (left axis) units:
+ * `left = (log ? log10(value) : value) * scale + offset`
+ */
 export interface AxisMap {
     scale: number;
     offset: number;
+    /** Logarithmic axis: the values are plotted as their base-10 logarithm */
+    log?: boolean;
 }
 export interface ChartModel {
     series: SeriesModel[];
@@ -106,7 +126,7 @@ export interface ChartModel {
         x: boolean;
         y: boolean;
     };
-    tooltipMode: "nearest" | "axis";
+    tooltipMode: "nearest" | "axis" | "item";
     /** Y value the areas are filled to */
     baseline: number;
     /** Smallest zoomed spans */
@@ -132,6 +152,23 @@ export declare const detectXType: (datas: readonly ChartSeriesData[]) => ChartAx
  * the left range has (its ticks then line up with the left grid)
  */
 export declare const alignedDomain: (lo: number, hi: number, left: Range, count: number) => Range;
+/** Value of the y axis -> plotted y (the logarithm on log axes) */
+export declare const toPlotY: (model: {
+    y: AxisModel;
+}, value: number) => number;
+/** Plotted y -> value of the y axis */
+export declare const fromPlotY: (model: {
+    y: AxisModel;
+}, value: number) => number;
+/** Position (0-1) of a heatmap value on its color ramp */
+export declare const heatPosition: (s: Pick<SeriesModel, "valueRange" | "colorMidpoint">, v: number) => number;
+/**
+ * Built-in ramps of heatmaps, perceptual (OKLab) and theme-aware: light
+ * themes go from a near-white tint to a deep hue, dark themes from a dark
+ * tint of the surface to a bright saturated hue; diverging ramps meet in a
+ * neutral middle
+ */
+export declare const heatmapStops: (scheme: ChartColorScheme, color: Rgba, theme: ChartTheme, negative: Rgba) => Rgba[];
 export declare const buildModel: (options: ChartOptions, theme: ChartTheme, hidden: ReadonlySet<string>, cache: DataCache, resolver?: ColorResolver | null) => ChartModel;
 /** Y value drawn for a point: its stacked top for stacks, the close for candles */
 export declare const plottedY: (s: SeriesModel, i: number) => number;

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

@@ -2,7 +2,7 @@ import { ColorResolver, Rgba } from './color.js';
 import { SeriesColumns } from './data.js';
 import { GridIndex } from './spatial.js';
 import { ChartTheme } from './theme.js';
-import { ChartAxisType, ChartCurve, ChartOptions, ChartSeriesData, ChartLabels, ChartSeriesType, ChartTimeZone } from './types.js';
+import { ChartAxisType, ChartColorScheme, ChartCurve, ChartOptions, ChartSeriesData, ChartLabels, ChartSeriesType, ChartTimeZone } from './types.js';
 import { Range } from './viewport.js';
 export interface AxisModel {
     type: ChartAxisType;
@@ -67,6 +67,21 @@ export interface SeriesModel {
     /** Heatmaps: ramp of the colors and the values at its ends */
     colorScale: Rgba[];
     valueRange: Range;
+    /** Heatmaps: value at the middle of the ramp (`null`: linear over the range) */
+    colorMidpoint: number | null;
+    /** Heatmaps: 256 packed colors along the ramp (OKLab) */
+    colorLut: Uint32Array | null;
+    /** Hit tests and tooltips include the series */
+    tooltip: boolean;
+    /** Box plots: outlier rings or dots, and their diameter */
+    outlierShape: "hollow" | "filled";
+    outlierSize: number;
+    /** Bars: lines from the end of every bar to the next one */
+    connector: {
+        color: Rgba;
+        dash: number[];
+        width: number;
+    } | null;
     /** Corner radius in CSS pixels (bars, heatmap cells) */
     radius: number;
     /** Tooltip format of the values */
@@ -74,10 +89,15 @@ export interface SeriesModel {
     /** Scatter: name of the `value` of the points */
     valueName?: string;
 }
-/** Linear map of the right axis onto the left one: `left = right * scale + offset` */
+/**
+ * Map of the values of a series onto the plotted (left axis) units:
+ * `left = (log ? log10(value) : value) * scale + offset`
+ */
 export interface AxisMap {
     scale: number;
     offset: number;
+    /** Logarithmic axis: the values are plotted as their base-10 logarithm */
+    log?: boolean;
 }
 export interface ChartModel {
     series: SeriesModel[];
@@ -106,7 +126,7 @@ export interface ChartModel {
         x: boolean;
         y: boolean;
     };
-    tooltipMode: "nearest" | "axis";
+    tooltipMode: "nearest" | "axis" | "item";
     /** Y value the areas are filled to */
     baseline: number;
     /** Smallest zoomed spans */
@@ -132,6 +152,23 @@ export declare const detectXType: (datas: readonly ChartSeriesData[]) => ChartAx
  * the left range has (its ticks then line up with the left grid)
  */
 export declare const alignedDomain: (lo: number, hi: number, left: Range, count: number) => Range;
+/** Value of the y axis -> plotted y (the logarithm on log axes) */
+export declare const toPlotY: (model: {
+    y: AxisModel;
+}, value: number) => number;
+/** Plotted y -> value of the y axis */
+export declare const fromPlotY: (model: {
+    y: AxisModel;
+}, value: number) => number;
+/** Position (0-1) of a heatmap value on its color ramp */
+export declare const heatPosition: (s: Pick<SeriesModel, "valueRange" | "colorMidpoint">, v: number) => number;
+/**
+ * Built-in ramps of heatmaps, perceptual (OKLab) and theme-aware: light
+ * themes go from a near-white tint to a deep hue, dark themes from a dark
+ * tint of the surface to a bright saturated hue; diverging ramps meet in a
+ * neutral middle
+ */
+export declare const heatmapStops: (scheme: ChartColorScheme, color: Rgba, theme: ChartTheme, negative: Rgba) => Rgba[];
 export declare const buildModel: (options: ChartOptions, theme: ChartTheme, hidden: ReadonlySet<string>, cache: DataCache, resolver?: ColorResolver | null) => ChartModel;
 /** Y value drawn for a point: its stacked top for stacks, the close for candles */
 export declare const plottedY: (s: SeriesModel, i: number) => number;