evCreate API 5.7 Help

StartLayout Function

Activates a Vertical Layout session with a given page configuration for an Envision document currently opened in the Canvas Envision Creator.

StartLayout(config: [[[EvVLayoutConfig|evvlayoutconfig-interface.html]]]): Promise<void>

Parameters

config: EvVLayoutConfig

An EvVLayoutConfig object, the configuration of new pages automatically added during the Vertical Layout session activated by the function call for an Envision document currently opened in the Canvas Envision Creator app.

Return value

Promise<void>

A Promise that, if fulfilled, resolves to void if the Vertical Layout session has been successfully activated for the current document.

Discussion

The function will activate another Vertical Layout session if Vertical Layout mode has already been activated.

22 April 2025