Vega is a visualization grammar, a declarative format for creating, saving, and sharing interactive visualization designs. With Vega you can describe data visualizations in a JSON format, and generate interactive views using either HTML5 Canvas or SVG.
For a basic setup allowing you to build Vega and run examples:
yarnto install dependencies for all packages. If you don't have yarn installed, see https://yarnpkg.com/en/docs/install. We use Yarn workspaces to manage multiple packages within this monorepo.
- Once installation is complete, run
yarn testto run test cases, or run
yarn buildto build output files for all packages.
- After running either
yarn build, run
yarn serveto launch a local web server — your default browser will open and you can browse to the
"test"folder to view test specifications.
This repository includes the Vega website and documentation in the
docs folder. To launch the website locally, first run
bundle install in the
docs folder to install the necessary Jekyll libraries. Afterwards, use
yarn docs to build the documentation and launch a local webserver. After launching, you can open
http://127.0.0.1:4000/vega/ to see the website.
For backwards compatibility, Vega includes a babel-ified ES5-compatible version of the code in
packages/vega/build-es5 directory. Older browser would also require several polyfill libraries:
<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/7.4.4/polyfill.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/[email protected]/runtime.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/fetch.umd.min.js"></script>