@indot/rainbowvis
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

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();

NOTE for the INDOT Typescript Port:

INDOT usage should stick to the provided convenience versions:

    import { rainbow } from '@indot/rainbowvis';
    const rb = rainbow().overColors('#fa00b3', 'alicewhite').withRange(1, 32);

Related Links

Package Sidebar

Install

npm i @indot/rainbowvis

Weekly Downloads

302

Version

1.0.2

License

EPL-1.0

Unpacked Size

294 kB

Total Files

26

Last publish

Collaborators

  • indot