Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

id: string
structureTypeName: string

Accessors

  • get container(): TContainer
  • Returns TContainer

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

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

    Returns boolean

  • get model(): TModel
  • Returns TModel

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 Element<TModel>

  • Creates a deep copy of this element and its children.

    Parameters

    Returns Element<TModel>

  • delete(): void
  • Detaches this element from the model, so that it can be attached in a different place.

    Returns Element<TModel>

  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: Element<TModel>) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Element<TModel>>
  • 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

    • callback: (elem: Element<TModel>) => void
        • Parameters

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Element<TModel>>

  • 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
  • traversePublicParts(visit: (structure: IStructure) => void): void

Generated using TypeDoc