RenderTo Function

Renders one or more given object items from 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.

    RenderTo(
        objs: [[[EvItem|canvas-envision-document-items.html#object-items]]][], 
        options?: [[[EvRenderOptions|evrenderoptions-interface.html]]], 
        format?: [[[EvImageFormat|evimageformat-enumeration.html]]]
    ): Promise<Uint8Array>

Parameters

objs: EvItem[]: An array of Object item objects, one or more object items in the 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 object items in the current Envision document.

27 March 2025