rainbowvis.js/readme.markdown

A JavaScript library for colour data visualization. Easily map numbers to a smooth-transitioning colour legend.

RainbowVis-JS
=============

A JavaScript library for colour data visualization. Easily map numbers to a smooth-transitioning colour legend.

The Rainbow class by default maps the range 0 to 100 (inclusive) to the colours of the rainbow (i.e., a gradient transitioning from red to yellow to lime to blue).

See example.html

`var rainbow = new Rainbow();` creates new instance of Rainbow. By default, the number range is from 0 to 100, and the spectrum is a rainbow.

`rainbow.colourAt(number);` returns the hex colour corresponding to the number. If number is out of range, it returns the appropriate hex colour corresponding to either the minNumber or maxNumber.

`rainbow.setSpectrum(colour1, colour2 [,colourN]);` sets the spectrum of the Rainbow object. By default, the spectrum is a rainbow. You must have a minimum of two colours, but you can specify more than two colours. Colours can be in the form 'red', 'ff0000', or '#ff0000'. For example, `rainbow.setSpectrum('red', 'yellow', 'white');` makes the "Rainbow" a colour gradient from red to yellow to white.  

`rainbow.setNumberRange(minNumber, maxNumber);` sets the number range of the Rainbow object. By default, it is 0 to 100.

CommonJS
--------
### Installation
`npm install rainbowvis.js`

### Usage
    var Rainbow = require('rainbowvis.js');
    var myRainbow = new Rainbow();

Related Links
-----------------

* [RainbowVis-Java](https://github.com/anomal/RainbowVis-Java) - Java version
* [rainbowvis-rails](https://github.com/Intrepidd/rainbowvis-rails) - RainbowVis Rails gem by Intrepidd
* [rainbowvis-dart](https://github.com/ilikerobots/rainbowvis-dart) - Dart version by ilikerobots
* [RainbowVis](https://github.com/danesparza/RainbowVis) - Go version by danesparza