@opendata-ai/openchart-core 7.7.0 → 7.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opendata-ai/openchart-core",
-  "version": "7.7.0",
+  "version": "7.9.0",
   "description": "Types, theme, colors, accessibility, and utilities for openchart",
   "license": "Apache-2.0",
   "author": "Riley Hilliard",

package/src/types/index.ts

@@ -70,6 +70,7 @@ export type {
   Rect,
   RectMark,
   ResolvedAnimation,
+  ResolvedAnimationPhase,
   ResolvedAnnotation,
   ResolvedChrome,
   ResolvedChromeElement,

package/src/types/layout.ts

@@ -211,11 +211,18 @@ export interface MarkAria {
  */
 export interface LineMark {
   type: 'line';
+  /** Stable identity key for data-update transitions. */
+  key?: string;
+  /** Per-point identity keys parallel to `points`, for data-update transitions. */
+  pointKeys?: string[];
   /** Ordered array of points defining the line path. */
   points: Point[];
   /** Pre-computed SVG path string (D3 monotone curve). When present, renderers
    *  should use this instead of reconstructing straight M/L segments from points. */
   path?: string;
+  /** Curve interpolation method used to build the path. Stored so the transition
+   *  driver can reconstruct paths from interpolated point positions. */
+  interpolate?: string;
   /** Stroke color. */
   stroke: string;
   /** Stroke width in pixels. */
@@ -254,6 +261,10 @@ export interface LineMark {
  */
 export interface AreaMark {
   type: 'area';
+  /** Stable identity key for data-update transitions. */
+  key?: string;
+  /** Per-point identity keys parallel to `topPoints`, for data-update transitions. */
+  pointKeys?: string[];
   /** Upper boundary points. */
   topPoints: Point[];
   /** Lower boundary points (baseline, usually y=0). */
@@ -262,6 +273,8 @@ export interface AreaMark {
   path: string;
   /** SVG path string for just the top boundary (for stroking the data line only). */
   topPath: string;
+  /** Curve interpolation method used to build the path. */
+  interpolate?: string;
   /** Fill color or gradient. */
   fill: string | GradientDef;
   /** Fill opacity. */
@@ -298,6 +311,8 @@ export interface AreaMark {
  */
 export interface RectMark {
   type: 'rect';
+  /** Stable identity key for data-update transitions. */
+  key?: string;
   /** X position. */
   x: number;
   /** Y position. */
@@ -371,6 +386,8 @@ export interface ArcMark {
   label?: ResolvedLabel;
   /** Accessibility attributes. */
   aria: MarkAria;
+  /** Stable identity key for data-update transitions. */
+  key?: string;
   /** Index for stagger animation ordering. */
   animationIndex?: number;
 }
@@ -381,6 +398,8 @@ export interface ArcMark {
  */
 export interface PointMark {
   type: 'point';
+  /** Stable identity key for data-update transitions. */
+  key?: string;
   /** Center x position. */
   cx: number;
   /** Center y position. */
@@ -413,6 +432,8 @@ export interface PointMark {
  */
 export interface TextMarkLayout {
   type: 'textMark';
+  /** Stable identity key for data-update transitions. */
+  key?: string;
   /** X position. */
   x: number;
   /** Y position. */
@@ -449,6 +470,8 @@ export interface TextMarkLayout {
  */
 export interface RuleMarkLayout {
   type: 'rule';
+  /** Stable identity key for data-update transitions. */
+  key?: string;
   /** Start x position. */
   x1: number;
   /** Start y position. */
@@ -481,6 +504,8 @@ export interface RuleMarkLayout {
  */
 export interface TickMarkLayout {
   type: 'tick';
+  /** Stable identity key for data-update transitions. */
+  key?: string;
   /** X position. */
   x: number;
   /** Y position. */
@@ -815,10 +840,8 @@ export interface A11yMetadata {
 // Animation (resolved)
 // ---------------------------------------------------------------------------
 
-/** Resolved entrance animation config with all defaults applied. */
-export interface ResolvedAnimation {
-  /** Whether entrance animation is enabled. */
-  enabled: boolean;
+/** One fully-resolved animation phase. */
+export interface ResolvedAnimationPhase {
   /** Duration in ms. */
   duration: number;
   /** Easing preset name. */
@@ -827,6 +850,16 @@ export interface ResolvedAnimation {
   staggerDelay: number;
   /** Stagger ordering. */
   staggerOrder: 'index' | 'value' | 'reverse';
+}
+
+/** Resolved animation config. A phase is present iff that phase is enabled. */
+export interface ResolvedAnimation {
+  /** Entrance animation phase. Present when enter animation is enabled. */
+  enter?: ResolvedAnimationPhase;
+  /** Data-update transition phase. Present when update animation is enabled. */
+  update?: ResolvedAnimationPhase;
+  /** Exit animation phase. Present when exit animation is enabled. */
+  exit?: ResolvedAnimationPhase;
   /** Delay before annotations animate in (ms after marks). */
   annotationDelay: number;
 }

package/src/types/spec.ts

@@ -488,6 +488,12 @@ export interface Encoding<TData extends DataRow = DataRow> {
    * Useful when you want separate lines per category but don't need the color to differ.
    */
   detail?: EncodingChannel<TData>;
+  /**
+   * Identity channel for data-update transitions. Maps a field whose value
+   * uniquely identifies each datum across updates. Mirrors Vega-Lite's key channel.
+   * Not visually encoded. Optional: charts derive sensible default keys.
+   */
+  key?: EncodingChannel<TData>;
   /**
    * Secondary x position. Used with `x` to define a horizontal span (rect marks, error bars).
    * Both `x` and `x2` must be quantitative.
@@ -1158,15 +1164,13 @@ export interface AnimationPhaseConfig {
 /**
  * Full animation config object. Structured as enter/update/exit phases
  * following Vega's encoding set model.
- *
- * v1 implements enter only. update and exit reserved for v2.
  */
 export interface AnimationConfig {
   /** Entrance animation when chart first renders. */
   enter?: AnimationPhaseConfig | boolean;
-  /** Transition animation when data updates. Reserved for v2. */
+  /** Transition animation when data updates. */
   update?: AnimationPhaseConfig | boolean;
-  /** Exit animation when marks are removed. Reserved for v2. */
+  /** Exit animation when marks are removed. */
   exit?: AnimationPhaseConfig | boolean;
   /** Delay before annotations animate in (ms after marks). Default: 200. */
   annotationDelay?: number;