Interface Page

See: relevant section in reference guide

interface Page {
    $CreationOptions?: PageCreationOptions;
    $ID: string;
    $Type: "Pages$Page";
    allowedRoles: string[];
    appearance: Appearance;
    canvasHeight: number;
    canvasWidth: number;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    layoutCall: LayoutCall;
    markAsUsed: boolean;
    name: string;
    parameter: string;
    parameters: PageParameter[];
    popupCloseAction: string;
    popupHeight: number;
    popupResizable: boolean;
    popupWidth: number;
    title: Text;
    url: string;
    variables: LocalVariable[];
    addLocalVariable(options: LocalVariableCreationOptions): Promise<LocalVariable>;
    addPageParameter(options: PageParameterCreationOptions): Promise<PageParameter>;
    getLocalVariable(name: string): LocalVariable;
    getPageParameter(name: string): PageParameter;
}

Hierarchy (view full)

FormBaseBase
- Page

Properties

`Optional`$CreationOptions

$CreationOptions?: PageCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type

The type of the element.

allowedRoles

allowedRoles: string[]

appearance

appearance: Appearance

canvasHeight

canvasHeight: number

canvasWidth

canvasWidth: number

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

layoutCall

layoutCall: LayoutCall

markAsUsed

markAsUsed: boolean

name

name: string

parameter

parameter: string

parameters

parameters: PageParameter[]

popupCloseAction

popupCloseAction: string

popupHeight

popupHeight: number

popupResizable

popupResizable: boolean

popupWidth

popupWidth: number

title

title: Text

url

url: string

variables

variables: LocalVariable[]

Methods

addLocalVariable

addLocalVariable(options): Promise<LocalVariable>
Parameters
- options: LocalVariableCreationOptions
Returns Promise<LocalVariable>

addPageParameter

addPageParameter(options): Promise<PageParameter>
Parameters
- options: PageParameterCreationOptions
Returns Promise<PageParameter>

getLocalVariable

getLocalVariable(name): LocalVariable
Parameters
- name: string
Returns LocalVariable

getPageParameter

getPageParameter(name): PageParameter
Parameters
- name: string
Returns PageParameter