# @netbek/finch

> A Vega-Lite specification generator for JavaScript

Latest version **0.0.10** (published 2019-01-07) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @netbek/finch
pnpm add @netbek/finch
yarn add @netbek/finch
bun add @netbek/finch
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.10 |
| Published | 2019-01-07 |
| First published | 2018-05-03 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 75.2 KB |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Hein Bekker |
| Maintainers | netbek |

## Links

- npm: https://www.npmjs.com/package/@netbek/finch
- Repository: https://github.com/netbek/finch
- Homepage: https://github.com/netbek/finch#readme
- Issues: https://github.com/netbek/finch/issues
- npm.io page: https://npm.io/package/@netbek/finch

## Dependencies (2)

- [vega](https://npm.io/package/vega.md) ^3.3.1
- [vega-lite](https://npm.io/package/vega-lite.md) ^2.4.1

## Recent versions

- 0.0.10 (latest) — 2019-01-07
- 0.0.9 — 2018-07-13
- 0.0.8 — 2018-05-06
- 0.0.7 — 2018-05-04
- 0.0.6 — 2018-05-04
- 0.0.5 — 2018-05-03
- 0.0.4 — 2018-05-03
- 0.0.3 — 2018-05-03
- 0.0.2 — 2018-05-03
- 0.0.1 — 2018-05-03

## 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
    <!-- Dependencies -->
    <script src="/path/to/vega/build/vega.min.js"></script>
    <script src="/path/to/vega-lite/build/vega-lite.min.js"></script>
    <script src="/path/to/vega-embed/build/vega-embed.min.js"></script>
    <!-- Finch -->
    <script src="/path/to/@netbek/finch/umd/finch.min.js"></script>
    ```

## Usage

```html
<div id="vis"></div>
<script>
  var spec = finch.vl().spec;
  vegaEmbed('#vis', spec);
</script>
```

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.

---
_Source: https://npm.io/package/@netbek/finch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._