Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILayoutCall

In version 7.17.0: added public

Hierarchy

Implemented by

Index

Properties

container

container: IAbstractElement

containerAsLayout

containerAsLayout: ILayout

containerAsPage

containerAsPage: IPage

containerAsPageTemplate

containerAsPageTemplate: IPageTemplate

containerAsWebLayoutContent

containerAsWebLayoutContent: IWebLayoutContent

id

id: string

isLoaded

isLoaded: boolean

layout

layout: ILayout | null

This property is required and cannot be set to null.

In version 8.0.0: removed optional In version 7.17.0: added public

layoutQualifiedName

layoutQualifiedName: string | null

model

model: IModel

structureTypeName

structureTypeName: string

unit

Unit that owns/contains this thing.

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<LayoutCall>
  • Parameters

    • callback: function
    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<LayoutCall>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]
  • Returns all properties when this structure is loaded, otherwise just the public properties.

    Returns AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

  • toJSON(): object
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns object

traverse

  • traverse(visit: function): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: function): T | null
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc