@blueprint-chart/lib 2.10.0 → 2.11.0

package/dist/charts/plugins/annotations/context.d.ts

@@ -12,6 +12,11 @@ export interface AnnotationContext {
     backgroundColor?: string;
     orientation?: 'horizontal';
     transition?: boolean;
+    /** Centre of the mark a label names, for charts whose marks are dots on a band (dot plot). */
+    markCenter?: (label: string) => {
+        x: number;
+        y: number;
+    } | undefined;
     /** Pre-computed snapshots of old annotation positions (captured before DOM is cleared). */
     priorAnnotations?: Map<string, AnnotationSnapshot>;
 }

package/dist/charts/plugins/annotations/shared.d.ts

@@ -13,6 +13,13 @@ export declare function computeAnchorPoint(datum: {
     x: number;
     y: number;
 };
+export declare function pointAnchor(center: {
+    x: number;
+    y: number;
+}, anchorDirection: CompassDirection): {
+    x: number;
+    y: number;
+};
 export declare function bboxEdgeToward(bbox: {
     x: number;
     y: number;

package/dist/charts/types/dot-plot/annotations.d.ts

@@ -0,0 +1,4 @@
+import { AnnotationContext } from '../../plugins/annotations';
+import { DotPlotRow } from './rows';
+import * as d3 from 'd3';
+export declare function dotPlotAnnotationContext(rows: DotPlotRow[], x: AnnotationContext['scaleY'], y: d3.ScaleBand<string>, rowY: (name: string) => number): Pick<AnnotationContext, 'scaleX' | 'scaleY' | 'data' | 'orientation' | 'markCenter'>;

package/dist/charts/types/dot-plot/dot-plot.d.ts

@@ -0,0 +1,4 @@
+import { ChartData, ChartOptions } from '../../types';
+export declare const DEFAULT_COLOR = "#4e79a7";
+export declare const DOT_RADIUS = 5;
+export declare function render(container: HTMLElement, data: ChartData, options?: ChartOptions, transition?: boolean): void;

package/dist/charts/types/dot-plot/issues.d.ts

@@ -0,0 +1,11 @@
+import { ScaleType } from '../../../enums';
+import { ChartData } from '../../types';
+import { DotPlotMapping } from './mapping';
+export interface DotPlotIssue {
+    code: string;
+    severity: 'warning';
+    message: string;
+    key?: 'low' | 'high';
+    suggestion?: string;
+}
+export declare function dotPlotIssues(data: ChartData, overrides: DotPlotMapping, scaleType?: ScaleType): DotPlotIssue[];

package/dist/charts/types/dot-plot/mapping.d.ts

@@ -0,0 +1,17 @@
+import { DotStyle } from '../../../enums';
+import { ChartData } from '../../types';
+export type DotPlotMode = 'single' | 'dumbbell' | 'range';
+export interface DotPlotMapping {
+    dotStyle?: DotStyle;
+    low?: string;
+    high?: string;
+}
+export interface ResolvedDotPlot {
+    mode: DotPlotMode;
+    values: string[];
+    low?: string;
+    high?: string;
+    ignored: string[];
+}
+export declare function detectRangeColumn(columns: string[], role: 'low' | 'high'): string | undefined;
+export declare function resolveDotPlotMapping(data: ChartData, overrides?: DotPlotMapping): ResolvedDotPlot;

package/dist/charts/types/dot-plot/rows.d.ts

@@ -0,0 +1,20 @@
+import { ScaleType, SortMode } from '../../../enums';
+import { ChartData } from '../../types';
+import { DotPlotMode, ResolvedDotPlot } from './mapping';
+export interface DotPlotRow {
+    name: string;
+    values: number[];
+    low?: number;
+    high?: number;
+}
+export type DotPlotDropReason = 'missing-value' | 'missing-range' | 'non-positive-log';
+type DroppedRow = {
+    name: string;
+    reason: DotPlotDropReason;
+};
+export declare function buildDotPlotRows(data: ChartData, resolved: ResolvedDotPlot, scaleType?: ScaleType): {
+    rows: DotPlotRow[];
+    dropped: DroppedRow[];
+};
+export declare function sortDotPlotRows(rows: DotPlotRow[], sortMode: SortMode | undefined, mode: DotPlotMode): DotPlotRow[];
+export {};

package/dist/charts/types/dot-plot/tooltip.d.ts

@@ -0,0 +1,3 @@
+import { DotPlotRow } from './rows';
+import { ResolvedDotPlot } from './mapping';
+export declare function formatDotPlotTooltip(row: DotPlotRow, resolved: ResolvedDotPlot, format?: string): string;

package/dist/charts/types/scatter/issues.d.ts

@@ -16,5 +16,22 @@ type Ranges = {
     x?: AxisRange;
     y?: AxisRange;
 };
+export declare const MAX_LISTED_ROWS = 5;
+export declare function columnNames(data: ChartData): string[];
+export declare function unknownColumns<K extends string, S extends 'error' | 'warning'>(data: ChartData, overrides: Partial<Record<K, string>>, keys: readonly K[], severity: S): {
+    code: string;
+    severity: S;
+    key: K;
+    message: string;
+    suggestion: string | undefined;
+}[];
+export declare function droppedRows<R extends string>(dropped: {
+    name: string;
+    reason: R;
+}[], reasons: Record<R, string>): {
+    code: 'dropped-rows';
+    severity: 'warning';
+    message: string;
+}[];
 export declare function scatterIssues(data: ChartData, overrides: ScatterMapping, scaleTypes: ScaleTypes, ranges: Ranges, trend?: string): ScatterIssue[];
 export {};

package/dist/charts/types/scatter/points.d.ts

@@ -17,6 +17,7 @@ type ScaleTypes = {
     x?: ScaleType;
     y?: ScaleType;
 };
+export declare function numericColumn(data: ChartData, name?: string): number[] | undefined;
 export declare function buildScatterPoints(data: ChartData, mapping: ScatterMapping, scaleTypes: ScaleTypes): {
     points: ScatterPoint[];
     dropped: DroppedRow[];

package/dist/charts/types.d.ts

@@ -1,4 +1,4 @@
-import { AxisDirection, ScaleType, GridStyle, LabelPosition, LabelRotation, TickPosition, FrameSizing, AnnotationKind, Orientation, SymbolShape, SymbolShowOn, SymbolStyle, SortDirection, SortMode, LegendPosition, Anchor, ValueLabelPosition, CrosshairDirection, CrosshairStyle, StackMode, ChartOptionType, CompassDirection, AnnotationLineStyle, StrokeStyle, RangeAnchor } from '../enums';
+import { AxisDirection, ScaleType, GridStyle, LabelPosition, LabelRotation, TickPosition, FrameSizing, AnnotationKind, Orientation, SymbolShape, SymbolShowOn, SymbolStyle, SortDirection, SortMode, DotStyle, ArrowDirection, LegendPosition, Anchor, ValueLabelPosition, CrosshairDirection, CrosshairStyle, StackMode, ChartOptionType, CompassDirection, AnnotationLineStyle, StrokeStyle, RangeAnchor } from '../enums';
 export { CompassDirection, AnnotationLineStyle, StrokeStyle, RangeAnchor, LineStyle, } from '../enums';
 export interface ChartData {
     labels: string[];
@@ -199,6 +199,10 @@ export interface ChartOptions {
     size?: string;
     group?: string;
     trend?: string;
+    dotStyle?: DotStyle;
+    low?: string;
+    high?: string;
+    arrows?: ArrowDirection;
 }
 export type ChartRenderer = (container: HTMLElement, data: ChartData, options: ChartOptions, transition?: boolean) => void;
 export interface ChartOptionDef {
@@ -289,5 +293,9 @@ export interface ChartTypeOptions {
     size: string;
     group: string;
     trend: string;
+    dotStyle: DotStyle;
+    low: string;
+    high: string;
+    arrows: ArrowDirection;
 }
 export type ChartTypeOptionKey = keyof ChartTypeOptions;

package/dist/embed.js

@@ -1,2 +1,2 @@
-import { a as e, i as t, o as n, r, t as i } from "./runtime-gzeMNwqx.js";
+import { a as e, i as t, o as n, r, t as i } from "./runtime-D_vHKSyR.js";
 export { r as ERROR_MESSAGE, t as RESIZE_MESSAGE, i as buildSrcdoc, e as isErrorMessage, n as readResizeHeight };

package/dist/enums.d.ts

@@ -13,6 +13,7 @@ export declare enum ChartType {
     Donut = "donut",
     Pie = "pie",
     Scatter = "scatter",
+    DotPlot = "dot-plot",
     VerticalBar = "vertical-bar",
     HorizontalBar = "horizontal-bar"
 }
@@ -135,10 +136,22 @@ export declare enum SortDirection {
     Descending = "descending",
     None = "none"
 }
+export declare enum ArrowDirection {
+    None = "none",
+    Forward = "forward",
+    Backward = "backward",
+    Both = "both"
+}
+export declare enum DotStyle {
+    Dumbbell = "dumbbell",
+    Range = "range"
+}
 export declare enum SortMode {
     Total = "total",
     WithinGroups = "within-groups",
-    None = "none"
+    None = "none",
+    Value = "value",
+    Gap = "gap"
 }
 export declare enum LegendPosition {
     Top = "top",

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { ChartType, AxisDirection, ScaleType, GridStyle, LabelPosition, LabelRotation, TickPosition, FrameSizing, CompassDirection, AnnotationLineStyle, StrokeStyle, AnnotationKind, RangeAnchor, Orientation, SymbolShape, SymbolShowOn, SymbolStyle, SortDirection, SortMode, LegendPosition, Anchor, ValueLabelPosition, CrosshairDirection, CrosshairStyle, StackMode, LineStyle, ChartOptionType, DirectLabelMode, Interpolation, DslNodeType, TransformType, FilterCondition, ParseOperationCategory, } from './enums';
+export { ChartType, AxisDirection, ScaleType, GridStyle, LabelPosition, LabelRotation, TickPosition, FrameSizing, CompassDirection, AnnotationLineStyle, StrokeStyle, AnnotationKind, RangeAnchor, Orientation, SymbolShape, SymbolShowOn, SymbolStyle, SortDirection, SortMode, DotStyle, ArrowDirection, LegendPosition, Anchor, ValueLabelPosition, CrosshairDirection, CrosshairStyle, StackMode, LineStyle, ChartOptionType, DirectLabelMode, Interpolation, DslNodeType, TransformType, FilterCondition, ParseOperationCategory, } from './enums';
 export { ANNOTATION_KIND_KEYWORD } from './enums';
 export type { ChartData, ChartOptions, ChartRenderer, ChartOptionDef, ChartTypeOptions, ChartTypeOptionKey, ColorizeConfig, HighlightConfig, AxisOptions, FrameOptions, AreaFillConfig, AnnotationConfig, PointAnnotationConfig, RangeAnnotationConfig, FreeAnnotationConfig, AnnotationLineConfig, LineSymbolConfig, SeriesOverride, Margin, } from './charts/types';
 export { createFrame } from './charts/frame/frame';
@@ -12,6 +12,7 @@ export { registerChart, getChart, getChartOptions, listCharts } from './charts/r
 export { parseData, buildChartOptions } from './charts/chart-helpers';
 export { stripDigitGroupSpaces } from './charts/number-parse';
 export { resolveScatterMapping, numericColumns, MAPPING_NONE, type ScatterMapping } from './charts/types/scatter/mapping';
+export { resolveDotPlotMapping, detectRangeColumn, type DotPlotMapping, type DotPlotMode, type ResolvedDotPlot } from './charts/types/dot-plot/mapping';
 export { recommendCharts } from './recommendations/recommend';
 export { classifyIntent } from './recommendations/intent';
 export { shapeOf } from './recommendations/shape';