Peity • progressive <svg> pie, donut, bar and line charts

# Peity

Peity (sounds like deity) is a jQuery plugin that converts an element's content into a `<svg>` mini pie 2/5 donut 5,2,3 line 5,3,9,6,5,9,7,3,5,2 or bar chart 5,3,9,6,5,9,7,3,5,2 and is compatible with any browser that supports `<svg>`: Chrome, Firefox, IE9+, Opera, Safari.

## Download version 3.3.0

Uncompressed 8.8Kb
  jquery.peity.js
Minified 3.6Kb (+gzipped 1.7Kb)
  jquery.peity.min.js
Source
  github.com/benpickles/peity

## Pie Charts

Call `peity("pie")` on a jQuery selection. There are two subtly different pie chart semantics, a "/" delimiter is assumed to mean "three out of five" and only the first two values will be drawn, otherwise all of the values are included in the chart and the total is the sum of all values.

You can also pass `delimiter`, `fill`, `height`, `radius` and `width` options. Passing a radius will set the correct width and height, the pie will always be a circle that fits the available space.

1/5 226/360 0.52/1.561 1,4 226,134 0.52,1.041 1,2,3,2,2

#### HTML

    <span class="pie">1/5</span>
    <span class="pie">226/360</span>
    <span class="pie">0.52/1.561</span>
    <span class="pie">1,4</span>
    <span class="pie">226,134</span>
    <span class="pie">0.52,1.041</span>
    <span class="pie">1,2,3,2,2</span>

#### JavaScript

    $("span.pie").peity("pie")

## Donut Charts

Donut charts are the same as pie charts and take the same options with an added `innerRadius` option which defaults to half the radius.

1/5 226/360 0.52/1.561 1,4 226,134 0.52,1.041 1,2,3,2,2

#### HTML

    <span class="donut">1/5</span>
    <span class="donut">226/360</span>
    <span class="donut">0.52/1.561</span>
    <span class="donut">1,4</span>
    <span class="donut">226,134</span>
    <span class="donut">0.52,1.041</span>
    <span class="donut">1,2,3,2,2</span>

#### JavaScript

    $('.donut').peity('donut')

## Line Charts

Line charts work on a comma-separated list of digits. Line charts can take the following options: `delimiter`, `fill`, `height`, `max`, `min`, `stroke`, `strokeWidth` and `width`.

5,3,9,6,5,9,7,3,5,2 5,3,2,-1,-3,-2,2,3,5,2 0,-3,-6,-4,-5,-4,-7,-3,-5,-2

#### HTML

    <span class="line">5,3,9,6,5,9,7,3,5,2</span>
    <span class="line">5,3,2,-1,-3,-2,2,3,5,2</span>
    <span class="line">0,-3,-6,-4,-5,-4,-7,-3,-5,-2</span>

#### JavaScript

    $(".line").peity("line")

## Bar Charts

Bar charts work in the same way as line charts and take the following options: `delimiter`, `fill`, `height`, `max`, `min`, `padding` and `width`.

5,3,9,6,5,9,7,3,5,2 5,3,2,-1,-3,-2,2,3,5,2 0,-3,-6,-4,-5,-4,-7,-3,-5,-2

#### HTML

    <span class="bar">5,3,9,6,5,9,7,3,5,2</span>
    <span class="bar">5,3,2,-1,-3,-2,2,3,5,2</span>
    <span class="bar">0,-3,-6,-4,-5,-4,-7,-3,-5,-2</span>

#### JavaScript

    $(".bar").peity("bar")

## data-* attributes

Data attributes can be used to pass custom settings per-chart - options explicitly passed to the `peity()` function take precedence over data-* attributes.

1/7 2/7 3/7 4/7 5/7 6/7 7/7

#### HTML

    <p class="data-attributes">
      <span data-peity='{ "fill": ["red", "#eeeeee"],    "innerRadius": 10, "radius": 40 }'>1/7</span>
      <span data-peity='{ "fill": ["orange", "#eeeeee"], "innerRadius": 14, "radius": 36 }'>2/7</span>
      <span data-peity='{ "fill": ["yellow", "#eeeeee"], "innerRadius": 16, "radius": 32 }'>3/7</span>
      <span data-peity='{ "fill": ["green", "#eeeeee"],  "innerRadius": 18, "radius": 28 }'>4/7</span>
      <span data-peity='{ "fill": ["blue", "#eeeeee"],   "innerRadius": 20, "radius": 24 }'>5/7</span>
      <span data-peity='{ "fill": ["indigo", "#eeeeee"], "innerRadius": 18, "radius": 20 }'>6/7</span>
      <span data-peity='{ "fill": ["violet", "#eeeeee"], "innerRadius": 15, "radius": 16 }'>7/7</span>
    </p>

#### JavaScript

    $(".data-attributes span").peity("donut")

## Setting Colours Dynamically

Pie, donut and bar chart colours can be defined dynamically based on the values of the chart. When passing an array its values are cycled, when passing a function it is called once for each value allowing you to define each bar or segment's colour. The callback is invoked with the value, its index, and the full array of values - the same arguments as the callback for `Array#forEach`.

