SetSnapshotStatus

Controls whether a static stored image or dynamic current view of the magnified area is displayed in the lens frame of a given lens item from an Envision document currently opened in the Canvas Envision Creator app.

    SetSnapshotStatus(
        lensObj: [[[EvItem|canvas-envision-document-items.html#object-items]]], 
        snapshot: boolean, 
        dpi?: number
    ): Promise<void>

Parameters

lensObj: EvItem

An Object item object, a lens item from the Envision document currently opened in the Canvas Envision Creator app whose lens frame should be reset to display a static stored image or dynamic current view of the magnified area.

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

snapshot: boolean

A Boolean, a switch to determine how the lens frame of the given lens item should display the magnified area:

true: captures, stores, and displays a rendered image of the magnified area. It will always show this static stored image, even when the magnified area or lens frame is updated.
false: removes the stored image and dynamically displays the current view of the magnified area. It will reflect updates of the magnified area or lens frame in real time.

dpi?: number

A number, the resolution of the rendered image of the magnified area in pixels per inch (ppi).

A value given in this property is kept in the given lens item for the future. If this property is not given in the following function call for the given lens item, the value from the previous function call is used.

The default value for a new lens item is 300 ppi.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the lens frame of the given lens item in the current document has been successfully reset to display a static stored image or dynamic current view of the magnified area.

01 May 2025