ImageScript Documentation Frame

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

Extends

Image

Members

Methods

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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>

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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