RenderTo Function

Renders a given page in an Envision document currently opened in the Canvas Envision Creator app into an image encoded as a base64 string.

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

Parameters

page?: EvItem: A Page item object of a page in the Envision document currently opened in the Canvas Envision Creator app that should be rendered into an image. If it is not given, the currently selected (active) page is rendered.
options?: EvRenderOptions: An EvRenderOptions object with 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<string>: A Promise that, if fulfilled, resolves to a base64 string that encodes the image successfully rendered from the given page in the current Envision document.

13 March 2025