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
appStoreGuid: string
appStorePackageId: number

In version 8.13.0: introduced

appStoreVersion: string
appStoreVersionGuid: string
container: IStructuralUnit

The parent unit of this unit.

containerAsFolderBase: IFolderBase
containerAsProject: IProject
documents: IList<IDocument>
domainModel: IDomainModel

This property is required and cannot be set to null.

exportLevel: ModuleExportLevel

In version 9.8.0: deleted In version 9.3.0: introduced

folders: IList<IFolder>
fromAppStore: boolean
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.

isReusableComponent: boolean

In version 9.1.0: deleted In version 8.5.0: introduced

isThemeModule: boolean

In version 9.3.0: introduced

model: IModel
moduleSecurity: IModuleSecurity

This property is required and cannot be set to null.

moduleSettings: IModuleSettings

This property is required and cannot be set to null.

In version 9.8.0: introduced

name: string
sortIndex: number

The index of where this Module appears in the project. This property is required, and of type double. Also, its value needs to be unique among its siblings (meaning, in code: containerAsProject.modules) in the project. In other words: containerAsProject.modules.map(m => m.sortedIndex) (TS syntax) needs to be a list with unique values.

structureTypeName: string

Unit that owns/contains this thing.

internal

Methods

  • _deleteInternal(): void
  • _markLoaded(): void
  • _markLoading(): void
  • _markNotLoaded(): void
  • _registerAfterLoadCallback(callback: (unit: IAbstractUnit) => void): void
  • delete(): void
  • resolveByIdReferences(): void
  • 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 IAbstractElementJson

  • 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