Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layout

Hierarchy

Implements

Index

Constructors

constructor

Properties

acceptButtonPlaceholder

acceptButtonPlaceholder: ILayoutParameter | null

In version 6.8.0: deleted

acceptButtonPlaceholderQualifiedName

acceptButtonPlaceholderQualifiedName: string | null

acceptPlaceholderName

acceptPlaceholderName: string

In version 7.9.0: deleted In version 6.8.0: introduced

appearance

appearance: Appearance

In version 8.0.0: introduced

cancelButtonPlaceholder

cancelButtonPlaceholder: ILayoutParameter | null

In version 6.8.0: deleted

cancelButtonPlaceholderQualifiedName

cancelButtonPlaceholderQualifiedName: string | null

cancelPlaceholderName

cancelPlaceholderName: string

In version 7.9.0: deleted In version 6.8.0: introduced

canvasHeight

canvasHeight: number

canvasWidth

canvasWidth: number

class

class: string

In version 8.0.0: deleted

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

content

content: LayoutContent

In version 8.0.0: introduced

documentation

documentation: string

excluded

excluded: boolean

id

id: string

isLoaded

isLoaded: boolean

layoutCall

layoutCall: LayoutCall | null

In version 8.0.0: deleted In version 7.17.0: added public In version 6.8.0: added optional

layoutType

layoutType: LayoutType

In version 8.0.0: deleted In version 6.8.0: added public

mainPlaceholder

mainPlaceholder: ILayoutParameter | null

In version 6.8.0: deleted

mainPlaceholderName

mainPlaceholderName: string

In version 7.9.0: deleted In version 6.8.0: introduced

mainPlaceholderQualifiedName

mainPlaceholderQualifiedName: string | null

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string | null

structureTypeName

structureTypeName: string

style

style: string

In version 8.0.0: deleted

unit

unit:

useMainPlaceholderForPopups

useMainPlaceholderForPopups: boolean

In version 7.9.0: deleted

widget

widget: Widget | null

In version 7.15.0: deleted

widgets

widgets: IList<Widget>

In version 8.0.0: deleted In version 7.15.0: introduced

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

  • asLoaded()
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

delete

  • delete(): void

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: function
        • (elem: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static createIn

  • Creates a new Layout unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns Layout

Generated using TypeDoc