SetMagnification Function

Changes the magnification factor of a given lens item from an Envision document currently opened in the Canvas Envision Creator app to a given new value.

    SetMagnification(lensObj: [[[EvItem|canvas-envision-document-items.html#object-items]]], magnification: 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 magnification factor should be set to the given new value.

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

magnification: number

A number, the new magnification factor of a given lens item, where 100 is 100% of the original size.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the magnification factor of the given lens item in the current document has been successfully set to the new given value.

04 April 2025