The Vega editor is a web application for authoring and testing Vega and Vega-Lite visualizations. It includes a number of example specifications that showcase both the visual encodings and interaction techniques. It is deployed at https://vega.github.io/editor/.
We integrated a back-end service at https://vega-editor-backend.vercel.app/ which lets a user log in through GitHub so that they can access his/her personal gists. The code for the backend is at https://github.com/vega/editor-backend.
You can reset the Vega Editor by going to https://vega.github.io/editor/#/reset and clicking the reset button. This will reset the saved editor state.
sudo docker run -it --rm -p 1234:1234 node:21 bash -xc 'mkdir -p vega/editor && git clone --depth=1 https://github.com/vega/editor.git vega/editor && cd vega/editor && npm install && npm start'
We assume you have Node.js and npm, bash
, curl
, and tar
installed.
Your working copy of this git repository must be located at least two levels below the system root /
.
E.g. /home/user/editor
or /vega/editor
, but not /editor
.
Inside your working copy ...
-
Install the dependencies:
$ npm install
- If you are running into issues with installing canvas, follow the canvas installation guide.
-
Launch the local web server:
$ npm start
-
The local web server will be accessible via http://localhost:1234.
The editor is useful for testing if you are involved in Vega and Vega-Lite development. To use Vega, Vega-Lite, or Vega Datasets from another directory on your computer, you need to link it. For this, run npm link
in the directory of the library that you want to link. Then, in this directory run npm link <name of library>
, e.g. npm link vega
or npm link vega-lite
.
For example, to link Vega, run
cd VEGA_DIR
npm link
cd VEGA_LITE_DIR
npm link
cd VEGA_EDITOR_DIR
npm link vega
npm link vega-lite
The Vega editor supports React Developer Tools and Redux DevTools.
Build images with npm run generate-example-images
.
We welcome contributions and promptly review pull requests. For instructions about how to contribute, please follow the Vega-Lite contributing guidelines.
Run the publish action at https://github.com/vega/editor/actions/workflows/publish.yml.