@opendata-ai/openchart-core 6.10.0 → 6.12.0

package/dist/index.d.ts

@@ -180,6 +180,65 @@ interface ColumnConfig {
 type MarkType = 'bar' | 'line' | 'area' | 'point' | 'circle' | 'arc' | 'text' | 'rule' | 'tick' | 'rect' | 'lollipop';
 /** @deprecated Use MarkType instead. Kept for internal migration references. */
 type ChartType = MarkType;
+/** A single color stop in a gradient definition. */
+interface GradientStop {
+    /** Position along the gradient, 0 to 1. */
+    offset: number;
+    /** CSS color string at this stop. */
+    color: string;
+    /** Opacity at this stop, 0 to 1. Maps to SVG stop-opacity. */
+    opacity?: number;
+}
+/**
+ * Linear gradient definition.
+ * Coordinates are in [0,1] normalized space relative to the mark's bounding box
+ * (maps to SVG gradientUnits="objectBoundingBox").
+ */
+interface LinearGradient {
+    gradient: 'linear';
+    /** Color stops from start to end. */
+    stops: GradientStop[];
+    /** Start x coordinate (0-1). Default: 0. */
+    x1?: number;
+    /** Start y coordinate (0-1). Default: 0. */
+    y1?: number;
+    /** End x coordinate (0-1). Default: 0. */
+    x2?: number;
+    /** End y coordinate (0-1). Default: 1 (top-to-bottom). */
+    y2?: number;
+}
+/**
+ * Radial gradient definition.
+ * Coordinates are in [0,1] normalized space relative to the mark's bounding box.
+ */
+interface RadialGradient {
+    gradient: 'radial';
+    /** Color stops from inner to outer. */
+    stops: GradientStop[];
+    /** Inner circle center x (0-1). Default: 0.5. */
+    x1?: number;
+    /** Inner circle center y (0-1). Default: 0.5. */
+    y1?: number;
+    /** Inner circle radius (0-1). Default: 0. */
+    r1?: number;
+    /** Outer circle center x (0-1). Default: 0.5. */
+    x2?: number;
+    /** Outer circle center y (0-1). Default: 0.5. */
+    y2?: number;
+    /** Outer circle radius (0-1). Default: 0.5. */
+    r2?: number;
+}
+/** A gradient definition, either linear or radial. */
+type GradientDef = LinearGradient | RadialGradient;
+/** Type guard: check if a value is a GradientDef object. */
+declare function isGradientDef(value: unknown): value is GradientDef;
+/**
+ * Extract a single representative color from a fill value.
+ * Returns the fill directly if it's a string, or the last stop color
+ * if it's a gradient. Used by tooltips, labels, legends, and voronoi
+ * overlays that need a flat color.
+ */
+declare function getRepresentativeColor(fill: string | GradientDef): string;
 /**
  * Mark definition object with visual properties.
  *
@@ -214,8 +273,8 @@ interface MarkDef {
     filled?: boolean;
     /** Default opacity (0-1). */
     opacity?: number;
-    /** Default fill color. */
-    fill?: string;
+    /** Default fill color or gradient. */
+    fill?: string | GradientDef;
     /** Default stroke color. */
     stroke?: string;
     /** Default stroke width. */
@@ -756,6 +815,8 @@ interface ChartSpec {
     theme?: ThemeConfig;
     /** Dark mode behavior. Defaults to "off". */
     darkMode?: DarkMode;
+    /** Whether to show the tryOpenData.ai watermark. Defaults to true. */
+    watermark?: boolean;
     /** Series names to hide from rendering. Hidden series remain in the legend but are visually dimmed. */
     hiddenSeries?: string[];
     /** Per-series visual overrides, keyed by series name (the color field value). */
@@ -795,6 +856,8 @@ interface TableSpec {
     theme?: ThemeConfig;
     /** Dark mode behavior. */
     darkMode?: DarkMode;
+    /** Whether to show the tryOpenData.ai watermark. Defaults to true. */
+    watermark?: boolean;
     /** Enable client-side search/filter. */
     search?: boolean;
     /** Pagination configuration. True for defaults, or an object with pageSize. */
@@ -860,6 +923,8 @@ interface GraphSpec {
     theme?: ThemeConfig;
     /** Dark mode behavior. */
     darkMode?: DarkMode;
+    /** Whether to show the tryOpenData.ai watermark. Defaults to true. */
+    watermark?: boolean;
 }
 /**
  * Resolution strategy for shared resources across layers.
@@ -906,6 +971,8 @@ interface LayerSpec {
     theme?: ThemeConfig;
     /** Dark mode behavior. Defaults to "off". */
     darkMode?: DarkMode;
+    /** Whether to show the tryOpenData.ai watermark. Defaults to true. */
+    watermark?: boolean;
     /** Resolution strategy for shared scales/axes/legends. */
     resolve?: ResolveConfig;
     /** Hidden series names. */
@@ -964,6 +1031,8 @@ interface SankeySpec {
     theme?: ThemeConfig;
     /** Dark mode behavior. Defaults to "off". */
     darkMode?: DarkMode;
+    /** Whether to show the tryOpenData.ai watermark. Defaults to true. */
+    watermark?: boolean;
     /** Animation configuration for entrance animations. */
     animation?: AnimationSpec;
     /**
@@ -1680,8 +1749,8 @@ interface AreaMark {
     path: string;
     /** SVG path string for just the top boundary (for stroking the data line only). */
     topPath: string;
-    /** Fill color. */
-    fill: string;
+    /** Fill color or gradient. */
+    fill: string | GradientDef;
     /** Fill opacity. */
     fillOpacity: number;
     /** Optional stroke for the top boundary. */
@@ -1721,8 +1790,8 @@ interface RectMark {
     width: number;
     /** Height. */
     height: number;
-    /** Fill color. */
-    fill: string;
+    /** Fill color or gradient. */
+    fill: string | GradientDef;
     /** Stroke color. */
     stroke?: string;
     /** Stroke width. */
@@ -1764,8 +1833,8 @@ interface ArcMark {
     startAngle: number;
     /** End angle in radians. */
     endAngle: number;
-    /** Fill color. */
-    fill: string;
+    /** Fill color or gradient. */
+    fill: string | GradientDef;
     /** Stroke color (usually white for slice separation). */
     stroke: string;
     /** Stroke width. */
@@ -1791,8 +1860,8 @@ interface PointMark {
     cy: number;
     /** Radius in pixels. */
     r: number;
-    /** Fill color. */
-    fill: string;
+    /** Fill color or gradient. */
+    fill: string | GradientDef;
     /** Stroke color. */
     stroke: string;
     /** Stroke width. */
@@ -2065,6 +2134,8 @@ interface ChartLayout {
     };
     /** Resolved animation config. Present only when animation is enabled. */
     animation?: ResolvedAnimation;
+    /** Whether the tryOpenData.ai watermark is enabled. */
+    watermark: boolean;
 }
 /** A resolved column definition with computed properties. */
 interface ResolvedColumn {
@@ -2225,6 +2296,8 @@ interface TableLayout {
     theme: ResolvedTheme;
     /** Resolved animation config. Present only when animation is enabled. */
     animation?: ResolvedAnimation;
+    /** Whether the tryOpenData.ai watermark is enabled. */
+    watermark: boolean;
 }
 /** A resolved graph node with computed position and visual properties. */
 interface GraphNodeLayout {
@@ -2394,6 +2467,8 @@ interface SankeyLayout {
     };
     /** Resolved animation config. Present only when animation is enabled. */
     animation?: ResolvedAnimation;
+    /** Whether the tryOpenData.ai watermark is enabled. */
+    watermark: boolean;
 }
 /** Function signature for text measurement provided by adapters. */
 type MeasureTextFn = (text: string, fontSize: number, fontWeight?: number) => {
@@ -2421,6 +2496,8 @@ interface CompileOptions {
      * before calling compile. The engine always receives a resolved boolean.
      */
     darkMode?: boolean;
+    /** Whether to show the tryOpenData.ai watermark. Defaults to true. */
+    watermark?: boolean;
     /**
      * Real text measurement function provided by the adapter.
      * Uses a hidden canvas or DOM element for accurate text dimensions.
@@ -2616,7 +2693,7 @@ declare function resolveTheme(userTheme?: ThemeConfig, base?: Theme): ResolvedTh
  * @param chromeMode - Chrome display mode: full, compact (title only), or hidden.
  * @param padding - Override padding (for scaled padding from dimensions).
  */
-declare function computeChrome(chrome: Chrome | undefined, theme: ResolvedTheme, width: number, measureText?: MeasureTextFn, chromeMode?: ChromeMode, padding?: number): ResolvedChrome;
+declare function computeChrome(chrome: Chrome | undefined, theme: ResolvedTheme, width: number, measureText?: MeasureTextFn, chromeMode?: ChromeMode, padding?: number, watermark?: boolean): ResolvedChrome;
 
 /**
  * Estimate the rendered width of a text string.
@@ -2963,4 +3040,4 @@ declare function scatterChart(data: DataRow[], x: FieldRef, y: FieldRef, options
  */
 declare function dataTable(data: DataRow[], options?: TableBuilderOptions): TableSpec;
 
-export { type A11yMetadata, type AggregateOp, type AnimationConfig, type AnimationEase, type AnimationPhaseConfig, type AnimationSpec, type AnimationStagger, type Annotation, type AnnotationAnchor, type AnnotationOffset, type AnnotationPosition, type ArcMark, type AreaMark, type AxisConfig, type AxisLabelDensity, type AxisLayout, type AxisTick, BRAND_FONT_SIZE, BRAND_MIN_WIDTH, BRAND_RESERVE_WIDTH, type BarColumnConfig, type BarTableCell, type BinParams, type BinTransform, type Breakpoint, CATEGORICAL_PALETTE, CHART_ENCODING_RULES, CHART_TYPES, type CalculateExpression, type CalculateTransform, type CategoricalPalette, type CategoryColorsConfig, type CategoryTableCell, type CellStyle, type ChannelRule, type ChartBuilderOptions, type ChartEventHandlers, type ChartLayout, type ChartSpec, type ChartSpecOverride, type ChartSpecWithoutData, type ChartType, type Chrome, type ChromeDefaults, type ChromeKey, type ChromeMode, type ChromeText, type ChromeTextStyle, type ColorBlindnessType, type ColumnConfig, type CompileOptions, type CompileTableOptions, type Condition, type ConditionalValueDef, DEFAULT_THEME, DIVERGING_PALETTES, type DarkMode, type DataRow, type DateGranularity, type DivergingPalette, EXTENDED_OFFSET_STRATEGIES, type ElementEdit, type ElementRef, type Encoding, type EncodingChannel, type EncodingRule, type FieldPredicate, type FieldRef, type FieldType, type FilterPredicate, type FilterTransform, type FlagTableCell, GRAPH_ENCODING_RULES, type GraphChannelRule, type GraphEdge, type GraphEdgeLayout, type GraphEncoding, type GraphEncodingChannel, type GraphLayout, type GraphLayoutConfig, type GraphNode, type GraphNodeLayout, type GraphSpec, type GraphSpecWithoutData, type Gridline, type HeatmapColumnConfig, type HeatmapTableCell, type HeightClass, type ImageColumnConfig, type ImageTableCell, type LabelCandidate, type LabelConfig, type LabelDensity, type LabelMode, type LabelPriority, type LayerSpec, type LayoutStrategy, type LegendConfig, type LegendEntry, type LegendLayout, type LegendPosition, type LineMark, type LogicalAnd, type LogicalNot, type LogicalOr, MARK_DISPLAY_NAMES, MARK_ENCODING_RULES, MARK_TYPES, type Margins, type Mark, type MarkAria, type MarkDef, type MarkEvent, type MarkType, type MeasureTextFn, type NodeOverride, OFFSET_STRATEGIES, type OffsetStrategy, type PaginationState, type Point, type PointMark, type RangeAnnotation, type Rect, type RectMark, type RefLineAnnotation, type ResolveConfig, type ResolveMode, type ResolvedAnimation, type ResolvedAnnotation, type ResolvedChrome, type ResolvedChromeElement, type ResolvedColumn, type ResolvedLabel, type ResolvedTheme, type RuleMarkLayout, SEQUENTIAL_PALETTES, type SankeyEncoding, type SankeyLayout, type SankeyLinkColor, type SankeyLinkMark, type SankeyNodeAlign, type SankeyNodeMark, type SankeySpec, type SankeySpecWithoutData, type ScaleConfig, type ScaleType, type SequentialPalette, type SeriesStyle, type SortState, type SparklineColumnConfig, type SparklineData, type SparklineTableCell, type StoredVizSpec, type TableBuilderOptions, type TableCell, type TableCellBase, type TableLayout, type TableRow, type TableSpec, type TableSpecWithoutData, type TextAnnotation, type TextMarkLayout, type TextStyle, type TextTableCell, type Theme, type ThemeChromeDefaults, type ThemeColors, type ThemeConfig, type ThemeFontSizes, type ThemeFontWeights, type ThemeFonts, type ThemeSpacing, type TickMarkLayout, type TimeUnit, type TimeUnitTransform, type TooltipContent, type TooltipField, type Transform, type VizSpec, abbreviateNumber, adaptColorForDarkMode, adaptTheme, areaChart, barChart, buildD3Formatter, buildTemporalFormatter, checkPaletteDistinguishability, columnChart, computeChrome, computeLabelBounds, contrastRatio, dataTable, detectCollision, donutChart, dotChart, elementRef, estimateTextWidth, findAccessibleColor, formatDate, formatNumber, generateAltText, generateAriaLabels, generateDataTable, getBreakpoint, getHeightClass, getLayoutStrategy, inferFieldType, isChartSpec, isConditionalDef, isEncodingChannel, isGraphSpec, isLayerSpec, isRangeAnnotation, isRefLineAnnotation, isSankeySpec, isTableSpec, isTextAnnotation, lineChart, meetsAA, pieChart, resolveCollisions, resolveMarkDef, resolveMarkType, resolveTheme, scatterChart, simulateColorBlindness };
+export { type A11yMetadata, type AggregateOp, type AnimationConfig, type AnimationEase, type AnimationPhaseConfig, type AnimationSpec, type AnimationStagger, type Annotation, type AnnotationAnchor, type AnnotationOffset, type AnnotationPosition, type ArcMark, type AreaMark, type AxisConfig, type AxisLabelDensity, type AxisLayout, type AxisTick, BRAND_FONT_SIZE, BRAND_MIN_WIDTH, BRAND_RESERVE_WIDTH, type BarColumnConfig, type BarTableCell, type BinParams, type BinTransform, type Breakpoint, CATEGORICAL_PALETTE, CHART_ENCODING_RULES, CHART_TYPES, type CalculateExpression, type CalculateTransform, type CategoricalPalette, type CategoryColorsConfig, type CategoryTableCell, type CellStyle, type ChannelRule, type ChartBuilderOptions, type ChartEventHandlers, type ChartLayout, type ChartSpec, type ChartSpecOverride, type ChartSpecWithoutData, type ChartType, type Chrome, type ChromeDefaults, type ChromeKey, type ChromeMode, type ChromeText, type ChromeTextStyle, type ColorBlindnessType, type ColumnConfig, type CompileOptions, type CompileTableOptions, type Condition, type ConditionalValueDef, DEFAULT_THEME, DIVERGING_PALETTES, type DarkMode, type DataRow, type DateGranularity, type DivergingPalette, EXTENDED_OFFSET_STRATEGIES, type ElementEdit, type ElementRef, type Encoding, type EncodingChannel, type EncodingRule, type FieldPredicate, type FieldRef, type FieldType, type FilterPredicate, type FilterTransform, type FlagTableCell, GRAPH_ENCODING_RULES, type GradientDef, type GradientStop, type GraphChannelRule, type GraphEdge, type GraphEdgeLayout, type GraphEncoding, type GraphEncodingChannel, type GraphLayout, type GraphLayoutConfig, type GraphNode, type GraphNodeLayout, type GraphSpec, type GraphSpecWithoutData, type Gridline, type HeatmapColumnConfig, type HeatmapTableCell, type HeightClass, type ImageColumnConfig, type ImageTableCell, type LabelCandidate, type LabelConfig, type LabelDensity, type LabelMode, type LabelPriority, type LayerSpec, type LayoutStrategy, type LegendConfig, type LegendEntry, type LegendLayout, type LegendPosition, type LineMark, type LinearGradient, type LogicalAnd, type LogicalNot, type LogicalOr, MARK_DISPLAY_NAMES, MARK_ENCODING_RULES, MARK_TYPES, type Margins, type Mark, type MarkAria, type MarkDef, type MarkEvent, type MarkType, type MeasureTextFn, type NodeOverride, OFFSET_STRATEGIES, type OffsetStrategy, type PaginationState, type Point, type PointMark, type RadialGradient, type RangeAnnotation, type Rect, type RectMark, type RefLineAnnotation, type ResolveConfig, type ResolveMode, type ResolvedAnimation, type ResolvedAnnotation, type ResolvedChrome, type ResolvedChromeElement, type ResolvedColumn, type ResolvedLabel, type ResolvedTheme, type RuleMarkLayout, SEQUENTIAL_PALETTES, type SankeyEncoding, type SankeyLayout, type SankeyLinkColor, type SankeyLinkMark, type SankeyNodeAlign, type SankeyNodeMark, type SankeySpec, type SankeySpecWithoutData, type ScaleConfig, type ScaleType, type SequentialPalette, type SeriesStyle, type SortState, type SparklineColumnConfig, type SparklineData, type SparklineTableCell, type StoredVizSpec, type TableBuilderOptions, type TableCell, type TableCellBase, type TableLayout, type TableRow, type TableSpec, type TableSpecWithoutData, type TextAnnotation, type TextMarkLayout, type TextStyle, type TextTableCell, type Theme, type ThemeChromeDefaults, type ThemeColors, type ThemeConfig, type ThemeFontSizes, type ThemeFontWeights, type ThemeFonts, type ThemeSpacing, type TickMarkLayout, type TimeUnit, type TimeUnitTransform, type TooltipContent, type TooltipField, type Transform, type VizSpec, abbreviateNumber, adaptColorForDarkMode, adaptTheme, areaChart, barChart, buildD3Formatter, buildTemporalFormatter, checkPaletteDistinguishability, columnChart, computeChrome, computeLabelBounds, contrastRatio, dataTable, detectCollision, donutChart, dotChart, elementRef, estimateTextWidth, findAccessibleColor, formatDate, formatNumber, generateAltText, generateAriaLabels, generateDataTable, getBreakpoint, getHeightClass, getLayoutStrategy, getRepresentativeColor, inferFieldType, isChartSpec, isConditionalDef, isEncodingChannel, isGradientDef, isGraphSpec, isLayerSpec, isRangeAnnotation, isRefLineAnnotation, isSankeySpec, isTableSpec, isTextAnnotation, lineChart, meetsAA, pieChart, resolveCollisions, resolveMarkDef, resolveMarkType, resolveTheme, scatterChart, simulateColorBlindness };

package/dist/index.js

@@ -161,6 +161,14 @@ var elementRef = {
 };
 
 // src/types/spec.ts
+function isGradientDef(value) {
+  return typeof value === "object" && value !== null && "gradient" in value && "stops" in value && (value.gradient === "linear" || value.gradient === "radial");
+}
+function getRepresentativeColor(fill) {
+  if (typeof fill === "string") return fill;
+  const stops = fill.stops;
+  return stops.length > 0 ? stops[stops.length - 1].color : "#000000";
+}
 function isEncodingChannel(def) {
   if (!def) return false;
   return "field" in def && !("condition" in def);
@@ -1100,7 +1108,7 @@ function estimateLineCount(text, style, maxWidth, _measureText) {
   }
   return lines;
 }
-function computeChrome(chrome, theme, width, measureText, chromeMode = "full", padding) {
+function computeChrome(chrome, theme, width, measureText, chromeMode = "full", padding, watermark = true) {
   if (!chrome || chromeMode === "hidden") {
     return { topHeight: 0, bottomHeight: 0 };
   }
@@ -1154,7 +1162,7 @@ function computeChrome(chrome, theme, width, measureText, chromeMode = "full", p
   const topHeight = hasTopChrome ? topY - pad2 + theme.spacing.chromeToChart - chromeGap : 0;
   if (chromeMode === "compact") {
     let compactBottom = 0;
-    if (width >= BRAND_MIN_WIDTH) {
+    if (watermark && width >= BRAND_MIN_WIDTH) {
       const brandHeight = estimateTextHeight(BRAND_FONT_SIZE, 1);
       compactBottom = theme.spacing.chartToFooter + brandHeight + pad2;
     }
@@ -1164,7 +1172,8 @@ function computeChrome(chrome, theme, width, measureText, chromeMode = "full", p
       ...topElements
     };
   }
-  const bottomMaxWidth = maxWidth - BRAND_RESERVE_WIDTH;
+  const shouldReserveBrandWidth = watermark && width >= BRAND_MIN_WIDTH;
+  const bottomMaxWidth = maxWidth - (shouldReserveBrandWidth ? BRAND_RESERVE_WIDTH : 0);
   const bottomElements = {};
   let bottomHeight = 0;
   const bottomItems = [];
@@ -1215,7 +1224,7 @@ function computeChrome(chrome, theme, width, measureText, chromeMode = "full", p
       bottomHeight += height + chromeGap;
     }
     bottomHeight -= chromeGap;
-    if (width >= BRAND_MIN_WIDTH) {
+    if (watermark && width >= BRAND_MIN_WIDTH) {
       const brandHeight = estimateTextHeight(BRAND_FONT_SIZE, 1);
       const contentBelowFirstItem = bottomHeight - theme.spacing.chartToFooter;
       if (brandHeight > contentBelowFirstItem) {
@@ -1223,7 +1232,7 @@ function computeChrome(chrome, theme, width, measureText, chromeMode = "full", p
       }
     }
     bottomHeight += pad2;
-  } else if (width >= BRAND_MIN_WIDTH) {
+  } else if (watermark && width >= BRAND_MIN_WIDTH) {
     const brandHeight = estimateTextHeight(BRAND_FONT_SIZE, 1);
     bottomHeight = theme.spacing.chartToFooter + brandHeight + pad2;
   }
@@ -2782,10 +2791,12 @@ export {
   getBreakpoint,
   getHeightClass,
   getLayoutStrategy,
+  getRepresentativeColor,
   inferFieldType,
   isChartSpec,
   isConditionalDef,
   isEncodingChannel,
+  isGradientDef,
   isGraphSpec,
   isLayerSpec,
   isRangeAnnotation,