Constructor

# new Frame(width, height, durationopt, xOffsetopt, yOffsetopt, disposalModeopt) → {Frame}

Creates a new, blank frame

Parameters:

Name	Type	Attributes	Default	Description
`width`	number
`height`	number
`duration`	number	<optional>	100	The frames duration (in ms)
`xOffset`	number	<optional>	0	The frames offset on the x-axis
`yOffset`	number	<optional>	0	The frames offset on the y-axis
`disposalMode`	string \| number	<optional>	Frame.DISPOSAL_KEEP	The frame's disposal mode (`Frame.DISPOSAL_KEEP`, `Frame.DISPOSAL_PREVIOUS` or `Frame.DISPOSAL_BACKGROUND`)

View Source ImageScript.js, line 1224

Returns:

Type: Frame

Extends

Image

Members

Type: Uint8ClampedArray

# bitmap

The images RGBA pixel data

Overrides:

Image#bitmap

View Source ImageScript.js, line 55

# disposalMode

The Frame's disposal mode

View Source ImageScript.js, line 1283

# disposalMode

Sets the frame's disposal mode, converting it to the internal numeric value.

View Source ImageScript.js, line 1291

# height

The images height

Overrides:

Image#height

View Source ImageScript.js, line 78

# width

The images width

Overrides:

Image#width

View Source ImageScript.js, line 70

# static DISPOSAL_BACKGROUND

GIF frame disposal mode BACKGROUND. For use with Frame

View Source ImageScript.js, line 1245

# static DISPOSAL_KEEP

GIF frame disposal mode KEEP. For use with Frame

View Source ImageScript.js, line 1229

# static DISPOSAL_PREVIOUS

GIF frame disposal mode PREVIOUS. For use with Frame

View Source ImageScript.js, line 1237

Methods

# averageColor() → {number}

Gets the average color of the image

Overrides:

Image#averageColor

View Source ImageScript.js, line 769

Returns:

Type: number

# blue(saturation, absolute) → {Image}

Sets the blue channels saturation

Parameters:

Name	Type	Default	Description
`saturation`	number		The saturation to apply (0..1)
`absolute`	boolean	false	Whether to scale the current saturation (false) or just set the new saturation (true)

Overrides:

Image#blue

View Source ImageScript.js, line 637

Returns:

Type: Image

# clone() → {Image}

Clones the current image

Overrides:

Image#clone

View Source ImageScript.js, line 323

Returns:

Type: Image

# composite(source, xopt, yopt) → {Image}

Composites (overlays) the source onto this image at the specified coordinates

Parameters:

Name	Type	Attributes	Default	Description
`source`	Image			The image to place
`x`	number	<optional>	0	The x position to place the image at
`y`	number	<optional>	0	The y position to place the image at

Overrides:

Image#composite

View Source ImageScript.js, line 696

Returns:

Type: Image

# contain(width, height, modeopt) → {Image}

Resizes the image so it is contained in the given bounding box. Can return an image with one axis smaller than the given bounding box.

Parameters:

Name	Type	Attributes	Default	Description
`width`	number			The width of the bounding box
`height`	number			The height of the bounding box
`mode`	string	<optional>	Image.RESIZE_NEAREST_NEIGHBOR	The resizing mode to use

Overrides:

Image#contain

View Source ImageScript.js, line 383

Returns:

The resized image

Type: Image

# cover(width, height, modeopt) → {Image}

Resizes the image so it covers the given bounding box, cropping the overflowing edges. Always returns the exact dimensions of the bounding box.

Parameters:

Name	Type	Attributes	Default	Description
`width`	number			The width of the bounding box
`height`	number			The height of the bounding box
`mode`	string	<optional>	Image.RESIZE_NEAREST_NEIGHBOR	The resizing mode to use

Overrides:

Image#cover

View Source ImageScript.js, line 411

Returns:

The resized image

Type: Image

# crop(x, y, width, height) → {Image}

Crops an image to the specified dimensions

Parameters:

Name	Type	Description
`x`	number	The x offset
`y`	number	The y offset
`width`	number	The new images width
`height`	number	The new images height

Overrides:

Image#crop

View Source ImageScript.js, line 460

Returns:

Type: Image

# cropCircle(maxopt, featheringopt) → {Image}

Crops the image into a circle

Parameters:

Name	Type	Attributes	Default	Description
`max`	boolean	<optional>	false	Whether to use the larger dimension for the size
`feathering`	number	<optional>	0	How much feathering to apply to the edges

Overrides:

Image#cropCircle

View Source ImageScript.js, line 580

Returns:

Type: Image

# dominantColor(ignoreBlackopt, ignoreWhiteopt, bwThresholdopt) → {number}

