crop-image-data
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

crop-image-data

✂️ Function for cropping an image through its ImageData.

Demo

https://crop-image-data.netlify.app

Installation

# npm
npm install crop-image-data

# pnpm
pnpm install crop-image-data

# yarn
yarn add crop-image-data

Usage

cropImageData(imageData, cropOptions)

Creates a cropped version of an ImageData-instance. Does not mutate the recieved instance.

Parameters:

  • imageData - the ImageData-instance instance to crop

  • cropOptions - an object specifying the amount of pixels to crop from each side

    • top - number of pixels to crop from the top
    • right - number of pixels to crop from the right side
    • bottom - number of pixels to crop from the bottom
    • left - number of pixels to crop from the left side

Return value:

A new, cropped ImageData-instance.

Examples:

import cropImageData from 'crop-image-data';

// crop 5 pixels on every side
const cropped = cropImageData(imageData, { top: 5, right: 5, bottom: 5, left: 5 });

// crop 50 pixels from the top
const croppedTop = cropImageData(imageData, { top: 50 });

// crop 10 pixels on each side
const croppedSides = cropImageData(imageData, { left: 10, right: 10 });

Related packages

  • trim-image-data - finds and trims whitespace (or a specified color) from an image using crop-image-data

Package Sidebar

Install

npm i crop-image-data

Weekly Downloads

319

Version

1.0.4

License

ISC

Unpacked Size

10.9 kB

Total Files

7

Last publish

Collaborators

  • duniul