Options
All
  • Public
  • Public/Protected
  • All
Menu

An abstract unit is a vertex, and usually: a node, in the project tree, i.e. a macro-level construct. Examples are: modules, folders, microflows, pages. This interface is implemented by AbstractUnit.

Hierarchy

Implemented by

Index

Properties

container: IStructuralUnit

The parent unit of this unit.

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.

structureTypeName: string

Unit that owns/contains this thing.

Methods

  • delete(): void
  • Deletes the unit from the model

    Returns 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