Options
All
  • Public
  • Public/Protected
  • All
Menu

In version 11.8.0: removed experimental In version 11.1.0: introduced

Hierarchy

Implemented by

Index

Properties

This property is required and cannot be set to null.

container: IAbstractElement
containerAsDataTransformer: IDataTransformer
id: string
inputElement: IStructureElement

This property is required and cannot be set to null.

isLoaded: boolean
model: IModel
outputElement: IStructureElement

This property is required and cannot be set to null.

structureTypeName: string

Unit that owns/contains this thing.

Methods

  • load(callback: (element: Step) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Step>
  • Parameters

    • callback: (element: Step) => void
        • (element: Step): void
        • Parameters

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Step>

  • 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