Skip to content

Commit

Permalink
compiles v0.1.17
Browse files Browse the repository at this point in the history
  • Loading branch information
davelandry committed May 26, 2017
1 parent 1c44270 commit 3088a45
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 35 deletions.
59 changes: 25 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
# d3plus-priestley

[![NPM Release](http://img.shields.io/npm/v/d3plus-priestley.svg?style=flat)](https://www.npmjs.org/package/d3plus-priestley)
[![Build Status](https://travis-ci.org/d3plus/d3plus-priestley.svg?branch=master)](https://travis-ci.org/d3plus/d3plus-priestley)
[![Dependency Status](http://img.shields.io/david/d3plus/d3plus-priestley.svg?style=flat)](https://david-dm.org/d3plus/d3plus-priestley)
[![Slack](https://img.shields.io/badge/Slack-Click%20to%20Join!-green.svg?style=social)](https://goo.gl/forms/ynrKdvusekAwRMPf2)
[![NPM Release](http://img.shields.io/npm/v/d3plus-priestley.svg?style=flat)](https://www.npmjs.org/package/d3plus-priestley) [![Build Status](https://travis-ci.org/d3plus/d3plus-priestley.svg?branch=master)](https://travis-ci.org/d3plus/d3plus-priestley) [![Dependency Status](http://img.shields.io/david/d3plus/d3plus-priestley.svg?style=flat)](https://david-dm.org/d3plus/d3plus-priestley) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat)](https://gitter.im/d3plus/)

A reusable Priestley timeline built on D3.

## Installing

If you use NPM, `npm install d3plus-priestley`. Otherwise, download the [latest release](https://github.com/d3plus/d3plus-priestley/releases/latest). The released bundle supports AMD, CommonJS, and vanilla environments. Create a [custom bundle using Rollup](https://github.com/rollup/rollup) or your preferred bundler. You can also load directly from [d3plus.org](https://d3plus.org):
If you use NPM, run `npm install d3plus-priestley --save`. Otherwise, download the [latest release](https://github.com/d3plus/d3plus-priestley/releases/latest). The released bundle supports AMD, CommonJS, and vanilla environments. You can also load directly from [d3plus.org](https://d3plus.org):

```html
<script src="https://d3plus.org/js/d3plus-priestley.v0.1.full.min.js"></script>
Expand Down Expand Up @@ -47,59 +44,53 @@ new d3plus.Priestley()
* [Grouping into Lanes](http://d3plus.org/examples/d3plus-priestley/grouping/)

## API Reference

##### Classes
* [Priestley](#Priestley)

---

<a name="Priestley"></a>
#### **Priestley** [<>](https://github.com/d3plus/d3plus-priestley/blob/master/src/Priestley.js#L15)


This is a global class, and extends all of the methods and functionality of [<code>Viz</code>](https://github.com/d3plus/d3plus-viz#Viz).

### Priestley ⇐ <code>[Viz](https://github.com/d3plus/d3plus-viz#Viz)</code>
**Kind**: global class
**Extends**: <code>[Viz](https://github.com/d3plus/d3plus-viz#Viz)</code>

* [Priestley](#Priestley) ⇐ <code>[Viz](https://github.com/d3plus/d3plus-viz#Viz)</code>
* [Priestley](#Priestley)[<code>Viz</code>](https://github.com/d3plus/d3plus-viz#Viz)
* [new Priestley()](#new_Priestley_new)
* [.axisConfig([*value*])](#Priestley.axisConfig) ↩︎
* [.end([*value*])](#Priestley.end) ↩︎
* [.start([*value*])](#Priestley.start) ↩︎

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

#### new Priestley()
Creates a priestley timeline based on an array of data.

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

#### Priestley.axisConfig([*value*]) ↩︎


<a name="Priestley.axisConfig" href="Priestley.axisConfig">#</a> Priestley.**axisConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-priestley/blob/master/src/Priestley.js#L138)

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 <code>[Priestley](#Priestley)</code>
**Chainable**

| Param | Type |
| --- | --- |
| [*value*] | <code>Object</code> |
This is a static method of [<code>Priestley</code>](#Priestley), and is chainable with other methods of this Class.

<a name="Priestley.end"></a>
<a name="Priestley.end" href="Priestley.end">#</a> Priestley.**end**([*value*]) [<>](https://github.com/d3plus/d3plus-priestley/blob/master/src/Priestley.js#L148)

#### 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 <code>[Priestley](#Priestley)</code>
**Chainable**

| Param | Type |
| --- | --- |
| [*value*] | <code>function</code> &#124; <code>String</code> |
This is a static method of [<code>Priestley</code>](#Priestley), and is chainable with other methods of this Class.

<a name="Priestley.start"></a>
<a name="Priestley.start" href="Priestley.start">#</a> Priestley.**start**([*value*]) [<>](https://github.com/d3plus/d3plus-priestley/blob/master/src/Priestley.js#L166)

#### 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 <code>[Priestley](#Priestley)</code>
**Chainable**

| Param | Type |
| --- | --- |
| [*value*] | <code>function</code> &#124; <code>String</code> |

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

---

###### <sub>Documentation generated on Mon, 13 Mar 2017 19:31:19 GMT</sub>
###### <sub>Documentation generated on Fri, 26 May 2017 19:34:49 GMT</sub>
Binary file modified example/getting-started.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified example/grouping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "d3plus-priestley",
"version": "0.1.16",
"version": "0.1.17",
"description": "A reusable Priestley timeline built on D3.",
"main": "build/d3plus-priestley.js",
"jsnext:main": "index",
Expand Down

0 comments on commit 3088a45

Please sign in to comment.