@opendata-ai/openchart-engine 6.27.2 → 6.28.4

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _opendata_ai_openchart_core from '@opendata-ai/openchart-core';
-import { LegendLayout, ResolvedChrome, TooltipContent, A11yMetadata, ResolvedTheme, CompileOptions, ChartLayout, LayerSpec, CompileTableOptions, TableLayout, AnimationSpec, ResolvedAnimation, TileMapEncoding, TileMapPalette, LegendConfig, ThemeConfig, DarkMode, MarkType, MarkDef, DataRow, Encoding, ChromeText, Annotation, LabelConfig, Display, ColumnConfig, GraphSpec, GraphEncoding, GraphLayoutConfig, NodeOverride, SankeyEncoding, SankeyNodeAlign, SankeyLinkColor, VizSpec, ScaleType, EncodingChannel, Rect, LayoutStrategy, Mark, BinTransform, CalculateTransform, ConditionalValueDef, FilterPredicate, TimeUnitTransform, Transform } from '@opendata-ai/openchart-core';
-export { ChartLayout, ChartSpec, CompileOptions, CompileTableOptions, GraphLayout, GraphSpec, LayerSpec, SankeyLayout, SankeySpec, TableLayout, TableSpec, TileMapLayout, TileMapSpec, VizSpec } from '@opendata-ai/openchart-core';
+import { LegendLayout, ResolvedChrome, TooltipContent, A11yMetadata, ResolvedTheme, CompileOptions, ChartLayout, LayerSpec, CompileTableOptions, TableLayout, AnimationSpec, ResolvedAnimation, DataRow, BarListEncoding, ThemeConfig, DarkMode, TileMapEncoding, TileMapPalette, LegendConfig, MarkType, MarkDef, Encoding, ChromeText, Annotation, LabelConfig, Display, ColumnConfig, GraphSpec, GraphEncoding, GraphLayoutConfig, NodeOverride, SankeyEncoding, SankeyNodeAlign, SankeyLinkColor, VizSpec, ScaleType, EncodingChannel, Rect, LayoutStrategy, Mark, BinTransform, CalculateTransform, ConditionalValueDef, FilterPredicate, TimeUnitTransform, Transform } from '@opendata-ai/openchart-core';
+export { BarListLayout, BarListSpec, ChartLayout, ChartSpec, CompileOptions, CompileTableOptions, GraphLayout, GraphSpec, LayerSpec, SankeyLayout, SankeySpec, TableLayout, TableSpec, TileMapLayout, TileMapSpec, VizSpec } from '@opendata-ai/openchart-core';
 import { ScaleLinear, ScaleTime, ScaleLogarithmic, ScalePower, ScaleSymLog, ScaleBand, ScalePoint, ScaleOrdinal, ScaleQuantile, ScaleQuantize, ScaleThreshold } from 'd3-scale';
 
 /**
@@ -182,6 +182,19 @@ declare function compileSankey(spec: unknown, options: CompileOptions): _opendat
  * @throws Error if spec is invalid or not a tilemap type.
  */
 declare function compileTileMap(spec: unknown, options: CompileOptions): _opendata_ai_openchart_core.TileMapLayout;
+/**
+ * Compile a barlist spec into a BarListLayout.
+ *
+ * Takes a raw barlist spec, validates, normalizes, resolves theme and chrome,
+ * computes row layout with proportional bars, builds tooltips, and returns
+ * a BarListLayout ready for rendering.
+ *
+ * @param spec - Raw barlist spec (validated and normalized internally).
+ * @param options - Compile options (width, height, theme, darkMode).
+ * @returns BarListLayout with computed positions and visual properties.
+ * @throws Error if spec is invalid or not a barlist type.
+ */
+declare function compileBarList(spec: unknown, options: CompileOptions): _opendata_ai_openchart_core.BarListLayout;
 
 /**
  * Animation resolver: normalizes AnimationSpec into fully resolved config.
@@ -202,6 +215,25 @@ declare function resolveAnimation(spec: AnimationSpec | undefined): ResolvedAnim
  */
 declare function clampStaggerDelay(delay: number, elementCount: number): number;
 
