Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layout

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___acceptButtonPlaceholder

___acceptButtonPlaceholder: any

Private ___acceptPlaceholderName

___acceptPlaceholderName: any

Private ___cancelButtonPlaceholder

___cancelButtonPlaceholder: any

Private ___cancelPlaceholderName

___cancelPlaceholderName: any

Private ___class

___class: any

Private ___layoutCall

___layoutCall: any

Private ___layoutType

___layoutType: any

Private ___mainPlaceholder

___mainPlaceholder: any

Private ___mainPlaceholderName

___mainPlaceholderName: any

Private ___style

___style: any

Private ___useMainPlaceholderForPopups

___useMainPlaceholderForPopups: any

Private ___widget

___widget: any

acceptButtonPlaceholder

acceptButtonPlaceholder: ILayoutParameter

In version 6.8.0: deleted

acceptButtonPlaceholderQualifiedName

acceptButtonPlaceholderQualifiedName: string

acceptPlaceholderName

acceptPlaceholderName: string

In version 6.8.0: introduced

cancelButtonPlaceholder

cancelButtonPlaceholder: ILayoutParameter

In version 6.8.0: deleted

cancelButtonPlaceholderQualifiedName

cancelButtonPlaceholderQualifiedName: string

cancelPlaceholderName

cancelPlaceholderName: string

In version 6.8.0: introduced

canvasHeight

canvasHeight: number

canvasWidth

canvasWidth: number

class

class: string

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

documentation

documentation: string

excluded

excluded: boolean

id

id: string

isLoaded

isLoaded: boolean

layoutCall

layoutCall: LayoutCall

In version 6.8.0: added optional

layoutType

layoutType: LayoutType

In version 6.8.0: added public

mainPlaceholder

mainPlaceholder: ILayoutParameter

In version 6.8.0: deleted

mainPlaceholderName

mainPlaceholderName: string

In version 6.8.0: introduced

mainPlaceholderQualifiedName

mainPlaceholderQualifiedName: string

model

model: IModel

moduleName

moduleName: string

Returns the module name of the model unit, which is the first section of the qualified name.

name

name: string

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

style

style: string

typeName

typeName: string

unit

unit:

useMainPlaceholderForPopups

useMainPlaceholderForPopups: boolean

versionInfo

versionInfo: StructureVersionInfo

widget

widget: Widget

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

findElementById

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

  • 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.

    Type parameters

    Parameters

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

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

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