d3plus-priestley

d3plus-priestley

A reusable Priestley timeline built on D3.

Installing

If you use NPM, npm install d3plus-priestley. Otherwise, download the latest release. The released bundle supports AMD, CommonJS, and vanilla environments. Create a custom bundle using Rollup or your preferred bundler. You can also load directly from d3plus.org:

<script src="https://d3plus.org/js/d3plus-priestley.v0.1.full.min.js"></script>

Getting Started

Priestly Timelines (named after 18th-century English theologian Joseph Priestly), show the duration of multiple data points over time by stacking blocks to best fit. Given data with unique IDs and start and end dates:

var data = [
  {id: "alpha",   start: 2004, end: 2007},
  {id: "epsilon", start: 2007, end: 2012},
  {id: "beta",    start: 2005, end: 2010},
];

It's only requires a few lines of code to create a Priestly Timeline:

new d3plus.Priestley()
  .data(data)
  .render();

Click here to view this example live on the web.

More Examples

• Grouping into Lanes

API Reference

Priestley ⇐ Viz

Kind: global class
Extends: Viz

• Priestley ⇐ Viz
  • new Priestley()
  • .axisConfig([value]) ↩︎
  • .end([value]) ↩︎
  • .start([value]) ↩︎

new Priestley()

Creates a priestley timeline based on an array of data.

Priestley.axisConfig([value]) ↩︎

If value is specified, sets the config method for the axis and returns the current class instance. If value is not specified, returns the current axis configuration.

Kind: static method of Priestley
Chainable

Param	Type
[value]	Object

Priestley.end([value]) ↩︎

If value is specified, sets the end accessor to the specified function or key and returns the current class instance. If value is not specified, returns the current end accessor.

Kind: static method of Priestley
Chainable

Param	Type
[value]	function | String

Priestley.start([value]) ↩︎

If value is specified, sets the start accessor to the specified function or key and returns the current class instance. If value is not specified, returns the current start accessor.

Kind: static method of Priestley
Chainable

Param	Type
[value]	function | String

_{Documentation generated on Tue, 20 Dec 2016 20:42:11 GMT}