node package manager

image2colors

image2colors

Extract colors from images. Supports GIF, JPG, PNG, and even SVG!

example color palette

Installation

npm install image2colors --save

Usage

const image2colors = require("image2colors")
 
image2colors({
  image: __dirname + 'double-rainbow.png',
  colors: 5,
  sample: 1024,
  scaleSvg: false
}, function(err, colors) {
  // colors is an array of colors 
})

colors is an array of custom objects, with occurrence (wegiht) and chroma.js color objects. chroma.js objects have methods that lets you pick the color format you want (RGB hex, HSL, etc), and give you access to powerful color manipulation features:

colors.map(pigment => pigment.color.hex())
// => ['#FFFFFF', '#123123', '#F0F0F0'] 
colors.map(pigment => pigment.weight)
// => [1700, 64, 23] 
 
colors[0].color.alpha(0.5).css();
// => 'rgb(0,128,128)'' 

Options

  • image: could be a path (file system path or url), base64 data:image or svg xml string
  • colors: default: 5; restrict the number of result colors
  • sample: default: 1024: used for pre-filter raster image colors
  • scaleSvg: default: false; probably you need all of the svg colors, if this is ´false´, the ´colors´ option will be bypassed

How it Works

get-image-colors uses get-pixels to create a pixel array, then extracts a color palette with get-rgba-palette, which uses quantize under the hood.

Colors are converted from get-rgba-palette's flat array format into chroma.js color instances.

To extract palettes from SVG files, a PNG copy is created on the fly using svg2png, which depends on PhantomJS. PhantomJS can be installed as a local node module, unlike canvas which has external dependencies.

Tests

npm install
npm test

Dependencies

  • chroma-js: JavaScript library for color conversions
  • get-pixels: Reads the pixels of an image as an ndarray
  • svg2png: A SVG to PNG converter, using PhantomJS

Dev Dependencies

  • mocha: simple, flexible, fun test framework

Credits

The original "get-image-colors" module comes from zeke And great thanks giving for all the developers of the required dependencies.

License

MIT