Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Image

Hierarchy

  • Image

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly complete

complete: boolean

Retrieves whether the object is fully loaded.

dataMode

dataMode: number

Applies to JPEG images drawn to PDF canvases only. Setting img.dataMode = Image.MODE_MIME or Image.MODE_MIME|Image.MODE_IMAGE enables image MIME data tracking. When MIME data is tracked, PDF canvases can embed JPEGs directly into the output, rather than re-encoding into PNG. This can drastically reduce filesize and speed up rendering.

height

height: number

Sets or retrieves the height of the image.

Readonly naturalHeight

naturalHeight: number

The original height of the image resource before sizing.

Readonly naturalWidth

naturalWidth: number

The original width of the image resource before sizing.

onerror

onerror: null | ((err: Error) => void)

onload

onload: null | (() => void)

src

src: string | Buffer

The URL, data: URI or local file path of the image to be loaded, or a Buffer instance containing an encoded image.

width

width: number

Sets or retrieves the width of the image.

Static Readonly MODE_IMAGE

MODE_IMAGE: number

Track image data

Static Readonly MODE_MIME

MODE_MIME: number

Track MIME data

Generated using TypeDoc