evCreate API 5.7 Help

Document evCreate API Section

The Document section of the evCreate API includes enumerations, interfaces, and functions to manage items on the document level of the Envision document hierarchy.

document namespace

The Document evCreate API section is accessed with the document namespace:

evCreate.document.Function()

Enumerations

EvPageType

An enumeration of options for the types of pages in Envision documents.

Interfaces

DocumentContext

An interface that describes the context of a given .evdoc file.

Functions

AddPage(atIndex?: number, isMaster?: boolean, name?: string): Promise<EvItem>

A function to add a new page to the current Envision document.

CountObjects(): Promise<number>

A function to count objects in the current Envision document.

CountPages(type: EvPageType): Promise<number>

A function to count pages in the current Envision document.

EnableRendering(enable: boolean): Promise<boolean>

A function to turn the rendering of the current Envision document on or off.

GetContext(): Promise<DocumentContext>

A function to get an item object with the context of the current Envision document.

GetCurrentPage(): Promise<EvItem>

A function to get an item object of the current page in the current Envision document.

GetEvCoordinate(xyViewport: EvCoord2D): Promise<EvCoord2D>

A function to convert a 2D coordinate from the coordinate space of the browser viewport to the one of the Envision document.

GetObjects(): Promise<EvItem[]>

A function to get all the item objects from the current Envision document.

GetPages(type: EvPageType): Promise<EvItem[]>

A function to get the item objects of pages from the current Envision document.

GetViewportCoordinate(xyEv: EvCoord2D): Promise<EvCoord2D>

A function to convert a 2D coordinate from the coordinate space of the Envision document to the one of the browser viewport.

RemovePage(page: EvItem): Promise<void>

A function to permanently remove a given page from the current Envision document.

SetCurrentPage(page: EvItem): Promise<void>

A function to set a given page as current in the current Envision document.

12 March 2025