Javascript histogram library that gives you a data structure describing your PNG/JPEG/GIF. Works in NodeJS and any canvas supporting browser. Added bonus: Exports AMD module in the browser if require.js is loaded, otherwise falls back to exposing histogram on window.
JavaScript HTML
Latest commit ba97c85 Oct 31, 2016 @papandreou papandreou 2.1.1
Permalink
Failed to load latest commit information.
lib Add phantomjs tests Dec 28, 2014
test Remove es5-shim Apr 6, 2016
.coveralls.yml Fix coveralls token Aug 12, 2014
.editorconfig Added editorconfig Aug 12, 2014
.gitignore Gitignore coverage reports Oct 17, 2015
.jshintignore Added jshint config Aug 12, 2014
.jshintrc Rewrite test suite to mocha Aug 12, 2014
.travis.yml fixup Mar 30, 2016
README.md Update README.md Jan 18, 2015
histogram.min.js 2.1.1 Oct 31, 2016
package.json 2.1.1 Oct 31, 2016

README.md

Histogram

NPM version Build Status Coverage Status Dependency Status

Provides a histogram data structure from PNG, JPEG or GIF files using canvas. This library works in nodejs and in any canvas supporting browser using histogram.min.js. In the browser histogram will be available in window.histogram You can also use require.js instead, keeping your global scope clean.

Example usage

NodeJS

var histogram = require('histogram');

histogram(fileName || Buffer, function (err, data) {
    console.log(filePath + ' has ' + data.colors.rgba + ' colors');
});

Browser with require.js

require(['path/to/histogram.min.js'], function (err, histogram) {
    histogram(URL || FileReader.result, function (data) {
        console.log(filePath + ' has ' + data.colors.rgba + ' colors');
    });
});

Vanilla browser

<script src="path/to/histogram.min.js"></script>
<script>
    histogram(URL || FileReader.result, function (err, data) {
        console.log(filePath + ' has ' + data.colors.rgba + ' colors');
    });
</script>

Data structure

{
    red: new Array(256), // Count of the number of times a value appears in the red channel
    green: new Array(256), // Count of the number of times a value appears in the green channel
    blue: new Array(256), // Count of the number of times a value appears in the blue channel
    alpha: new Array(256), // Count of the number of times a value appears in the alpha channel

    colors: {
        rgb: 0, // Number of unique RGB colors
        rgba: 0 // Number of unique RGBA colors
    },

    palettes: {
        rgb: [], // Array of unique colors in hex notation
        rgba: [] // Array of unique colors in hexa notation
    },

    greyscale: true, // Indicates whether all colors are greyscale or not
    alphachannel: false // Indicates that one or more pixels are translucent
}

License

This software is licensed under the beerware license. Do whatever you want with it. If we meet some day, and you think this stuff is worth it, you can buy me a beer in return.

Bitdeli Badge