@blueprint-chart/lib 0.3.0 → 0.4.0

package/README.md

@@ -10,6 +10,25 @@ npm install @blueprint-chart/lib
 
 ## Quick start
 
+### Node — write SVG and PNG to disk
+
+```ts
+import { render } from '@blueprint-chart/lib'
+import { writeFile } from 'node:fs/promises'
+
+const chart = await render(bpc)
+await writeFile('chart.svg', await chart.toSvg())
+await writeFile('chart.png', await chart.toPng({ width: 1200 }))
+```
+
+### Browser — mount and step scenes
+
+```ts
+const { mount, scene } = await render(bpc)
+mount('#chart')   // element or selector
+scene(2)          // advance to scene index 2
+```
+
 The simplest way to render a chart is the IIFE runtime, which auto-scans the document for embedded chart definitions and renders each one inline (inside a sandboxed iframe inserted before the script tag):
 
 ```html

package/dist/charts/value-label-fit.d.ts

@@ -0,0 +1,11 @@
+export interface ValueLabelFitInput {
+    text: string;
+    placement: 'inside' | 'outside';
+    orientation: 'vertical' | 'horizontal';
+    /** px extent along x (vertical bar: thickness; horizontal bar: length) */
+    barWidth: number;
+    /** px extent along y (vertical bar: length; horizontal bar: thickness) */
+    barHeight: number;
+}
+export declare function estimateLabelWidth(text: string): number;
+export declare function shouldRenderValueLabel(input: ValueLabelFitInput): boolean;

package/dist/dsl/serializer.d.ts

@@ -1,3 +1,4 @@
 import { ChartNode } from './types';
 export declare function serialize(ast: ChartNode): string;
+export declare function compactSerializeDeep(ast: ChartNode): string;
 export declare function compactSerialize(ast: ChartNode): string;

package/dist/index.d.ts

@@ -25,14 +25,15 @@ export { getCachedChart } from './charts/transition-cache';
 export { getCvdFilterId, createCvdSvgFilter, simulateCvdColor, checkCvdColors } from './charts/colorblind';
 export type { CvdType, CvdIssue } from './charts/colorblind';
 export { parse } from './dsl/parser';
-export { serialize, compactSerialize } from './dsl/serializer';
+export { serialize, compactSerialize, compactSerializeDeep } from './dsl/serializer';
 export { propertyMap, extractChartTypeOptions, dataEntriesToString, extractSceneOverrides, convertColorizes, convertHighlights, convertAreaFills, convertAnnotations, convertSeriesOverrides } from './dsl/converter';
 export type { AnnotationNode, AnnotationVisibilityNode, PointAnnotationNode, RangeAnnotationNode, FreeAnnotationNode, AreaFillNode, ChartNode, DataNode, ColorizeNode, HighlightNode, PropertyNode, SceneNode, SeriesNode, TransformNode } from './dsl/types';
 export { validateChart } from './dsl/validate';
 export type { ValidationIssue, ValidationResult } from './dsl/validate';
 export { samples } from './samples';
 export type { ChartSample } from './samples';
-export { renderBpc, renderChart, astToDefinition, resolveScene } from './render';
-export type { ChartDefinition, RenderOptions, ResolvedChartState } from './render';
+export { renderBpc, renderChart, astToDefinition, resolveScene, render } from './render';
+export type { ChartDefinition, RenderOptions, ResolvedChartState, ChartHandle, RenderApiOptions, OutputOptions } from './render';
+export { ChartParseError, PngBrowserUnsupportedError, MissingNodeRenderDepsError } from './render';
 export { SceneTransition, getSceneTransition, featureJoin, snapshotLiveAttrs, BC_TRANSITION_NAME, } from './transitions';
 export type { CommitOptions, TransitionMode, SceneTransitionState, FeatureRole, FeatureJoinConfig, AttrMap, AttrValue, } from './transitions';