Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IModelUnit

Model Units

A model unit is a leaf (not a node) in the project tree and the root containing model {@link elements.Element} elements. It is both a(n abstract) unit as well as "model element-like" by virtue of being an MxAbstractElement, but minus the following features of MxElement: public - a model unit is public by nature container - a model unit is itself the root of the tree of elements it contains

A unit acts as scope to resolve by-id references.

Hierarchy

Implemented by

Index

Properties

container

container: IStructuralUnit

id

id: string

isLoaded

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

model

structureTypeName

structureTypeName: string

unit

Unit that owns/contains this thing.

Methods

allProperties

asLoaded

delete

  • delete(): void
  • Returns void

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise

loadedProperties

publicProperties

toJSON

  • 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

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc