SetOutline Function

Updates the outline of a given object item from an Envision document currently opened in the Canvas Envision Creator app.

    SetOutline(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], outline: [[[EvOutline|evoutline-interface.html]]]): Promise<void>

Parameters

obj: EvItem: An Object item object, an object item from the Envision document currently opened in the Canvas Envision Creator app whose outline should be updated.
outline: EvOutline: An EvOutline object, a new outline that should be set for the given object item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the outline of the given object item has been successfully updated.

Discussion

Trying to update the outline of an object item that does not support an outline, such as an image item, throws an error.

27 March 2025