@mapbox/makizushi

professional maki chef

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
223Feb 28, 2019Apr 16, 2014Minified + gzip package size for @mapbox/makizushi in KB

Readme

Build Status

makizushi

Professional Maki chef. This module produces custom markers based on the Maki icon set, in custom sizes and colors. To do this, it chooses, tints, and flattens parts of the image, using node-blend.

install

npm install --save @mapbox/makizushi

api

makizushi(options, callback)

Options:

  • tint: a color in rgb or rrggbb
  • symbol: a Maki symbol name, or a number from 0 to 99
  • size: one of s, m, or l
  • base: "pin"
  • retina: true or false, true will return a 2x resolution image

Callback: (err, data) in which err is an error if any, and data is a buffer of image data.

usage

var makizushi = require('makizushi');

makizushi({
    base: 'pin',
    size: 'l',
    tint: '333',
    symbol: 'car',
    retina: true
}, function(err, buf) {
    if (err) throw err;
    fs.writeFileSync('marker.png', buf);
});

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.