Compiling Vega-Lite to Vega

If you would rather compile your Vega-Lite specifications into Vega, you can use Vega-Lite’s included JavaScript compiler or one of several bundled command line utilities.

First install Vega-Lite using npm (npm install vega-lite) or by downloading the latest release. (For the latter, you will also have to download Vega and D3.)

Using JavaScript

If you want access to the compiled Vega spec from a JavaScript program, you can compile your Vega-Lite spec using the vegaLite.compile function.

var vgSpec = vegaLite.compile(vlSpec, options).spec;

If provided, the options argument should be an object with one or more of the following properties:

Customized Configuration

You can specify a config object as a property of the compile function’s options argument. Note that configuration properties provided via the config property in the Vega-Lite specification, will override the configurations passed in through the compile function.

Customized Logging

By default, warnings and other messages are printed to the JavaScript console (via console.log/warn methods). To redirect the log messages, you can pass a customize logger to the compile function.

var vgSpec = vegaLite.compile(vlSpec, {logger: logger}).spec;

A custom logger should implement the following interface:

interface LoggerInterface {
  level: (_: number) => number | LoggerInterface;
  warn(...args: any[]): LoggerInterface;
  info(...args: any[]): LoggerInterface;
  debug(...args: any[]): LoggerInterface;
}

Customized Field Title Formatter

To customize how Vega-Lite generates axis or legend titles for a field definition, you can provide a titleFormat function as a property of the compile function’s options argument.

const vgSpec = vegaLite.compile(vlSpec, {
  titleFormat: function (fieldDef, config) {
    const fn = fieldDef.aggregate || fieldDef.timeUnit || (fieldDef.bin && 'bin');
    if (fn) {
      return `${fn.toUpperCase()}(${fieldDef.field})`;
    } else {
      return fieldDef.field;
    }
  }
}).spec;

From the Command Line

If you want to compile your Vega-Lite specs from the command line, we provide a set of scripts which make it easy to go from Vega-Lite to Vega, SVG, PNG, or PDF. These scripts are vl2vg, vl2png, vl2svg, and vl2pdf respectively.

Each script simply accepts your Vega-Lite specification as its first argument.

vl2svg spec.vl.json

You can also pass in data via stdin.

cat spec.vl.json | vl2svg

The vg2vg command supports an optional argument p that formats the generated Vega spec.

vl2vg spec.vl.json -p

The easiest way to run these commands is to use npx. npx will automatically run the commands from the local node_modules/.bin, or from a central cache, installing any packages needed in order for the commands to run. It Is not necessary to have Vega or Vega-Lite installed ahead of time for npx to work.

npx vl2vg spec.vl.json

If you want to use the scripts in your project, you can prefix the calls with node_modules/.bin/. Alternatively, you can install vega and vega-lite globally (although we do not recommend it).

If you get an error Error: CanvasRenderer is missing a valid canvas or context, please install the canvas package (or install vega-cli).

Using npx

To use npx, a tool to execute npm binaries, provide the required packages and choose the binary you want to run. For example, to run vl2png, run npx -p vega -p vega-lite vl2png --help.