color-classifier.js
===================
[](https://travis-ci.org/tsuyoshiwada/color-classifier)
[](http://badge.fury.io/js/color-classifier)
[](https://david-dm.org/tsuyoshiwada/color-classifier/#info=devDependencies&view=table)
[](https://raw.githubusercontent.com/tsuyoshiwada/color-classifier/master/LICENSE)
Classify the color along the reference color. using algorithm the CIEDE2000, RGB, HSV.
## Playground
[](http://tsuyoshiwada.github.io/color-classifier/)
[Playground](http://tsuyoshiwada.github.io/color-classifier/)
## INSTALL
```bash
$ npm install color-classifier --save
```
or
Download the [color-classifier.min.js](https://raw.githubusercontent.com/tsuyoshiwada/color-classifier/master/color-classifier.min.js).
## USAGE
The following is the basic usage.
```javascript
import ColorClassifier from "color-classifier"
const palette = ["#fff", "#000"];
const colorClassifier = new ColorClassifier(palette);
const color = colorClassifier.classify("#fefefe");
console.log(color); // {r: 255, g: 255, b: 255}
```
The type of pallet and algorithms have been some available.
```javascript
import ColorClassifier, { Palette, AlgorithmTypes } from "color-classifier"
const colorClassifier = new ColorClassifier(Palette.W3C, AlgorithmTypes.HSV);
const color = colorClassifier.classify("#fefefe");
console.log(color); // {r: 255, g: 255, b: 255}
```
The available values are as follows.
### Palette
The following is the palette list of preset.
#### [Palette.W3C](https://github.com/tsuyoshiwada/color-classifier/blob/master/src/palette/w3c.js)
| hex | color |
|-----------|--------------------------------------------------------------------------------------------|
| `#000000` |  |
| `#808080` |  |
| `#c0c0c0` |  |
| `#ffffff` |  |
| `#800000` |  |
| `#ff0000` |  |
| `#008000` |  |
| `#00ff00` |  |
| `#808000` |  |
| `#ffff00` |  |
| `#008080` |  |
| `#00ffff` |  |
| `#000080` |  |
| `#0000ff` |  |
| `#800080` |  |
| `#ff00ff` |  |
#### [Palette.RAINBOW](https://github.com/tsuyoshiwada/color-classifier/blob/master/src/palette/rainbow.js)
| hex | color |
|-----------|--------------------------------------------------------------------------------------------|
| `#000000` |  |
| `#808080` |  |
| `#ffffff` |  |
| `#ff0000` |  |
| `#ffa500` |  |
| `#ffff00` |  |
| `#008000` |  |
| `#00ffff` |  |
| `#0000ff` |  |
| `#800080` |  |
### AlgorithmTypes
The difference algorithm of color is possible some selection.
Please try in [Playground](http://tsuyoshiwada.github.io/color-classifier/) for the difference of each algorithm.
| value | description |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `AlgorithmTypes.CIEDE2000` | Using the CIE Delta E 2000 Color-Difference algorithm (CIEDE2000).
[The CIEDE2000 color-difference formula](http://www.ece.rochester.edu/~gsharma/ciede2000/ciede2000noteCRNA.pdf),
[Color difference - Wikipedia, the free encyclopedia](https://en.wikipedia.org/wiki/Color_difference#CIEDE2000) |
| `AlgorithmTypes.HSV` | Using the HSV color space.
[HSL and HSV - Wikipedia, the free encyclopedia](https://en.wikipedia.org/wiki/HSL_and_HSV) |
| `AlgorithmTypes.RGB` | Using the RGB color space.
[RGB color model - Wikipedia, the free encyclopedia](https://en.wikipedia.org/wiki/RGB_color_model)
## API
### new ColorClassifier(palette = Palette.W3C, algorithmType = AlgorithmTypes.CIEDE2000)
**palette**: {Array}
**algorithmType**: {String}
Palette is specify array in RGB object or HEX string.
**HEX String**:
```javascript
const palette = ["#fff", "#000"];
const colorClassifier = new ColorClassifier(palette);
```
**RGB Object**:
```javascript
const palette = [
{r: 255, g: 255, b: 255},
{r: 0, g: 0, b: 0}
];
const colorClassifier = new ColorClassifier(palette);
```
### classify(color, format = "rgb")
**color**: {Object || String}
**format**: {String} ("rgb", "hex", "hsv")
Classifies the specified color along the palette.
```javascript
const color1 = {r: 255, g: 255, b: 255};
console.log(colorClassifier.classify(color1, "rgb")); //{r: 255, g: 255, b: 255}
console.log(colorClassifier.classify(color1, "hex")); //#ffffff
console.log(colorClassifier.classify(color1, "hsv")); //{h: 0, s: 0, v: 100}
const color2 = "#fff";
console.log(colorClassifier.classify(color2, "rgb")); //{r: 255, g: 255, b: 255}
console.log(colorClassifier.classify(color2, "hex")); //#ffffff
console.log(colorClassifier.classify(color2, "hsv")); //{h: 0, s: 0, v: 100}
```
### classifyFromArray(colors, format = "rgb")
**colors**: {Array}
**format**: {String} ("rgb, "hex", "hsv")
Classifies the specified array of colors along the palette.
```javascript
const colors = ["#fefefe", "#fafafa", "#010101", "#020202"];
const results = colorClassifier.classifyFromArray(colors, "hex");
console.log(results);
// [
// {
// palette: "#ffffff",
// colors: [
// "#fefefe",
// "#fafafa"
// ]
// },
// {
// palette: "#000000",
// colors: [
// "#010101",
// "#020202"
// ]
// }
// ]
```
### More APIs
* `setPalette(palette)`
* `getPalette()`
* `setAlgorithmType(algorithmType)`
* `getAlgorithmType()`
## LICENCE
Released under the [MIT Licence](https://raw.githubusercontent.com/tsuyoshiwada/color-classifier/master/LICENSE)
## AUTHOR
[tsuyoshiwada](https://github.com/tsuyoshiwada)
## DEVELOPMENT
Initialization of the project.
```bash
$ cd /your/project/dir
$ git clone https://github.com/tsuyoshiwada/sweet-scroll.git
```
Install some dependencies.
```bash
$ npm install
```
Start the development.
You can access to the http://localhost:3000/.
```bash
$ npm start
```
Run lint and testing.
```bash
$ npm test
```
Generates build file.
```bash
$ npm run build
```
---
Bugs, feature requests and comments are more than welcome in the [issues](https://github.com/tsuyoshiwada/color-classifier/issues)