Gets the images dominant color

Parameters:

Name	Type	Attributes	Default	Description
`ignoreBlack`	boolean	<optional>	true	Whether to ignore dark colors below the threshold
`ignoreWhite`	boolean	<optional>	true	Whether to ignore light colors above the threshold
`bwThreshold`	number	<optional>	0xf	The black/white threshold (0-64)

Overrides:

Image#dominantColor

View Source ImageScript.js, line 789

Returns:

The images dominant color

Type: number

# drawBox(x, y, width, height, color) → {Image}

Draws a box at the specified coordinates

Parameters:

Name	Type	Description
`x`	number	The x offset
`y`	number	The y offset
`width`	number	The box width
`height`	number	The box height
`color`	number \| colorFunction	The color to fill the box in with

Overrides:

Image#drawBox

View Source ImageScript.js, line 498

Returns:

Type: Image

# drawCircle(x, y, radius, color) → {Image}

Draws a circle at the specified coordinates with the specified radius

Parameters:

Name	Type	Description
`x`	number	The center x position
`y`	number	The center y position
`radius`	number	The circles radius
`color`	number \| colorFunction

Overrides:

Image#drawCircle

View Source ImageScript.js, line 562

Returns:

Type: Image

# async encode(compression, metaopt) → {Promise.<Uint8Array>}

Encodes the image into a PNG

Parameters:

Name	Type	Attributes	Default	Description
`compression`	number		1	The compression level to use (0-9)
`meta`	PNGMetadata	<optional>	{}	Image metadata

Overrides:

Image#encode

View Source ImageScript.js, line 1016

Returns:

The encoded data

Type: Promise.<Uint8Array>

# async encodeJPEG(qualityopt) → {Promise.<Uint8Array>}

Encodes the image into a JPEG

Parameters:

Name	Type	Attributes	Default	Description
`quality`	number	<optional>	90	The JPEG quality to use (1-100)

Overrides:

Image#encodeJPEG

View Source ImageScript.js, line 1053

Returns:

Type: Promise.<Uint8Array>

# async encodeWEBP(qualityopt) → {Promise.<Uint8Array>}

Encodes the image into a WEBP

Parameters:

Name	Type	Attributes	Default	Description
`quality`	null \| number	<optional>	null	The WEBP quality to use (0-100) (null is lossless)

Overrides:

Image#encodeWEBP

View Source ImageScript.js, line 1066

Returns:

Type: Promise.<Uint8Array>

# fill(color) → {Image}

Fills the image data with the supplied color

Parameters:

Name	Type	Description
`color`	number \| colorFunction

Overrides:

Image#fill

View Source ImageScript.js, line 313

Returns:

Type: Image

# fit(width, height, modeopt) → {Image}

Resizes the image so it is contained in the given bounding box, placing it in the center of the given bounding box. Always returns the exact dimensions of the bounding box.

Parameters:

Name	Type	Attributes	Default	Description
`width`	number			The width of the bounding box
`height`	number			The height of the bounding box
`mode`	string	<optional>	Image.RESIZE_NEAREST_NEIGHBOR	The resizing mode to use

Overrides:

Image#fit

View Source ImageScript.js, line 396

Returns:

The resized image

Type: Image

# getPixelAt(x, y) → {number}

Gets the pixel color at the specified position

Parameters:

Name	Type	Description
`x`	number
`y`	number

Overrides:

Image#getPixelAt

View Source ImageScript.js, line 235

Returns:

The color value

Type: number

# getRGBAAt(x, y) → {Uint8ClampedArray}

Gets the pixel color at the specified position

Parameters:

Name	Type	Description
`x`	number
`y`	number

Overrides:

Image#getRGBAAt

View Source ImageScript.js, line 246

Returns:

The RGBA value

Type: Uint8ClampedArray

# green(saturation, absolute) → {Image}

Sets the green channels saturation

Parameters:

Name	Type	Default	Description
`saturation`	number		The saturation to apply (0..1)
`absolute`	boolean	false	Whether to scale the current saturation (false) or just set the new saturation (true)

Overrides:

Image#green

View Source ImageScript.js, line 622

Returns:

Type: Image

# hueShift(degrees)

Shifts the images hue

Parameters:

Name	Type	Description
`degrees`	number	How many degrees to shift the hue by

Overrides:

Image#hueShift

View Source ImageScript.js, line 756

# invert() → {Image}

Inverts the images colors

Overrides:

Image#invert

View Source ImageScript.js, line 706

Returns:

Type: Image

# invertHue() → {Image}

Inverts the images hue

Overrides:

Image#invertHue

View Source ImageScript.js, line 743

