https://github.com/netbek/finch
A Vega-Lite specification generator for JavaScript
https://github.com/netbek/finch
dataviz javascript vega vega-lite vega-lite-spec
Last synced: 6 months ago
JSON representation
A Vega-Lite specification generator for JavaScript
- Host: GitHub
- URL: https://github.com/netbek/finch
- Owner: netbek
- License: agpl-3.0
- Created: 2018-04-30T10:32:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T02:42:39.000Z (almost 3 years ago)
- Last Synced: 2025-02-07T20:32:50.783Z (8 months ago)
- Topics: dataviz, javascript, vega, vega-lite, vega-lite-spec
- Language: JavaScript
- Homepage: https://netbek.github.io/finch
- Size: 4.14 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Finch
A Vega-Lite specification generator for JavaScript.
## Examples
[netbek.github.io/finch](https://netbek.github.io/finch)
## Installation
1. Install Finch using [`npm`](https://www.npmjs.com/):
```shell
npm i @netbek/finch
```
2. If you use a module bundler, e.g. Webpack, then import the module:
```javascript
import {vl} from '@netbek/finch';
```
If you don't use a module bundler, then add the script to your HTML document to export the `finch` global variable:
```html
```
## Usage
```html
var spec = finch.vl().spec;
vegaEmbed('#vis', spec);
```
See [the examples](https://netbek.github.io/finch), in lieu of an API reference.
## Credit
* [To-Vega](https://github.com/gjmcn/to-vega) - Primary inspiration for API. Finch aims to make view composition easier, and provide macros for composite plots, e.g. pair plot (seaborn).
* [Altair](https://github.com/altair-viz/altair)
* [seaborn](https://github.com/mwaskom/seaborn)
* [Financial Times Visual Vocabulary](https://github.com/ft-interactive/chart-doctor/tree/master/visual-vocabulary) - Inspiration for organisation of examples.
* [Tufte CSS](https://github.com/edwardtufte/tufte-css)
## Resources
* [Vega-Lite: specifications](https://vega.github.io/vega-lite/docs/spec.html)
* [Vega-Lite: theme configuration](https://vega.github.io/vega-lite/docs/config.html)
## Development
* [#2280 JavaScript Syntax for Vega-Lite (similar to Altair)](https://github.com/vega/vega-lite/issues/2280)
## License
Copyright (c) 2018 Hein Bekker. Licensed under the GNU Affero General Public License, version 3.