Interface Layout

See: relevant section in reference guide

interface Layout {
    $CreationOptions?: LayoutCreationOptions;
    $ID: string;
    $Type: "Pages$Layout";
    appearance: Appearance;
    canvasHeight: number;
    canvasWidth: number;
    content: LayoutContent;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    name: string;
    parameters: LayoutParameter[];
    addLayoutParameter(
        options: LayoutParameterCreationOptions,
    ): Promise<LayoutParameter>;
    getLayoutParameter(name: string): undefined | LayoutParameter;
}

Hierarchy (View Summary)

FormBaseBase
- Layout

Index

Properties

$CreationOptions? $ID $Type appearance canvasHeight canvasWidth content documentation excluded exportLevel name parameters

Methods

addLayoutParameter getLayoutParameter

Properties

`Optional`$CreationOptions

$CreationOptions?: LayoutCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Pages$Layout"

The type of the element.

appearance

appearance: Appearance

canvasHeight

canvasHeight: number

canvasWidth

canvasWidth: number

content

content: LayoutContent

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

name

name: string

parameters

parameters: LayoutParameter[]

Methods

addLayoutParameter

addLayoutParameter(
options: LayoutParameterCreationOptions,
): Promise<LayoutParameter>
Parameters
- options: LayoutParameterCreationOptions
Returns Promise<LayoutParameter>

getLayoutParameter

getLayoutParameter(name: string): undefined | LayoutParameter
Parameters
- name: string
Returns undefined | LayoutParameter