+/**
+ * Internal normalized barlist spec type used by the compilation pipeline.
+ */
+
+interface NormalizedBarListSpec {
+    type: 'barlist';
+    data: DataRow[];
+    encoding: BarListEncoding;
+    barHeight: number;
+    cornerRadius: number | 'pill';
+    maxItems: number;
+    chrome: NormalizedChrome;
+    theme: ThemeConfig;
+    darkMode: DarkMode;
+    watermark: boolean;
+    animation?: AnimationSpec;
+    valueFormat?: string;
+}
+
 /**
  * Internal normalized tilemap spec type used by the compilation pipeline.
  *
@@ -270,8 +302,8 @@ interface NormalizedChartSpec {
     encoding: Encoding;
     chrome: NormalizedChrome;
     annotations: Annotation[];
-    /** Normalized label configuration with defaults applied. density, format, and prefix are always set; offsets stays optional. */
-    labels: Required<Pick<LabelConfig, 'density' | 'format' | 'prefix'>> & Pick<LabelConfig, 'offsets'>;
+    /** Normalized label configuration with defaults applied. density, format, and prefix are always set; offsets and color stay optional. */
+    labels: Required<Pick<LabelConfig, 'density' | 'format' | 'prefix'>> & Pick<LabelConfig, 'offsets' | 'color'>;
     /** Legend configuration (position override). */
     legend?: LegendConfig;
     responsive: boolean;
@@ -326,7 +358,7 @@ interface NormalizedGraphSpec {
     watermark: boolean;
 }
 /** Discriminated union of all normalized spec types. */
-type NormalizedSpec = NormalizedChartSpec | NormalizedTableSpec | NormalizedGraphSpec | NormalizedSankeySpec | NormalizedTileMapSpec;
+type NormalizedSpec = NormalizedChartSpec | NormalizedTableSpec | NormalizedGraphSpec | NormalizedSankeySpec | NormalizedTileMapSpec | NormalizedBarListSpec;
 /** Machine-readable error code for programmatic handling. */
 type ValidationErrorCode = 'MISSING_FIELD' | 'INVALID_TYPE' | 'INVALID_VALUE' | 'ENCODING_MISMATCH' | 'DATA_FIELD_MISSING' | 'EMPTY_DATA';
 /** A single validation error with context. */
@@ -642,4 +674,4 @@ declare function runTimeUnit(data: DataRow[], transform: TimeUnitTransform): Dat
  */
 declare function runTransforms(data: DataRow[], transforms: Transform[]): DataRow[];
 
-export { type ChartRenderer, type CompileResult, type CompiledGraphEdge, type CompiledGraphNode, type GraphCompilation, type NormalizedChartSpec, type NormalizedChrome, type NormalizedGraphSpec, type NormalizedSankeySpec, type NormalizedSpec, type NormalizedTableSpec, type NormalizedTileMapSpec, type SimulationConfig, type ValidationError, type ValidationErrorCode, type ValidationResult, clampStaggerDelay, clearRenderers, compile, compileChart, compileGraph, compileLayer, compileSankey, compileTable, compileTileMap, evaluatePredicate, getChartRenderer, isConditionalValueDef, normalizeSpec, registerChartRenderer, resolveAnimation, resolveConditionalValue, runBin, runCalculate, runFilter, runTimeUnit, runTransforms, validateSpec };
+export { type ChartRenderer, type CompileResult, type CompiledGraphEdge, type CompiledGraphNode, type GraphCompilation, type NormalizedBarListSpec, type NormalizedChartSpec, type NormalizedChrome, type NormalizedGraphSpec, type NormalizedSankeySpec, type NormalizedSpec, type NormalizedTableSpec, type NormalizedTileMapSpec, type SimulationConfig, type ValidationError, type ValidationErrorCode, type ValidationResult, clampStaggerDelay, clearRenderers, compile, compileBarList, compileChart, compileGraph, compileLayer, compileSankey, compileTable, compileTileMap, evaluatePredicate, getChartRenderer, isConditionalValueDef, normalizeSpec, registerChartRenderer, resolveAnimation, resolveConditionalValue, runBin, runCalculate, runFilter, runTimeUnit, runTransforms, validateSpec };