roughViz.js

Reusable JavaScript library for creating sketchy/hand-drawn styled charts i...

README

[![npm version](https://badge.fury.io/js/rough-viz.svg)](https://badge.fury.io/js/rough-viz)

roughViz.js is a reusable JavaScript library for creating sketchy/hand-drawn styled charts in the browser, based on D3v5, roughjs, and handy.

Why?

Use these charts where the communication goal is to show intent or generality, and not absolute precision. Or just because they're fun and look weird.

Features

Chart Types (more to come!)

Bar (roughViz.Bar) API. Example.
Horizontal Bar (roughViz.BarH) API. Example.
Donut (roughViz.Donut) API. Example.
Line (roughViz.Line) API. Example.
Pie (roughViz.Pie) API. Example.
Scatter (roughViz.Scatter) API. Example.
Stacked Bar (roughViz.StackedBar) API. Example.

Apply the features of roughjs to each chart:

roughness:

fillStyle fillStyle examples

fillWeight

As well as additional chart-specific options (see API below)

Installation

Via CDN (expose the roughViz global in html):

``` html
<script src="https://unpkg.com/rough-viz@1.0.6"></script>
```

Via npm:

```sh
npm install rough-viz
```

Want to use with React? There's a wrapper!:

```sh
npm install react-roughviz
```

Want to use with Vue? There's a wrapper!:

```sh
npm install vue-roughviz
```

Want to use it with Python? Go crazy:

```sh
pip install py-roughviz
```

How to use

Create some container elements, one for each chart:

``` html
!--you can name each id whatever you want -->
<div id="viz0"></div>
<div id="viz1"></div>
```

In the javascript, just create charts, referencing the desired container:

``` js
// create Bar chart from csv file, using default options
new roughViz.Bar({
element: '#viz0', // container selection
data: 'https://raw.githubusercontent.com/jwilber/random_data/master/flavors.csv',
labels: 'flavor',
values: 'price'
});
// create Donut chart using defined data & customize plot options
new roughViz.Donut(
{
element: '#viz1',
data: {
labels: ['North', 'South', 'East', 'West'],
values: [10, 5, 8, 3]
},
title: "Regions",
width: window.innerWidth / 4,
roughness: 8,
colors: ['red', 'orange', 'blue', 'skyblue'],
stroke: 'black',
strokeWidth: 3,
fillStyle: 'cross-hatch',
fillWeight: 3.5,
}
);
```

API

### roughViz.Bar

Required

- element [string]: Id or class of container element.

- data: Data with which to construct chart.

Can be either an object or string.

- If object: must contain labels and values keys:

``` js
new roughViz.Bar({
element: '.viz',
data: {labels: ['a', 'b'], values: [10, 20]}
})
```

- If string: must be a path/url to a csv or tsv, and you must also specify the labels and values as separate attributes that represent columns in said file:

``` js
new roughViz.Bar({
element: '#viz0',
data: 'stringToDataUrl.csv',
labels: 'nameOfLabelsColumn',
values: 'nameOfValuesColumn',
})
```

Optional

- axisFontSize [string]: Font-size for axes' labels. Default: '1rem'.

- axisRoughness [number]: Roughness for x & y axes. Default: 0.5.

- axisStrokeWidth [number]: Stroke-width for x & y axes. Default: 0.5.

- bowing [number]: Chart bowing. Default: 0.

- color [string]: Color for each bar. Default: 'skyblue'.

- fillStyle [string]: Bar fill-style. Should be one of fillStyles shown above.

- fillWeight [number]: Weight of inner paths' color. Default: 0.5.

- font: Font-family to use. You can use 0 or gaegu to use Gaegu, or 1 or indie flower to use Indie Flower. Or feed it something else. Default: Gaegu.

- highlight [string]: Color for each bar on hover. Default: 'coral'.

- innerStrokeWidth [number]: Stroke-width for paths inside bars. Default: 1.

- interactive [boolean]: Whether or not chart is interactive. Default: true.

- labelFontSize [string]: Font-size for axes' labels. Default: '1rem'.

- margin [object]: Margin object. Default: {top: 50, right: 20, bottom: 70, left: 100}

- padding [number]: Padding between bars. Default: 0.1.

- roughness [number]: Roughness level of chart. Default: 1.

- simplification [number]: Chart simplification. Default 0.2.

- stroke [string]: Color of bars' stroke. Default: black.

- strokeWidth [number]: Size of bars' stroke. Default: 1.

- title [string]: Chart title. Optional.

- titleFontSize [string]: Font-size for chart title. Default: '1rem'.

- tooltipFontSize [string]: Font-size for tooltip. Default: '0.95rem'.

- xLabel [string]: Label for x-axis.

- yLabel [string]: Label for y-axis.

### roughViz.BarH