Repository files navigation

TheVega editor is a web application for authoring and testingVega andVega-Lite visualizations. It includes a number of example specifications that showcase both the visual encodings and interaction techniques. It is deployed athttps://vega.github.io/editor/.

We integrated a back-end service athttps://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 athttps://github.com/vega/editor-backend.

You can reset the Vega Editor by going tohttps://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 haveNode.js and npm,bash,curl, andtar 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 ...

1. Install the dependencies:
   $ npm install

   • If you are running into issues with installing canvas, follow thecanvas installation guide.

2. Launch the local web server:
   $ npm start

3. The local web server will be accessible viahttp://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, runnpm link in the directory of the library that you want to link. Then, in this directory runnpm link <name of library>, e.g.npm link vega ornpm link vega-lite.

For example, to link Vega, run

cd VEGA_DIRnpm linkcd VEGA_LITE_DIRnpm linkcd VEGA_EDITOR_DIRnpm link veganpm link vega-lite

The Vega editor supportsReact Developer Tools andRedux DevTools.

Build images withnpm run generate-example-images.

We welcome contributions and promptly review pull requests. For instructions about how to contribute, please follow theVega-Lite contributing guidelines.

Run the publish action athttps://github.com/vega/editor/actions/workflows/publish.yml.