Skip to content

Latest commit

 

History

History
 
 

plugin-contain

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
test
test
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
babel.config.js
babel.config.js
 
 
index.d.ts
index.d.ts
 
 
package.json
package.json
 
 

README.md

@jimp/plugin-contain

Contain an image within a height and width.

Scale the image to the given width and height keeping the aspect ratio. Some parts of the image may be letter boxed.

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.contain(150, 100);
}

main();

Align modes

The following constants can be passed to image.contain:

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.contain(250, 250, Jimp.HORIZONTAL_ALIGN_LEFT | Jimp.VERTICAL_ALIGN_TOP);
image.contain(
  250,
  250,
  Jimp.HORIZONTAL_ALIGN_RIGHT | Jimp.VERTICAL_ALIGN_BOTTOM
);

Default align mode for image.contain is:

Jimp.HORIZONTAL_ALIGN_CENTER | Jimp.VERTICAL_ALIGN_MIDDLE;