README.md

@jimp/plugin-crop

Crop an image.

Crop

Crops the image at a given point to a give size

• @param {number} x the x coordinate to crop form

• @param {number} y the y coordinate to crop form

• @param w the width of the crop region

• @param h the height of the crop region

• @param {function(Error, Jimp)} cb (optional) a callback for when complete

import jimp from 'jimp';

async function main() {
  const image = await jimp.read('test/image.png');

  image.crop(150, 150);
}

main();

AutoCrop

AutoCrop same color borders from this image

• @param {number} tolerance (optional): a percent value of tolerance for pixels color difference (default: 0.0002%)

• @param {boolean} cropOnlyFrames (optional): flag to crop only real frames: all 4 sides of the image must have some border (default: true)

or

• @param {object} options object

  • tolerance (optional): a percent value of tolerance for pixels color difference (default: 0.0002%)

  • cropOnlyFrames (optional): flag to crop only real frames: all 4 sides of the image must have some border (default: true)

  • cropSymmetric (optional): flag to force cropping top be symmetric. north and south / east and west are cropped by the same value

  • leaveBorder (optional): integer of how many pixels of the background color to leave around the image

import jimp from 'jimp';

async function main() {
  const image = await jimp.read('test/image.png');

  image.autocrop();
  image.autocrop({ cropOnlyFrames: false, cropSymmetric: true });
}

main();