Home

Awesome

d3plus-priestley

A reusable Priestley timeline built on D3.

Installing

If using npm, npm install d3plus-priestley. Otherwise, you can download the latest release from GitHub or load from a CDN.

import modules from "d3plus-priestley";

d3plus-priestley can be loaded as a standalone library or bundled as part of D3plus. ES modules, AMD, CommonJS, and vanilla environments are supported. In vanilla, a d3plus global is exported:

<script src="https://cdn.jsdelivr.net/npm/d3plus-priestley@1"></script>
<script>
  console.log(d3plus);
</script>

Examples

Live examples can be found on d3plus.org, which includes a collection of example visualizations using d3plus-react. These examples are powered by the d3plus-storybook repo, and PRs are always welcome. :beers:

API Reference

<a name="Priestley"></a>

Priestley <>

This is a global class, and extends all of the methods and functionality of <code>Viz</code>.

<a name="new_Priestley_new" href="#new_Priestley_new">#</a> new Priestley()

Creates a priestley timeline based on an array of data.

<a name="Priestley.axisConfig" href="#Priestley.axisConfig">#</a> 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.

This is a static method of <code>Priestley</code>, and is chainable with other methods of this Class.

<a name="Priestley.end" href="#Priestley.end">#</a> 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.

This is a static method of <code>Priestley</code>, and is chainable with other methods of this Class.

<a name="Priestley.paddingInner" href="#Priestley.paddingInner">#</a> Priestley.paddingInner([value]) <>

Sets the paddingInner value of the underlining Band Scale used to determine the height of each bar. Values should be a ratio between 0 and 1 representing the space in between each rectangle.

This is a static method of <code>Priestley</code>, and is chainable with other methods of this Class.

<a name="Priestley.paddingOuter" href="#Priestley.paddingOuter">#</a> Priestley.paddingOuter([value]) <>

Sets the paddingOuter value of the underlining Band Scale used to determine the height of each bar. Values should be a ratio between 0 and 1 representing the space around the outer rectangles.

This is a static method of <code>Priestley</code>, and is chainable with other methods of this Class.

<a name="Priestley.start" href="#Priestley.start">#</a> 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.

This is a static method of <code>Priestley</code>, and is chainable with other methods of this Class.

<sub>Documentation generated on Wed, 25 Jan 2023 18:11:33 GMT</sub>