Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IStructure

"Something" that contains properties. Concrete sub types: MxElement, MxStructuralUnit, MxModelUnit. Abstract sub types: MxAbstractElement, MxAbstractUnit.

Each unit in the model is guaranteed to exist only once in memory.

Hierarchy

  • IStructure

Implemented by

Index

Properties

container

container: IContainer | null

id

id: string

isLoaded

isLoaded: boolean

model

structureTypeName

structureTypeName: string

unit

Unit that owns/contains this thing.

Methods

allProperties

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

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>[]
  • Returns 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
  • Traverses this structure, only visiting children contained in public properties.

    Parameters

    Returns void

Generated using TypeDoc