@graphysdk/node-renderer

Render a Graphy chart to a PNG in Node.js.

Learn more at graphy.dev.

Install

npm install @graphysdk/node-renderer @graphysdk/viz-engine

Usage

import { renderGraphToPng } from '@graphysdk/node-renderer';
import { createSpec, geom, pipe, scale } from '@graphysdk/viz-engine';

const input = pipe(createSpec({ x: 'category', y: 'value' }), geom.bar(), scale.x(), scale.y());

const png = await renderGraphToPng({ input, data }, { width: 1200, height: 800, colorScheme: 'light' });

Docs

• Quickstart — React apps start with @graphysdk/react

GraphConfig

If you already have a stored chart config ({ type, data, … }), render it with renderChartConfigToPng. Check canRenderConfigWithCanvas first — some chart types are not supported.

import { canRenderConfigWithCanvas, renderChartConfigToPng } from '@graphysdk/node-renderer';

const capability = canRenderConfigWithCanvas(storedConfig);
if (!capability.ok) {
  // use another export path
}

const png = await renderChartConfigToPng(storedConfig, { width: 1200, height: 800, colorScheme: 'light' });

Supported types: column, columnStacked, columnStackedFill, bar, barStacked, barStackedFill, line, areaStacked, pie, donut, scatter, bubble, combo.

Not supported: funnel, heatmap, waterfall, mekko, table.

Annotations, theme overrides, series styles, and headline numbers may be dropped or simplified in the PNG.

The package also exports CANVAS_SUPPORTED_GRAPH_TYPES and canRenderConfigWithCanvas for checks in your own code.

Fonts

Latin Inter 400 and 600 load automatically.

To use your own fonts, pass fonts when rendering or call registerFont({ family, data }).

Serverless

This package uses a native canvas module. Install it as a normal dependency — do not bundle it into your function.

On Vercel with Nitro, include these in traceDeps so binaries and fonts are copied into the function:

traceDeps: ['@graphysdk/node-renderer', '@napi-rs/canvas', '@fontsource/inter'];

Serves preset chart PNGs at http://localhost:4310 (see src/dev/server.ts).

Agent skills

Install the Graphy agent skills from github.com/graphysdk/skills to set up the SDK and author charts from Cursor, Claude Code, and other coding agents.

Licence

This package is available under PolyForm Noncommercial, Small Business, or a 32-day Free Trial. Free Trial is local or internal evaluation only — it does not cover a public page. See what you can do under the trial.

For a commercial licence, talk to us.

Support

Questions and community help: Discord.