5,3,9,6,5,9,7,3,5,2 5,3,2,-1,-3,-2,2,3,5,2 0,-3,-6,-4,-5,-4,-7,-3,-5,-2 4,7,6,5 5,3,9,6,5

#### HTML

    <span class="bar-colours-1">5,3,9,6,5,9,7,3,5,2</span>
    <span class="bar-colours-2">5,3,2,-1,-3,-2,2,3,5,2</span>
    <span class="bar-colours-3">0,-3,-6,-4,-5,-4,-7,-3,-5,-2</span>
    <span class="pie-colours-1">4,7,6,5</span>
    <span class="pie-colours-2">5,3,9,6,5</span>

#### JavaScript

    $(".bar-colours-1").peity("bar", {
      fill: ["red", "green", "blue"]
    })

    $(".bar-colours-2").peity("bar", {
      fill: function(value) {
        return value > 0 ? "green" : "red"
      }
    })

    $(".bar-colours-3").peity("bar", {
      fill: function(_, i, all) {
        var g = parseInt((i / all.length) * 255)
        return "rgb(255, " + g + ", 0)"
      }
    })

    $(".pie-colours-1").peity("pie", {
      fill: ["cyan", "magenta", "yellow", "black"]
    })

    $(".pie-colours-2").peity("pie", {
      fill: function(_, i, all) {
        var g = parseInt((i / all.length) * 255)
        return "rgb(255, " + g + ", 0)"
      }
    })

## Updating Charts

Charts can be updated by changing the the jQuery selection's text content and calling `change()` on it. The chart will be redrawn with the same options that were originally passed to it.

5,3,9,6,5,9,7,3,5,2,5,3,9,6,5,9,7,3,5,2

#### HTML

    <span class="updating-chart">5,3,9,6,5,9,7,3,5,2,5,3,9,6,5,9,7,3,5,2</span>

#### JavaScript

    var updatingChart = $(".updating-chart").peity("line", { width: 64 })

    setInterval(function() {
      var random = Math.round(Math.random() * 10)
      var values = updatingChart.text().split(",")
      values.shift()
      values.push(random)

      updatingChart
        .text(values.join(","))
        .change()
    }, 1000)

## Custom Charts

You can add a custom chart type by registering it with Peity with a name, defaults object, and custom chart drawing function which is called with an options object. See the existing charts for examples.

    $.fn.peity.register('custom', {
        option: defaults
      }, function(opts) {
        // Implementation.
      }
    )

## Events

Peity adds a "change" event trigger to your graph elements, so if you update their data your can regenerate one or more charts by triggering `change()` on them.

Nothing's happened yet.

#### HTML

    <ul>
      <li>
        <span class="graph"></span>
        <select>
          <option value="0">0</option>
          <option value="1">1</option>
          <option value="2">2</option>
          <option value="3">3</option>
          <option value="4" selected>4</option>
          <option value="5">5</option>
        </select>
      </li>
      <li>
        <span class="graph"></span>
        <select>
          <option value="0">0</option>
          <option value="1" selected>1</option>
          <option value="2">2</option>
          <option value="3">3</option>
          <option value="4">4</option>
          <option value="5">5</option>
        </select>
      </li>
      <li>
        <span class="graph"></span>
        <select>
          <option value="0">0</option>
          <option value="1">1</option>
          <option value="2">2</option>
          <option value="3" selected>3</option>
          <option value="4">4</option>
          <option value="5">5</option>
        </select>
      </li>
    </ul>

    <p id="notice">Nothing's happened yet.</p>

#### JavaScript

    $('select').change(function() {
      var text = $(this).val() + '/' + 5

      $(this)
        .siblings('span.graph')
        .text(text)
        .change()

      $('#notice').text('Chart updated: ' + text)
    }).change()

    $('span.graph').peity('pie')

## Default Settings

Defaults can be overridden globally like so:

    $.fn.peity.defaults.pie = {
      delimiter: null,
      fill: ["#ff9900", "#fff4dd", "#ffd592"],
      height: null,
      radius: 8,
      width: null
    }

    $.fn.peity.defaults.donut = {
      delimiter: null,
      fill: ["#ff9900", "#fff4dd", "#ffd592"],
      height: null,
      innerRadius: null,
      radius: 8,
      width: null
    }

    $.fn.peity.defaults.line = {
      delimiter: ",",
      fill: "#c6d9fd",
      height: 16,
      max: null,
      min: 0,
      stroke: "#4d89f9",
      strokeWidth: 1,
      width: 32
    }

    $.fn.peity.defaults.bar = {
      delimiter: ",",
      fill: ["#4d89f9"],
      height: 16,
      max: null,
      min: 0,
      padding: 0.1,
      width: 32
    }

## CHANGELOG

### Version 3.3.0 - 2018-01-18

- Expose an item’s value on bar and pie slice SVG nodes on the `data-value` attribute.

### Version 3.2.1 - 2016-10-10

