Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Structure<TModel, TContainer>

Type parameters

Hierarchy

  • Structure

Implements

Index

Constructors

constructor

  • Parameters

    • _model: AbstractModel
    • structureTypeName: string
    • id: string
    • Optional _isPartial: undefined | false | true
    • Optional container: IContainer | null

    Returns Structure

Properties

id

id: string

structureTypeName

structureTypeName: string

Accessors

container

  • get (): TContainer
  • Returns TContainer

isLoaded

  • get (): boolean
  • Returns boolean

model

  • get (): TModel
  • Returns TModel

unit

Methods

allProperties

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

Abstract delete

  • delete(): void
  • Deletes a model from the model. This will automatically remove the item from its model parent, and update incoming references and send server changes.

    Returns void

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T
  • Type parameters

    Parameters

    • containerType: any

    Returns T

loadedProperties

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

publicProperties

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

toJSON

traverse

  • traverse(visit: function): void
  • Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: function): T | null
  • Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void
  • Parameters

    Returns void

Generated using TypeDoc