minerva-design 1.4.0 → 1.6.0

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

@@ -4,7 +4,7 @@ import { Rect, Scales } from './layout.cjs';
 import { ChartModel, SeriesModel } from './model.cjs';
 import { PointLabel, ResolvedAnnotation } from './overlay.cjs';
 import { ChartTheme } from './theme.cjs';
-import { ChartAnnotation, ChartHoverEvent, ChartHoverItem, ChartPadding, ChartView } from './types.cjs';
+import { ChartAnnotation, ChartDependency, ChartHoverEvent, ChartHoverItem, ChartOptions, ChartPadding, ChartView } from './types.cjs';
 export declare const MAX_POINT_LABELS = 300;
 export declare const DEFAULT_PADDING: {
     top: number;
@@ -13,8 +13,11 @@ export declare const DEFAULT_PADDING: {
     left: number;
 };
 export declare const fallbackResolve: (_value: string, fallback: Rgba) => Rgba;
-/** Annotation colors resolved against the theme */
-export declare const resolveAnnotations: (annotations: readonly ChartAnnotation[] | undefined, theme: ChartTheme) => ResolvedAnnotation[];
+/**
+ * Annotation colors resolved against the theme; `mapY` / `mapX` turn values
+ * into plotted units (log axes)
+ */
+export declare const resolveAnnotations: (annotations: readonly ChartAnnotation[] | undefined, theme: ChartTheme, mapY?: (value: number) => number, mapX?: (value: number) => number) => ResolvedAnnotation[];
 export interface ChartLayout {
     plot: Rect;
     scales: Scales;
@@ -68,8 +71,10 @@ export interface TooltipRow {
 }
 export interface TooltipContent {
     title: string;
-    /** Swatch of the title (single scatter point) */
+    /** Swatch of the title (single scatter point, Gantt task) */
     titleColor: string | null;
+    /** Muted line below the title (the group of a Gantt task) */
+    subtitle?: string;
     rows: TooltipRow[];
 }
 /**
@@ -96,14 +101,109 @@ export type HoverMark = {
     width: number;
     height: number;
 } | {
+    /** Soft band over the row / column of a hovered cell (above the data) */
+    kind: "guide";
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+} | {
+    /** The hovered cell, lifted, with a ring inside its edge */
     kind: "cell";
     x: number;
     y: number;
     width: number;
     height: number;
+    /** Fill of the cell (CSS) */
+    color: string;
+    /** Ring color (CSS), contrasting with the fill */
+    ring: string;
+    radius: number;
 };
 /** Markers of the hovered points (pixels of the stage); bands come first */
 export declare const hoverMarks: (model: ChartModel, sc: Scales, event: ChartHoverEvent) => HoverMark[];
+/** Ring of a hovered cell: light on dark fills, dark on light ones */
+export declare const contrastRing: (fill: Rgba) => string;
+/** A line from the end of a bar to the next bar, pixels of the stage */
+export interface ConnectorSegment {
+    x0: number;
+    y0: number;
+    x1: number;
+    y1: number;
+    color: string;
+    width: number;
+    dash: number[];
+}
+/**
+ * Connectors of the bar series (`connector`, waterfalls): from the end of
+ * every bar to the next bar, at the value where the next one starts
+ */
+export declare const connectorSegments: (model: ChartModel, sc: Scales) => ConnectorSegment[];
+/** A dependency with its color resolved against the theme */
+export interface ResolvedDependency {
+    from: string;
+    to: string;
+    color: string;
+}
+/** Colors of the dependency arrows (resolved once per options / theme) */
+export declare const resolveDependencies: (dependencies: readonly ChartDependency[] | undefined, theme: ChartTheme) => ResolvedDependency[];
+/**
+ * Elbow arrow between two bars, pixels of the stage: an axis-aligned
+ * polyline ending at the base of a filled triangular head
+ */
+export interface DependencyArrow {
+    /** Corners of the line, from the end of the predecessor to the base of the head */
+    points: {
+        x: number;
+        y: number;
+    }[];
+    /** Tip and the two base corners of the arrowhead */
+    head: [
+        {
+            x: number;
+            y: number;
+        },
+        {
+            x: number;
+            y: number;
+        },
+        {
+            x: number;
+            y: number;
+        }
+    ];
+    color: string;
+    width: number;
+}
+/** Length and half width of the arrowheads, in CSS pixels */
+export declare const ARROW_HEAD: {
+    length: number;
+    half: number;
+};
+/**
+ * Dependency arrows (`dependencies`, Gantt charts): from the end of the
+ * predecessor to the start of the successor; when the successor starts
+ * too early the line turns around between the rows
+ */
+export declare const dependencyArrows: (model: ChartModel, sc: Scales, dependencies: readonly ResolvedDependency[]) => DependencyArrow[];
+/** Visual map of a heatmap: its color ramp and the values at the ends */
+export interface ColorLegend {
+    seriesIndex: number;
+    /** CSS colors at even steps from the lowest to the highest value */
+    stops: string[];
+    /** Labels along the ramp (`at`: 0-1): the ends, and the middle of diverging ramps */
+    labels: {
+        at: number;
+        text: string;
+    }[];
+}
+/**
+ * Color legend of a heatmap chart (every series is a heatmap; the first
+ * visible one), `null` otherwise
+ */
+export declare const colorLegend: (model: ChartModel) => ColorLegend | null;
+/** Whether the legend shows (`legend` option; heatmaps get their color legend) */
+export declare const legendShown: (option: ChartOptions["legend"], model: ChartModel, named: number) => boolean;
 /** Swatch of a series in the legend */
 export declare const legendShape: (type: SeriesModel["type"]) => "dot" | "line" | "square";
 /** Whether the guide line follows the pointer */

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

@@ -4,7 +4,7 @@ import { Rect, Scales } from './layout.js';
 import { ChartModel, SeriesModel } from './model.js';
 import { PointLabel, ResolvedAnnotation } from './overlay.js';
 import { ChartTheme } from './theme.js';
-import { ChartAnnotation, ChartHoverEvent, ChartHoverItem, ChartPadding, ChartView } from './types.js';
+import { ChartAnnotation, ChartDependency, ChartHoverEvent, ChartHoverItem, ChartOptions, ChartPadding, ChartView } from './types.js';
 export declare const MAX_POINT_LABELS = 300;
 export declare const DEFAULT_PADDING: {
     top: number;
@@ -13,8 +13,11 @@ export declare const DEFAULT_PADDING: {
     left: number;
 };
 export declare const fallbackResolve: (_value: string, fallback: Rgba) => Rgba;
-/** Annotation colors resolved against the theme */
-export declare const resolveAnnotations: (annotations: readonly ChartAnnotation[] | undefined, theme: ChartTheme) => ResolvedAnnotation[];
+/**
+ * Annotation colors resolved against the theme; `mapY` / `mapX` turn values
+ * into plotted units (log axes)
+ */
+export declare const resolveAnnotations: (annotations: readonly ChartAnnotation[] | undefined, theme: ChartTheme, mapY?: (value: number) => number, mapX?: (value: number) => number) => ResolvedAnnotation[];
 export interface ChartLayout {
     plot: Rect;
     scales: Scales;
@@ -68,8 +71,10 @@ export interface TooltipRow {
 }
 export interface TooltipContent {
     title: string;
-    /** Swatch of the title (single scatter point) */
+    /** Swatch of the title (single scatter point, Gantt task) */
     titleColor: string | null;
+    /** Muted line below the title (the group of a Gantt task) */
+    subtitle?: string;
     rows: TooltipRow[];
 }
 /**
@@ -96,14 +101,109 @@ export type HoverMark = {
     width: number;
     height: number;
 } | {
+    /** Soft band over the row / column of a hovered cell (above the data) */
+    kind: "guide";
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+} | {
+    /** The hovered cell, lifted, with a ring inside its edge */
     kind: "cell";
     x: number;
     y: number;
     width: number;
     height: number;
+    /** Fill of the cell (CSS) */
+    color: string;
+    /** Ring color (CSS), contrasting with the fill */
+    ring: string;
+    radius: number;
 };
 /** Markers of the hovered points (pixels of the stage); bands come first */
 export declare const hoverMarks: (model: ChartModel, sc: Scales, event: ChartHoverEvent) => HoverMark[];
+/** Ring of a hovered cell: light on dark fills, dark on light ones */
+export declare const contrastRing: (fill: Rgba) => string;
+/** A line from the end of a bar to the next bar, pixels of the stage */
+export interface ConnectorSegment {
+    x0: number;
+    y0: number;
+    x1: number;
+    y1: number;
+    color: string;
+    width: number;
+    dash: number[];
+}
+/**
+ * Connectors of the bar series (`connector`, waterfalls): from the end of
+ * every bar to the next bar, at the value where the next one starts
+ */
+export declare const connectorSegments: (model: ChartModel, sc: Scales) => ConnectorSegment[];
+/** A dependency with its color resolved against the theme */
+export interface ResolvedDependency {
+    from: string;
+    to: string;
+    color: string;
+}
+/** Colors of the dependency arrows (resolved once per options / theme) */
+export declare const resolveDependencies: (dependencies: readonly ChartDependency[] | undefined, theme: ChartTheme) => ResolvedDependency[];
+/**
+ * Elbow arrow between two bars, pixels of the stage: an axis-aligned
+ * polyline ending at the base of a filled triangular head
+ */
+export interface DependencyArrow {
+    /** Corners of the line, from the end of the predecessor to the base of the head */
+    points: {
+        x: number;
+        y: number;
+    }[];
+    /** Tip and the two base corners of the arrowhead */
+    head: [
+        {
+            x: number;
+            y: number;
+        },
+        {
+            x: number;
+            y: number;
+        },
+        {
+            x: number;
+            y: number;
+        }
+    ];
+    color: string;
+    width: number;
+}
+/** Length and half width of the arrowheads, in CSS pixels */
+export declare const ARROW_HEAD: {
+    length: number;
+    half: number;
+};
+/**
+ * Dependency arrows (`dependencies`, Gantt charts): from the end of the
+ * predecessor to the start of the successor; when the successor starts
+ * too early the line turns around between the rows
+ */
+export declare const dependencyArrows: (model: ChartModel, sc: Scales, dependencies: readonly ResolvedDependency[]) => DependencyArrow[];
+/** Visual map of a heatmap: its color ramp and the values at the ends */
+export interface ColorLegend {
+    seriesIndex: number;
+    /** CSS colors at even steps from the lowest to the highest value */
+    stops: string[];
+    /** Labels along the ramp (`at`: 0-1): the ends, and the middle of diverging ramps */
+    labels: {
+        at: number;
+        text: string;
+    }[];
+}
+/**
+ * Color legend of a heatmap chart (every series is a heatmap; the first
+ * visible one), `null` otherwise
+ */
+export declare const colorLegend: (model: ChartModel) => ColorLegend | null;
+/** Whether the legend shows (`legend` option; heatmaps get their color legend) */
+export declare const legendShown: (option: ChartOptions["legend"], model: ChartModel, named: number) => boolean;
 /** Swatch of a series in the legend */
 export declare const legendShape: (type: SeriesModel["type"]) => "dot" | "line" | "square";
 /** Whether the guide line follows the pointer */