Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAbstractUnit

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

container: IStructuralUnit

The parent unit of this unit.

id

id: string

isLoadable

isLoadable: boolean

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

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

isReadOnly

isReadOnly: boolean

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

model

structureTypeName

structureTypeName: string

unit

Unit that owns/contains this thing.

Methods

allProperties

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

delete

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

    Returns void

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>[]

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

Generated using TypeDoc