- Ensure NPM package includes only required files.
- Now available in Packagist https://packagist.org/packages/benpickles/peity.
- No functional changes.

### Version 3.2.0 - 2015-4-17

- Add an `after` hook that can be used to decorate a chart.

### Version 3.1.2 - 2015-4-14

- Allow line charts with no fill, just the line.

### Version 3.1.1 - 2015-2-11

- Ensure a donut’s default inner radius honours percentage dimensions by deriving it from its calculated radius.

### Version 3.1.0 - 2015-1-19

- Bring back per-chart reading settings from data attributes but with a slightly different interface: all settings are stored on the `data-peity` attribute as JSON.

### Version 3.0.3 - 2015-1-16

- Don’t allow negative or zero values to blow up a pie chart.

### Version 3.0.2 - 2014-10-17

- Fix `max`/`min` option when it’s a string.

### Version 3.0.1 - 2014-10-16

- jQuery > 1.6.2 doesn’t like `undefined` being passed to `#attr()`.

### Version 3.0.0 - 2014-10-15

- Remove the ability to read options from data attributes.
- Add donut chart type.
- Switch from `diameter` pie chart option to `radius`.
- Expose the internally-used scale functions to the outside world.
- Rename `gap` bar chart option to `padding`. It is now specified as a portion of the width of each bar and is present on both sides.

### Version 2.0.5 - 2014-10-15

- Changes to make the minified version 147 bytes smaller!

### Version 2.0.4 - 2014-10-8

- Fix a null max argument being calculated as zero when all values are negative.
- Ensure that a null min argument means that the minimum is calculated from a chart’s values.

### Version 2.0.3 - 2014-4-29

- Don’t blow up drawing a line chart of all zeros.

### Version 2.0.2 - 2014-3-26

- Fix misaligned bar when its value is negative and equal to the minimum.

### Version 2.0.1 - 2014-1-22

- Ensure bars are positioned correctly when a bar chart’s values are all equal its minimum value.

### Version 2.0.0 - 2014-1-3

- Switch from `<canvas>` to `<svg>`.
- Update jQuery dependency from 1.4.4 to 1.6.2 due to problems fetching a `<svg>` element’s dimensions in Firefox.
- Rename `colour`/`colours` options to `fill`.
- Rename `spacing` bar chart option to `gap`.
- Rename `strokeColour` line chart option to `stroke`.

### Version 1.2.1 - 2013-11-21

- Ensure a line chart’s outline doesn’t spill off the canvas.

### Version 1.2.0 - 2013-3-11

- Easier CSS targeting of Peity-created canvas elements.
- Percentage dimensions (`width: "100%"`) now work.

### Version 1.1.2 - 2013-2-23

- Fix reference to `devicePixelRatio` - thanks @kcivey.

### Version 1.1.1 - 2013-2-5

- component.json for Bower.
- Finally in the jQuery plugin registry: http://plugins.jquery.com/peity/

### Version 1.1.0 - 2013-2-1

- Multiple calls to `peity()` on the same element now update the existing chart rather than creating a new one.
- Zero values in a bar chart are now present as a single-pixel bar.

### Version 1.0.0 - 2012-12-4

- Spacing between bars can now be configured.
- Pie charts can now be formed of more than 2 segments.
- The colours of bar and pie charts can now be set dynamically based on their value.
- Re-write of the internals so that the actual `<canvas>` element is only created once and `$.wrapInner` is no longer used to contain everything in a separate `<span>`.
- Peity now automatically reads data-* attributes and passes them as options when instantiating a chart. @buunguyen

### Version 0.6.1 - 2012-10-12

- Workaround for Linux/Chrome bug when using #arc to draw a full circle not having a zero starting angle.

### Version 0.6.0 - 2012-1-27

- Line and bar charts now support negative numbers.

### Version 0.5.0 - 2011-12-6

- Fix - rename radius to diameter.
- Allow line charts with no stroke.
- Support for iPhone 4 retina display.

### Version 0.4.1 - 2011-9-29

- For a line graph with a single value show a straight line instead of nothing.

### Version 0.4.0 - 2011-6-30

- Allow options to be passed a function called with a `this` value of the element in question.

### Version 0.3.5 - 2011-5-12

- Fix that if the numerator of a pie is zero an empty pie is drawn instead of nothing. @munikho

### Version 0.3.4 - 2011-5-12

- Remove the little border that appears around the slice of a pie when the slice has a darker colour than the plate. @munikho

### Version 0.3.3 - 2011-3-20

- Tweaks to aid minification.

### Version 0.3.2 - 2010-5-9

- Don’t blow up if `<canvas>` isn’t supported.

### Version 0.3.1 - 2010-5-8

- Add “strokeWidth” option to line charts.
- Add “max” option to line and bar chart types.

### Version 0.3.0 - 2010-5-6

- Add line and bar graph types and expose an interface for adding more. @ismasan and me.

### Version 0.2.0 - 2010-4-29

First official version. Thanks to @ismasan and @olivernn for adding support for the “change” event and making it work in Firefox respectively.

### Birthday - 2009-11-20

It works!