@blueprint-chart/lib 1.8.3 → 2.1.0

package/dist/render/chart-a11y.d.ts

@@ -0,0 +1,14 @@
+import { ChartData, FrameOptions } from '../charts/types';
+export interface ChartAccessibility {
+    /** Accessible name: what a screen reader announces for the graphic. */
+    label: string;
+    /** Long description: the author's own, then a summary of the plotted data. */
+    description: string;
+}
+export declare function buildChartAccessibility(chartType: string, frame: FrameOptions | null | undefined, data: ChartData): ChartAccessibility;
+/**
+ * Without this the plot is an unlabelled pile of shapes: assistive technology
+ * walks into the marks and announces nothing about the graphic. `role="img"`
+ * collapses the subtree to one node, and `aria-label` names it.
+ */
+export declare function applyChartAccessibility(svg: SVGSVGElement, a11y: ChartAccessibility): void;

package/dist/render/frame-svg.d.ts

@@ -0,0 +1,51 @@
+import { FrameOptions } from '../charts/types';
+import { ChartAccessibility } from './chart-a11y';
+export interface FrameSvgTextBlock {
+    text: string;
+    x: number;
+    y: number;
+    fontSize: number;
+    fontWeight?: string;
+    fontStyle?: string;
+    fontFamily?: string;
+    fill?: string;
+    anchor?: 'start' | 'middle' | 'end';
+}
+export interface FrameSvgPlot {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface FrameSvgLayout {
+    width: number;
+    height: number;
+    plot: FrameSvgPlot;
+    blocks: FrameSvgTextBlock[];
+    background: string | null;
+    color: string;
+    fontFamily: string;
+}
+export interface FrameTheme {
+    background: string;
+    color: string;
+}
+export interface FrameSvgLayoutOptions {
+    width: number;
+    height: number;
+    frame?: FrameOptions | null;
+    theme?: string;
+}
+export declare function resolveFrameTheme(theme?: string): FrameTheme;
+/**
+ * Lay the frame chrome out in SVG user units and reserve what is left for the
+ * plot. The caller renders the chart at `plot.width` x `plot.height` and hands
+ * the markup back to `buildFrameSvg`.
+ */
+export declare function layoutFrameSvg(opts: FrameSvgLayoutOptions): FrameSvgLayout;
+/**
+ * Compose the frame chrome and a rendered plot into one standalone SVG. The
+ * chrome is native `<text>`, so the result survives rasterization and a bare
+ * `.svg` file with no stylesheet.
+ */
+export declare function buildFrameSvg(layout: FrameSvgLayout, plotSvg: string, a11y: ChartAccessibility): string;

package/dist/render/index.d.ts

@@ -6,3 +6,6 @@ export type { ChartDefinition, RenderOptions, ResolvedChartState } from './types
 export { render } from './public-render';
 export type { ChartHandle, RenderApiOptions, OutputOptions } from './public-render';
 export { ChartParseError, PngBrowserUnsupportedError, MissingNodeRenderDepsError } from './errors';
+export { buildFrameSvg } from './frame-svg';
+export type { FrameSvgLayout, FrameSvgTextBlock, FrameSvgPlot } from './frame-svg';
+export type { ChartAccessibility } from './chart-a11y';

package/dist/render/post-render.d.ts

@@ -1,6 +1,8 @@
 import { LayoutResult } from './layout-constraints';
+import { ChartAccessibility } from './chart-a11y';
 interface PostRenderArgs {
     theme?: string;
+    accessibility?: ChartAccessibility;
 }
 export declare function applyPostRender(container: HTMLElement, args: PostRenderArgs, layout: LayoutResult): void;
 export {};