Returns:

Type: Image

# invertSaturation() → {Image}

Inverts the images saturation

Overrides:

Image#invertSaturation

View Source ImageScript.js, line 730

Returns:

Type: Image

# invertValue() → {Image}

Inverts the images value (lightness)

Overrides:

Image#invertValue

View Source ImageScript.js, line 717

Returns:

Type: Image

# generator iterateWithColors() → {Array.<number>}

Yields an [x, y, color] array for every pixel in the image

Overrides:

Image#iterateWithColors

View Source ImageScript.js, line 95

Yields:

The coordinates and color of the pixel ([x, y, color])

Type: Array.<number>

# lightness(value, absolute) → {Image}

Sets the brightness of the image

Parameters:

Name	Type	Default	Description
`value`	number		The lightness to apply (0..1)
`absolute`	boolean	false	Whether to scale the current lightness (false) or just set the new lightness (true)

Overrides:

Image#lightness

View Source ImageScript.js, line 663

Returns:

Type: Image

# opacity(opacity, absolute) → {Image}

Sets the images opacity

Parameters:

Name	Type	Default	Description
`opacity`	number		The opacity to apply (0..1)
`absolute`	boolean	false	Whether to scale the current opacity (false) or just set the new opacity (true)

Overrides:

Image#opacity

View Source ImageScript.js, line 592

Returns:

Type: Image

# red(saturation, absolute) → {Image}

Sets the red channels saturation

Parameters:

Name	Type	Default	Description
`saturation`	number		The saturation to apply (0..1)
`absolute`	boolean	false	Whether to scale the current saturation (false) or just set the new saturation (true)

Overrides:

Image#red

View Source ImageScript.js, line 607

Returns:

Type: Image

# resize(width, height, modeopt) → {Image}

Resizes the image to the given dimensions. Use Image.RESIZE_AUTO as either width or height to automatically preserve the aspect ratio.

Parameters:

Name	Type	Attributes	Default	Description
`width`	number			The new width
`height`	number			The new height
`mode`	string	<optional>	Image.RESIZE_NEAREST_NEIGHBOR	The resizing mode to use

Overrides:

Image#resize

View Source ImageScript.js, line 370

Returns:

The resized image

Type: Image

# rotate(angle, resize)

Rotates the image the given amount of degrees

Parameters:

Name	Type	Default	Description
`angle`	number		The angle to rotate the image for (in degrees)
`resize`	boolean	true	Whether to resize the image so it fits all pixels or just ignore outlying pixels

Overrides:

Image#rotate

View Source ImageScript.js, line 823

# roundCorners(radiusopt) → {Image}

Rounds the images corners

Parameters:

Name	Type	Attributes	Default	Description
`radius`	number	<optional>	min(width,height)/4	The radius of the corners

Overrides:

Image#roundCorners

View Source ImageScript.js, line 907

Returns:

Type: Image

# saturation(value, absolute) → {Image}

Sets the saturation of the image

Parameters:

Name	Type	Default	Description
`value`	number		The saturation to apply (0..1)
`absolute`	boolean	false	Whether to scale the current saturation (false) or just set the new saturation (true)

Overrides:

Image#saturation

View Source ImageScript.js, line 679

Returns:

Type: Image

# scale(factor, modeopt) → {Image}

Resizes the image by the given factor

Parameters:

Name	Type	Attributes	Default	Description
`factor`	number			The factor to resize the image with
`mode`	string	<optional>	Image.RESIZE_NEAREST_NEIGHBOR	The resizing mode to use

Overrides:

Image#scale

View Source ImageScript.js, line 351

Returns:

Type: Image

# setPixelAt(x, y, pixelColor)

Sets the pixel color for the specified position

Parameters:

Name	Type	Description
`x`	number
`y`	number
`pixelColor`	number

Overrides:

Image#setPixelAt

View Source ImageScript.js, line 258

# static from(image, durationopt, xOffsetopt, yOffsetopt, disposalModeopt) → {Frame}

Converts an Image instance to a Frame, cloning it in the process

Parameters:

Name	Type	Attributes	Default	Description
`image`	Image			The image to create the frame from
`duration`	number	<optional>	100	The frames duration (in ms)
`xOffset`	number	<optional>	0	The frames offset on the x-axis
`yOffset`	number	<optional>	0	The frames offset on the y-axis
`disposalMode`	string \| number	<optional>	Frame.DISPOSAL_KEEP	The frames disposal mode (`Frame.DISPOSAL_KEEP`, `Frame.DISPOSAL_PREVIOUS` or `Frame.DISPOSAL_BACKGROUND`)

View Source ImageScript.js, line 1308

Returns:

Type: Frame