@opendata-ai/openchart-vanilla 6.20.0 → 6.22.0

package/dist/index.d.ts

@@ -285,14 +285,13 @@ interface SankeyInstance {
 declare function createSankey(container: HTMLElement, spec: SankeySpec, options?: SankeyMountOptions): SankeyInstance;
 
 /**
- * SVG renderer: converts a ChartLayout into SVG DOM elements.
- *
- * Creates an <svg> element with viewBox matching layout dimensions,
- * renders chrome (title/subtitle/source), axes, marks, annotations,
- * and legend. All styling via inline SVG attributes from layout data.
+ * Mark rendering: dispatches to per-mark-type sub-renderers (line, area, rect,
+ * arc, point, text, rule, tick).
  *
- * Mark rendering dispatches per mark type with dedicated renderers
- * for line, area, rect, arc, and point marks.
+ * Mark renderers read module-level animation and gradient state so their
+ * signatures stay `(mark, index) => SVGElement`. Callers must invoke
+ * `setMarkRenderState()` before `renderMarks()` and `resetMarkRenderState()`
+ * after.
  */
 
 type MarkRenderer<T extends Mark> = (mark: T, index: number) => SVGElement;
@@ -301,6 +300,18 @@ type MarkRenderer<T extends Mark> = (mark: T, index: number) => SVGElement;
  * Built-in renderers are registered below for all chart types.
  */
 declare function registerMarkRenderer<T extends Mark>(type: T['type'], renderer: MarkRenderer<T>): void;
+
+/**
+ * SVG renderer: converts a ChartLayout into SVG DOM elements.
+ *
+ * Creates an <svg> element with viewBox matching layout dimensions,
+ * renders chrome (title/subtitle/source), axes, marks, annotations,
+ * and legend. All styling via inline SVG attributes from layout data.
+ *
+ * This file is the orchestrator only. Each rendering concern lives in its
+ * own module under `./renderers/`.
+ */
+
 /**
  * Render a compiled ChartLayout into an SVG element and append it to a container.
  *