@jimp/plugin-crop

@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();

Changelog

v0.22.8 (Thu May 11 2023)

:tada: This release contains work from new contributors! :tada:

Thanks for all your work!

:heart: Sjoerd (@sjoerd108)

:heart: null@php4fan

:heart: null@JunkMeal

🚀 Enhancement

• @jimp/core, jimp
  • Composite: don't write to null pixels #1226 (@sjoerd108)
• @jimp/plugin-color
  • Fix: convolute not defaulting to 0, 0 as starting point #1228 (@sjoerd108)
• @jimp/plugin-rotate
  • Fix: rotate resize param on multiples of 90 #1229 (@sjoerd108)

🐛 Bug Fix

• @jimp/plugin-crop, @jimp/test-utils
  • Fix autocrop mixing up east and west #1227 (@sjoerd108)

📝 Documentation

• Fixed typo in README #1215 (@php4fan)
• jimp
  • Changing the Hiero url #1213 (@JunkMeal)

Authors: 3

• @JunkMeal
• @php4fan
• Sjoerd (@sjoerd108)

---