GetData Function

Returns an image attached to a given image item from an Envision document currently opened in the Canvas Envision Creator app as binary data of a given image file format in an array of 8-bit unsigned integers.

    GetData(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], format: [[[EvImageFormat|evimageformat-enumeration.html]]]): Promise<Uint8Array>

Parameters

obj: EvItem

An Object item object, an image item from the Envision document currently opened in the Canvas Envision Creator app whose binary image data should be obtained.

If a given object item is not an image, the function throws an error.

format: EvImageFormat

A member of the EvImageFormat enumeration, an image file format that the returned binary image data should have.

Return value

Promise<Uint8Array>: A Promise that, if fulfilled, resolves to an array of 8-bit unsigned integers that is the binary data of the image attached to the given image item in the current Envision document.

03 April 2025