@express-document-sdk

Class: BitmapImage

Represents a bitmap image resource. Use Editor.loadBitmapImage to create a BitmapImage, and then Editor.createImageContainer to display it in the document by creating a MediaContainerNode structure.

Extends

Constructors

Constructor

new BitmapImage(): BitmapImage;

Returns

BitmapImage

Inherited from

ProxyLiveObject.constructor

Accessors

width

Get Signature

get width(): number;

Original width of the bitmap in pixels.

Returns

number

height

Get Signature

get height(): number;

Original height of the bitmap in pixels.

Returns

number

Methods

data()

data(): Promise<Blob>;

Experimental

data-slots=text
data-variant=warning
IMPORTANT: This is currently experimental only and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the experimentalApis flag to true in the requirements section of the manifest.json.

Fetches the bitmap data as a Blob. Waits up to 1 minute for the bitmap to be available if necessary.

Returns

Promise<Blob>