Package Exports

extract-colors

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 (extract-colors) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Extract Colors

npm bundle size Dependencies

Extract color palettes from images.
Simple use, < 5ko minified, fast process and no dependencies for browser.
Dependency to canvas for node.js

3 examples of colors extraction

Requirements

Browsers

Firefox: 29+
Chrome: 33+
Edge: 12+
Opera: 19+
Safari: 8+
Webview Android: 4.4.3+
Samsung Internet: 2.0+
~~Internet Explorer~~

Node

Node.js: 0.12+

Install

For browser

npm install --save extract-colors

For node.js

Need to install dependency canvas

npm install --save extract-colors canvas

Usage

Browser example

import extractColors from 'extract-colors'

const src = 'my-image.jpg'

extractColors(src)
  .then(console.log)
  .catch(console.error)

You can use different types for src param (String for a path of image, Image or ImageData).
If you use ImageData type, be carrefull because the extractor will not optimize the process (it will not reduce the count of pixels).

Node.js example

const path = require('path')
const { extractColors } = require('extract-colors')

const src = path.join(__dirname, './my-image.jpg')

extractColors(src)
  .then(console.log)
  .catch(console.log)

You can use different types for src param (String for a path of image or ImageData).
If you use ImageData type, be carrefull because the extractor will not optimize the process (it will not reduce the count of pixels).

Options

const src = 'my-image.jpg'

const options = {
  pixels: 10000,
  distance: 0.2,
  saturationImportance: 0.2,
  splitPower: 10,
  colorValidator: (red, green, blue, alpha = 255) => alpha > 250
}

extractColors(src, options)
  .then(console.log)
  .catch(console.error)

pixels
Total pixel number of the resized picture for calculation
Type: Integer
Default: 10000

distance
From 0 to 1 is the color distance to not have near colors (1 distance is between white and black)
Type: Number
Default: 0.2

saturationImportance
Power of the saturation weight during the process (0 is not used, 1 is only saturation and not area size)
Type: Number
Default: 0.2

splitPower
Approximation power in the first color splitting during process (from 2 to 16)
Type: Integer
Default: 10

colorValidator
Test function to enable only some colors
Type: Function
Default: (red, green, blue, alpha = 255) => alpha > 250

crossOrigin
Only for browser, can be 'Anonymous' to avoid CORS
Type: String
Default: null

Return of the promise

Array of colors with the followed properties:

[
  {
    hex: '#62342b',
    red: 98,
    green: 52,
    blue: 43,
    area: 0.5915,
    saturation: 0.2156862
  },
  ...
]

Field	Example	Type	Description
hex	#62342b	String	color in hexadecimal string
red	98	Integer	red canal from 0 to 255
green	52	Integer	green canal from 0 to 255
blue	43	Integer	blue canal from 0 to 255
area	0.5915	Number	area of the color and his neighbouring colors from 0 to 1
saturation	0.2156862	Number	color saturation from 0 to 1

API doc

Modules

Color: Informations like saturation or count of pixels in image.
ColorsExtractor: Process to extract main colors from list of colors.
ColorGroup: Group colors with algorithms to optimize and merge neighbors colors.
Browser: Browser exported functions.
Node: Node exported functions.

Color

Informations like saturation or count of pixels in image.

Color
- .module.exports ⏏
  - new module.exports(red, green, blue, [hex])
  - .distance(color) ⇒ Number
  - .getWeight(saturationImportance, maxCount) ⇒ Number
  - .getSaturation() ⇒ Number

.module.exports ⏏

Calculate some informations and store data about color.

Kind: static class of Color

new module.exports(red, green, blue, [hex])

Set red, green and blue colors to create the Color object.

Param	Type	Description
red	`Number`	Red channel integer from 0 to 255
green	`Number`	Green channel integer from 0 to 255
blue	`Number`	Blue channel integer from 0 to 255
[hex]	`Number`	Optional hexadecimal color from 0x000000 to 0xFFFFFF

module.exports.distance(color) ⇒ `Number`

Distance between two colors.

Minimum is 0 (between two same colors)
Maximum is 1 (for example between black and white)

Kind: instance method of module.exports

Param	Type	Description
color	`Color`	Color to compare

module.exports.getWeight(saturationImportance, maxCount) ⇒ `Number`

Weight of the color depends of his saturation and his count.

Kind: instance method of module.exports

Param	Type	Description
saturationImportance	`Number`	Determine the weight of the saturation for the calcul (from 0 to 1)
maxCount	`Number`	Number of pixels in the image.

module.exports.getSaturation() ⇒ `Number`

Saturation of the color from 0 to 1.

Kind: instance method of module.exports

ColorsExtractor

Process to extract main colors from list of colors.

.module.exports ⏏

Process to extract neighboring colors.

Kind: static class of ColorsExtractor

ColorGroup

Group colors with algorithms to optimize and merge neighbors colors.

.module.exports ⏏

Manage list of colors or groups.

Kind: static class of ColorGroup

Browser

Browser exported functions.

Example

import extractColors from 'extract-colors'

const src = 'my-image.jpg'

extractColors(src)
  .then(console.log)
  .catch(console.error)

Browser
- ~getImageData(image, pixels) ⇒ ImageData
- ~extractColorsFromImageData(imageData, [options]) ⇒ Array.<Object>
- ~extractColorsFromImage(image, [options]) ⇒ Array.<Object>
- ~extractColorsFromSrc(src, [options]) ⇒ Array.<Object>
- ~extractColors(picture, [options]) ⇒ Array.<Object>