evCreate API 5.7 Help

SetInset Function

Changes the inset parameter of a given multigon item from an Envision document currently opened in the Canvas Envision Creator app to a given new value.

SetInset(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], inset: number): Promise<void>

Parameters

obj: EvItem

An Object item object, a multigon item from the Envision document currently opened in the Canvas Envision Creator app whose inset parameter should be set to the given new value.

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

If a given multigon item does not support the inset parameter, the function is executed without effect.

inset: number

A number, a given new inset value of the given multigon that controls how far the intersection points of a Star multigon or inner points of a Star Outline multigon extend inward or outward, affecting the overall appearance of the shape.

This parameter is not available for the Frame, Spoke, and Wheel multigons.

The valid range is from 0 to 300. Smaller numbers move the points in question inwards, and larger numbers move them outwards.

An inset parameter controls how far the intersection points of a Star multigon or inner points of a Star Outline 
multigon extend inward or outward, affecting the overall appearance of the shape.

Return value

Promise<void>

A Promise that, if fulfilled, resolves to void if the inset parameter of the given multigon item in the current document has been successfully set to the given new value.

01 May 2025