Interface ImageData

An image data type that can be displayed by the Image element.

This interface is inspired by the web ImageData interface.

interface ImageData {
    path?: string;
    get data(): Uint8Array;
    get height(): number;
    get width(): number;
}

Index

Properties

Accessors

data height width

Properties

`Optional` `Readonly`path

path?: string

Returns the path of the image, if it was loaded from disk. Otherwise the property is undefined.

Accessors

data

get data(): Uint8Array
Returns the image as buffer.

Returns Uint8Array
- Defined in api/node/typescript/index.ts:110

height

get height(): number
Returns the height of the image in pixels.

Returns number
- Defined in api/node/typescript/index.ts:120

width

get width(): number
Returns the width of the image in pixels.

Returns number
- Defined in api/node/typescript/index.ts:115