Package Exports
- zulerimage
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 (zulerimage) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Imagix
Imagix is a framework for jimp to manipulate images in a simpler and cleaner way.
Installation
$ npm install --save imagix
Example usage
// references the classes to use
const { ImagixRead, ImagixFont, ImagixImage } = require('imagix');
// create a new font to print, use the ImagixFont class
let text1 = new ImagixFont('text to print', 20, 100,
// text a print, point in X, point in Y
{
//Options for a font
size: 32, // size of the font
color: 'WHITE' // color of the font
});
// create a new image to print, use the ImagixImage class
let img1 = new ImagixImage('avatar.png', {
//Options for a image
x: 15, // point in X
y: 45, // point in Y
resizeX: 130, //define the size in X of the image.
resizeY: 120, //define the size in Y of the image.
});
/*
The ImagixRead class takes the fonts and images in arrays
and returns the getBuffer method.
*/
const image = new ImagixRead('image-bg.png', [text1], [img1]);
// image to manipulation image-bg.png
// if you have more than one font "[text1, text2, text3]" or images "[img1, img2]"
//Metods options getBuffer, getWrite, getInks
//print image manipulation
//getWrite
image.getWrite('newImage.png');
//getBuffer
image.getBuffer(buff => {
console.log(buff);
});
//getInks, opts for all Jimp's methods
image.getInks(img => {
img.invert(function (err, img) {
img.write('newImgInvert.png');
});
};
OPTIONS A FONT
//Available options
size:
"8" //Open Sans, 8px
"16" //Open Sans, 16px
"32" //Open Sans, 32px
"64" //Open Sans, 64px
"128" //Open Sans, 128px
color:
"BLACK" //Open Sans, Black
"WHITE" //Open Sans, White
SUMMARIZED EXAMPLE
const { ImagixRead, ImagixFont, ImagixImage } = require('imagix');
let nick = new ImagixFont('Nickname', 20, 100,
{
size: 32,
color: 'WHITE'
});
let info = new ImagixFont('name@gmail.com', 20, 300,
{
size: 16,
color: 'BLACK'
});
let avatar = new ImagixImage('www.example.com/asset/avatar.png', {
x: 15,
y: 45,
resizeX: 250,
resizeY: 230
});
const image = new ImagixRead('bg-profile-1.png', [nick, info], [avatar]);
image.getWrite('./img/newProfile-1.png');
//Or
image.getBuffer(buff => {
console.log(buff);
});