UI evCreate API Section
The UI section of the evCreate API includes an enumeration, interfaces, and functions to customize the graphical UI in the Canvas Envision Creator web app.
ui namespace
The UI evCreate API section is accessed with the ui namespace:
Enumerations
FormStatusAn enumeration of form statuses triggered by a user when closing a custom pop-up dialog with a form.
Interfaces
EvCreateFormResultAn interface that defines user-input data returned from a custom pop-up dialog with a form displayed in the Canvas Envision Creator web app.
EvWhiteLabelConfigAn interface that specifies a branding configuration for white-labeling the Canvas Envision Creator web app.
Functions
ShowErrorDialog(title: string, errorMessage: string): Promise<void>A function to display a custom pop-up dialog with a given title and error message in the Canvas Envision Creator web app.
ShowForm(formHtml: string, title: string, confirmLabel?: string, cancelLabel?: string, formStyles?: string): Promise<EvCreateFormResult>A function to display a custom pop-up dialog with given content and title in the Canvas Envision Creator web app and obtain the user input from that dialog.
WhiteLabel(options: EvWhiteLabelConfig): voidA function to white-label the Canvas Envision Creator web app with a given branding configuration.