Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Microflows$Flow"
versionInfo: StructureVersionInfo = ...

Accessors

  • get container(): TContainer
  • Returns TContainer

  • get destinationBezierVector(): ISize
  • set destinationBezierVector(newValue: ISize): void
  • In version 10.16.0: deleted

    Returns ISize

  • In version 10.16.0: deleted

    Parameters

    Returns void

  • get destinationConnectionIndex(): number
  • set destinationConnectionIndex(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

  • get line(): Line
  • set line(newValue: Line): void
  • In version 10.16.0: introduced

    Returns Line

  • In version 10.16.0: introduced

    Parameters

    Returns void

  • In version 10.16.0: deleted In version 10.8.0: introduced

    Returns FlowLineType

  • In version 10.16.0: deleted In version 10.8.0: introduced

    Parameters

    Returns void

  • get model(): TModel
  • Returns TModel

  • get originBezierVector(): ISize
  • set originBezierVector(newValue: ISize): void
  • In version 10.16.0: deleted

    Returns ISize

  • In version 10.16.0: deleted

    Parameters

    Returns void

  • get originConnectionIndex(): number
  • set originConnectionIndex(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

Methods

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns microflows.Flow

  • delete(): void
  • Deletes this element from the model.

    Returns void

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns microflows.Flow

  • getContainerAs<T>(containerType: any): T
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<microflows.Flow>

  • toJSON(): IStructureJSON
  • 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 IStructureJSON

  • 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