Class ImageBeta

The image class provides basic image manipulation and inspection.

This API is currently considered somewhat unstable, there are bugs here as working with a lot of image formats (and animations) is surprisingly hard

Decoding Formats supported are:

  • png
  • jpeg
  • gif
  • webp
  • pnm
  • tiff
  • tga
  • bmp
  • ico
  • hdr
  • openexr
  • qoi
  • avif

Encoding formats supported:

  • png (encoding animations not supported yet)
  • jpeg
  • gif
  • webp (encoding animations not supported yet)

There are known bugs and issues currently with some of these formats so consider this API to be in beta.

Constructors

constructor

Properties

data properties

Methods

dataUri resize transcode downloadFromUrl

Constructors

constructor

  • new Image(data, properties?): Image

  • Parameters

    Returns Image

Properties

Readonly data

data: ArrayBuffer

Readonly properties

properties: ImageProperties

Methods

dataUri

  • dataUri(): string

  • Returns string

resize

  • resize(newWidth, newHeight): Promise<Image>

  • Parameters

    • newWidth: number
    • newHeight: number

    Returns Promise<Image>

transcode

Static downloadFromUrl

  • downloadFromUrl(url): Promise<Image>

  • Parameters

    • url: string

    Returns Promise<Image>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc