evCreate API 5.7 Help

SetZOrder for Object Function

Moves a given object item to:

  • A given layer item.

  • A given position in the stack of object items on the given layer.

SetZOrder(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], zOrder: [[[EvObjectZOrder|evobjectzorder-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 that should be moved to the given stack position on the given layer.

zOrder: EvObjectZOrder

An EvObjectZOrder object that includes:

  • The layer item object of the layer item where the given object item should be moved. If the layer is not specified, the given object item is moved to the current layer on the current page.

  • The position of the given object item in the stack of object items on the given layer item. It is a zero-based index that is 0 for the topmost object item on the layer and increases by 1 for each following object item going down the stack.

Return value

Promise<void>

A Promise that, if fulfilled, resolves to void if the given object item has been successfully moved to the given stack position on the given layer in the current Envision document.

27 March 2025