evCreate API 5.7 Help

Break Function

Breaks a given composite item from an Envision document currently opened in the Canvas Envision Creator app into object items that were included in it.

Break(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]]): Promise<[[[EvItem|canvas-envision-document-items.html#object-items]]][]>

Parameters

obj: EvItem

An Object item object, a composite item from the Envision document currently opened in the Canvas Envision Creator app that should be broken into object items that were included in it.

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

Return value

Promise<EvItem[]>

A Promise that, if fulfilled, resolves to an array of Object item objects that were included in the broken composite item.

10 April 2025