@mendix/extensions-api - v0.2.4
    Preparing search index...

    Interface Page

    See: relevant section in reference guide

    interface Page {
        $CreationOptions?: PageCreationOptions;
        $ID: string;
        $Type: "Pages$Page";
        allowedRoles: string[];
        appearance: Appearance;
        autofocus: Autofocus;
        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): undefined | LocalVariable;
        getPageParameter(name: string): undefined | PageParameter;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type allowedRoles appearance autofocus canvasHeight canvasWidth documentation excluded exportLevel layoutCall markAsUsed name parameter parameters popupCloseAction popupHeight popupResizable popupWidth title url variables

    Methods

    addLocalVariable addPageParameter getLocalVariable getPageParameter

    Properties

    $CreationOptions?: PageCreationOptions

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "Pages$Page"

    The type of the element.

    allowedRoles: string[]
    appearance: Appearance
    autofocus: Autofocus
    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[]

    Methods

    Settings

    On This Page

    Properties
    Methods