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

Extract color palettes from images. Simple use, <4ko minified and no dependencies for browser.

Install

For browser

npm install 'extract-colors'

For node.js

Need to install dependency canvas

npm install 'extract-colors' 'canvas'

Usage

Browser

import extractColors from 'extract-colors'

const src = 'my-image.jpg'

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

Node.js

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

const src = './my-image.jpg'

extractColors(path.join(__dirname, src))
  .then(console.log)
  .catch(console.log)

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)

Field	Default	Type	Description
pixels	10000	Integer	Total pixel number of the resized picture for calculation
distance	0.2	Number	From 0 to 1 is the color distance to not have near colors (1 distance is between White and Black)
saturationImportance	0.2	Number	Power of the saturation weight during the process (0 is not used, 1 is equal to the area and more is more important for the saturation)
splitPower	10	Integer	Approximation power in the first color splitting during process (from 2 to 16)
colorValidator	(red, green, blue, alpha = 255) => alpha > 250	Function	Lamda function to disable some colors
crossOrigin	null	Only for browser, can be 'Anonymous' to avoid CORS

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