shichen b6c5ecc67a init 10 months ago
..
dist b6c5ecc67a init 10 months ago
es b6c5ecc67a init 10 months ago
node_modules b6c5ecc67a init 10 months ago
src b6c5ecc67a init 10 months ago
test b6c5ecc67a init 10 months ago
CHANGELOG.md b6c5ecc67a init 10 months ago
LICENSE b6c5ecc67a init 10 months ago
README.md b6c5ecc67a init 10 months ago
index.d.ts b6c5ecc67a init 10 months ago
package.json b6c5ecc67a init 10 months ago

README.md

@jimp/plugin-cover

Scale the image so the given width and height keeping the aspect ratio. Some parts of the image may be clipped.

Usage

  • @param {number} w the width to resize the image to
  • @param {number} h the height to resize the image to
  • @param {number} alignBits (optional) A bitmask for horizontal and vertical alignment
  • @param {string} mode (optional) a scaling method (e.g. Jimp.RESIZE_BEZIER)
  • @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.cover(150, 100);
}

main();

Align modes

The following constants can be passed to image.cover:

Jimp.HORIZONTAL_ALIGN_LEFT;
Jimp.HORIZONTAL_ALIGN_CENTER;
Jimp.HORIZONTAL_ALIGN_RIGHT;

Jimp.VERTICAL_ALIGN_TOP;
Jimp.VERTICAL_ALIGN_MIDDLE;
Jimp.VERTICAL_ALIGN_BOTTOM;

For example:

image.cover(250, 250, Jimp.HORIZONTAL_ALIGN_LEFT | Jimp.VERTICAL_ALIGN_TOP);
image.cover(250, 250, Jimp.HORIZONTAL_ALIGN_RIGHT | Jimp.VERTICAL_ALIGN_BOTTOM);

Default align mode for image.cover is:

Jimp.HORIZONTAL_ALIGN_CENTER | Jimp.VERTICAL_ALIGN_MIDDLE;