Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implemented by

Index

Properties

_container: null | IContainer
internal
_containmentName: string

The name of the property of the parent's type which owns this unit.

internal
_declaredAsNamespace: boolean
internal
_isAttached: boolean
internal
_isDeleted: boolean
internal
_isDetached: boolean
internal
_isLoading: boolean

Whether this unit is currently being loaded.

internal
_isNew: boolean
internal

The {@link modelstore.IModelStore model store} holding the Mendix model this unit abides in.

internal
container: IStructuralUnit

The parent unit of this unit.

containerAsFolderBase: IFolderBase
containerAsModule: IModule

This property is required and cannot be set to null.

In version 8.0.0: introduced

documentation: string

In version 9.10.0: added public

excluded: boolean

In version 9.11.0: added public

id: string
isLoadable: boolean

Whether this unit and all of its children (recursively) can be loaded.

isLoaded: boolean

Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

isReadOnly: boolean

Whether this unit and all of its children (recursively) are editable.

layoutCall: null | ILayoutCall

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

layoutType: LayoutType

In version 8.0.0: deleted In version 6.8.0: added public

model: IModel
name: string
qualifiedName: null | string

Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

structureTypeName: string

Unit that owns/contains this thing.

internal

Methods

  • _deleteInternal(): void
  • _getQualifiedName(): null | string
  • _markLoaded(): void
  • _markLoading(): void
  • _markNotLoaded(): void
  • _registerAfterLoadCallback(callback: (unit: IAbstractUnit) => void): void
  • delete(): void
  • Deletes the unit from the model

    Returns void

  • load(callback: (element: Layout) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Layout>
  • Parameters

    • callback: (element: Layout) => void
        • Parameters

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Layout>

  • resolveByIdReferences(): void
  • 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(visit: (structure: IStructure) => void): 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<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void

Generated using TypeDoc