Package Exports

gl-spikes2d

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gl-spikes2d) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gl-spikes2d

Draws axis spikes for 2D plots

Example

Check back later

Install

npm i gl-spikes2d

API

Constructor

`var spikes = require('gl-spikes2d')(plot, options)`

Creates a new spike overlay for the given 2d plot

plot is a gl-plot2d instance
options is an object with a set of properties for the spike object

The properties of the options object are as follows:

enable Enables rendering of the spikes for each axis
width The width of each spike
color Color of each spike
center Center of spikes

Methods

`spikes.update(options)`

Updates the spike object in place. Similar behavior to constructor.

`spikes.dispose()`

Destroys the spikes object

gl-spikes2d

Package Exports

Readme

gl-spikes2d

Example

Install

API

Constructor

var spikes = require('gl-spikes2d')(plot, options)

Methods

spikes.update(options)

spikes.dispose()

License

`var spikes = require('gl-spikes2d')(plot, options)`

`spikes.update(options)`

`spikes.dispose()`