SetViewArea Function

Controls which object items from the vertical stack of object items in the magnified area are displayed in the lens frame of a given lens item from an Envision document currently opened in the Canvas Envision Creator app depending on their vertical layout position relative to the one of the given lens item.

    SetViewArea(
        lensObj: [[[EvItem|canvas-envision-document-items.html#object-items]]], 
        viewArea: [[[EvLensMagnificationViewArea|evlensmagnificationviewarea-enumeration.html]]]
    ): 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 setting for displaying object items depending on their vertical layout position should be changed.

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

viewArea: EvLensMagnificationViewArea

A member of the EvLensMagnificationViewArea enumeration, a setting that defines which object items from the vertical stack of object items in the magnification area should be displayed in the lens frame of the given lens item depending on their vertical layout position relative to the one of the given lens item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the setting of the given lens item in the current document for displaying object items depending on their vertical layout position has been successfully changed.

04 April 2025