README.md

SSR extension for G2 5.0

This extension package provides SSR support for G2 5.0, which supports canvas rendering in server side.

Usage

Install

npm install @antv/g2-ssr

Render in JavaScript API

For complete options, please refer to G2 Spec

import { createChart } from '@antv/g2-ssr';

const chart = await createChart({
  width: 640,
  height: 480,
  imageType: 'png', // or 'jpeg'
  // chart spec
});

chart.exportToFile('chart');
// -> chart.png

chart.toBuffer();
// -> get buffer

Render in CLI

npx g2-ssr export -i [chart-spec].json -o ./chart

Export SVG / PDF

When render in JavaScript API, you can pass outputType option to export SVG or PDF.

const chart = await createChart({
  width: 640,
  height: 480,
  outputType: 'svg', // or 'pdf'
  // chart spec
});

When render in CLI, you can pass -t or --type option to export SVG or PDF.

Use Plugins

When using G2-SSR, you can also use G render plugins. Here's how to use plugins in server-side rendering:

import { createChart } from '@antv/g2-ssr';
import { Plugin as RoughCanvasPlugin } from '@antv/g-plugin-rough-canvas-renderer';

const chart = await createChart({
  width: 500,
  height: 500,
  renderPlugins: [new RoughCanvasPlugin()],
  data: {
    // data
  },
});

npx g2-ssr export -i [chart-spec].json -o ./file -t pdf

License

MIT