@opendata-ai/openchart-core 8.4.1 → 8.5.1

package/dist/index.d.ts

@@ -4841,6 +4841,44 @@ interface GraphSpec {
     };
     /** Whether to show the OpenData watermark. Defaults to true. */
     watermark?: boolean;
+    /**
+     * Render in two or three dimensions. Defaults to `2` (the Canvas renderer).
+     *
+     * `3` renders with WebGL. The 3D renderer ships on its own subpath so
+     * three.js never enters the default bundle, and it must be imported before
+     * the graph mounts:
+     *
+     * ```ts
+     * import '@opendata-ai/openchart-vanilla/graph-3d';
+     * ```
+     *
+     * (Framework hosts import their own package's mirror of the subpath:
+     * `@opendata-ai/openchart-react/graph-3d`,
+     * `@opendata-ai/openchart-vue/graph-3d`,
+     * `@opendata-ai/openchart-svelte/graph-3d`.) Mounting a `dimensions: 3` spec
+     * without that import throws.
+     *
+     * 3D differs from 2D in these ways:
+     * - Labels use a fixed budget re-ranked by camera distance, not the 2D
+     *   priority declutter, so distant labels drop out.
+     * - The simulation runs on the main thread (no worker, no wall-clock warmup
+     *   budget).
+     * - Keyboard navigation, SVG export, `interaction.cursorRepulsion` and
+     *   `interaction.springyDrag` are unsupported. Each warns and is ignored.
+     *   (`layout.type` of `'radial'` or `'hierarchical'` is rejected by spec
+     *   validation in both dimensions, so it never reaches either renderer.)
+     * - `getCamera()` returns a pose rather than a zoom transform: `x`/`y` are
+     *   the look-at point in world units, alongside `position` and `target`. In
+     *   2D they are the zoom transform's translate in pixels. `onCameraChange`
+     *   carries the same payload, so persisted camera state has to be keyed on
+     *   the dimension it came from. Both are typed `GraphCamera` (vanilla), whose
+     *   `position`/`target` are optional because only 3D sets them.
+     * - A structural `update()` reheats the whole layout globally, so settled
+     *   nodes drift; 2D applies a local impulse instead.
+     * - Above 2000 nodes the spec warns and falls back to 2D.
+     * - `nodeOverrides[*].stroke` and `strokeWidth` are ignored (no ring).
+     */
+    dimensions?: 2 | 3;
 }
 /**
  * Resolution strategy for shared resources across layers.