evCreate API 5.7 Help

RenderAreaTo Function

Renders a given rectangular area on the currently selected (active) page in an Envision document currently opened in the Canvas Envision Creator app into a single image and returns this image as binary data in an array of 8-bit unsigned integers.

RenderAreaTo( bounds: [[[EvRect|evrect-interface.html]]], options: [[[EvRenderOptions|evrenderoptions-interface.html]]], format: [[[EvImageFormat|evimageformat-enumeration.html]]] ): Promise<Uint8Array>

Parameters

bounds: EvRect

An EvRect object, the position and size of a given rectangular area on the currently selected page in an Envision document currently opened in the Canvas Envision Creator app that should be rendered into an image.

options: EvRenderOptions

An EvRenderOptions object, the settings for image rendering. If a setting is not given, the default setting value will be used.

format: EvImageFormat

A member of the EvImageFormat enumeration, a file format of the rendered image. The default value is "png".

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 successfully rendered from the given rectangular area on the current page in the current Envision document.

08 April 2025