mirror of https://github.com/thangisme/notes.git synced 2024-10-31 20:57:26 -04:00

History

Patrick Marsceill b7b0d0d7bf Initial commit		2017-03-09 13:16:08 -05:00
..
lib	Initial commit	2017-03-09 13:16:08 -05:00
test	Initial commit	2017-03-09 13:16:08 -05:00
.npmignore	Initial commit	2017-03-09 13:16:08 -05:00
.travis.yml	Initial commit	2017-03-09 13:16:08 -05:00
COPYING	Initial commit	2017-03-09 13:16:08 -05:00
package.json	Initial commit	2017-03-09 13:16:08 -05:00
README.md	Initial commit	2017-03-09 13:16:08 -05:00

README.md

Color-diff

Implemets the CIEDE2000 color difference algorithm, conversion between RGB and LAB color and mapping all colors in palette X to the closest color in palette Y based on the CIEDE2000 difference.

Installation

npm install color-diff --save

Tests

Are located in the test/ folder and are run by:

npm test

Usage

var diff = require('color-diff');

diff.closest(color, palette)

Returns the closest color.

var color = { R: 255, G: 1, B: 30 };
// red, green, blue
var palette = [ {R: 255, G: 0, B: 0 }, {R: 0, G: 255, B: 0 }, {R: 0, G: 0, B: 255} ];

diff.closest(color, palette); // {R: 255, G: 0, B: 0 }, red

The result above is obvious, but diff.closest could deal with more complicated cases.

diff.furthest(color, palette)

Returns the most different color.

var color = { R: 255, G: 255, B: 255 };
// black, white
var palette = [ {R: 0, G: 0, B: 0 }, {R: 255, G: 255, B: 255 } ];

diff.furthest(color, palette); // {R: 0, G: 0, B: 0 }, black

The result above is obvious, but diff.furthest could deal with more complicated cases.

color

Object

color is an object containing 3 properties: 'R', 'G', 'B', such as:

{ R: 255, G: 1, B: 0 }

palette

Array.<Object>

Color palette array which contains many color-like objects.

Author

Markus Ekholm

License

3-clause BSD. For details see COPYING.