https://github.com/vega/vega-lite-api

A JavaScript API for Vega-Lite.
https://github.com/vega/vega-lite-api

Last synced: 5 days ago
JSON representation

A JavaScript API for Vega-Lite.

• Host: GitHub
• URL: https://github.com/vega/vega-lite-api
• Owner: vega
• License: bsd-3-clause
• Created: 2019-03-22T22:16:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-08T06:57:09.000Z (over 1 year ago)
• Last Synced: 2024-09-19T07:42:35.310Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://observablehq.com/@vega/vega-lite-api
• Size: 1.28 MB
• Stars: 211
• Watchers: 8
• Forks: 17
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-d3 - vega-lite-api - A JavaScript API for Vega-Lite. (Charts)
• awesome-d3 - vega-lite-api - A JavaScript API for Vega-Lite. (Charts)

README

        
# Vega-Lite API 

[![npm version](https://img.shields.io/npm/v/vega-lite-api.svg)](https://www.npmjs.com/package/vega-lite-api)

[![Build Status](https://github.com/vega/vega-lite-api/workflows/Test/badge.svg)](https://github.com/vega/vega-lite-api/actions)

![Gallery Image](https://vega.github.io/vega-lite/static/teaser.png)

A JavaScript API for creating Vega-Lite JSON specifications. [Vega-Lite](https://vega.github.io/vega-lite/) is a high-level grammar for visual analysis that generates complete [Vega](https://vega.github.io/) specifications.

With the Vega-Lite API, you can write JavaScript code like this:

```js

vl.markBar().data('data/movies.json').encode(

  vl.x().fieldQ('IMDB_Rating').bin(true),

  vl.y().count()

)

```

To produce Vega-Lite JSON like this:

```json

{

  "mark": "bar",

  "data": {"url": "data/movies.json"},

  "encoding": {

    "x": {

      "bin": true,

      "field": "IMDB_Rating",

      "type": "quantitative"

    },

    "y": {

      "aggregate": "count",

      "type": "quantitative"

    }

  }

}

```

To get started with the Vega-Lite API, see these Observable notebooks:

- [Introduction to Vega-Lite](https://observablehq.com/@uwdata/introduction-to-vega-lite)

- [Vega-Lite API](https://observablehq.com/@vega/vega-lite-api-v5)

- [Vega-Lite API Collection](https://observablehq.com/collection/@vega/vega-lite-api)

## Build Instructions

For a basic setup allowing you to build the API and run tests:

- Clone `https://github.com/vega/vega-lite-api`.

- Run `yarn` to install dependencies for all packages. If you don't have yarn installed, see https://yarnpkg.com/en/docs/install.

- Once installation is complete, run `yarn build` to build the API generator and generate API source code in the `src` directory. Run `yarn test` to additionally run the test suite.

## API Reference

See the [Vega-Lite JavaScript API Reference](https://vega.github.io/vega-lite-api/api).