Interface IEntityKey

In version 8.9.0: introduced

Hierarchy

IElement
- IEntityKey

Implemented by

EntityKey

Properties

_container

_container: null | IContainer

internal

_declaredAsNamespace

_declaredAsNamespace: boolean

internal

Readonly _isAttached

_isAttached: boolean

internal

Readonly _isDeleted

_isDeleted: boolean

internal

Readonly _isDetached

_isDetached: boolean

internal

Readonly _isNew

_isNew: boolean

internal

Readonly container

container: IAbstractElement

id

id: string

isLoaded

isLoaded: boolean

Readonly model

model: IModel

Readonly parts

parts: IList<IEntityKeyPart>

structureTypeName

structureTypeName: string

unit

unit: IAbstractUnit

Unit that owns/contains this thing.

Readonly versionInfo

versionInfo: StructureVersionInfo

internal

Methods

_getQualifiedName

_getQualifiedName(): null | string

Inherited from IElement._getQualifiedName
internal
Returns null | string

_updateWithJson

_updateWithJson(json: IStructureJson): void

Inherited from IElement._updateWithJson
internal
Parameters
- json: IStructureJson
Returns void

allProperties

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

Inherited from IElement.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): EntityKey

Overrides IElement.asLoaded
Returns EntityKey

findElementById

findElementById(id: string): null | IAbstractElement

Inherited from IElement.findElementById
Parameters
- id: string
Returns null | IAbstractElement

load

load(callback: (element: EntityKey) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<EntityKey>

Overrides IElement.load
Parameters
- callback: (element: EntityKey) => void
  - - (element: EntityKey): void
    - Parameters
      - element: EntityKey
      Returns void
- Optional forceRefresh: boolean
Returns void
Overrides IElement.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<EntityKey>

loadedProperties

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

Inherited from IElement.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

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

Inherited from IElement.publicProperties
Returns AbstractProperty<any, any>[]

resolveByIdReferences

resolveByIdReferences(): void

Inherited from IElement.resolveByIdReferences
internal
Returns void

toJSON

toJSON(): object

Inherited from IElement.toJSON

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

Inherited from IElement.traverse

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

traverseFind

traverseFind<T>(visit: (structure: IStructure) => T): null | T

Inherited from IElement.traverseFind

Traverses this structure, returning immediately when visit returns something other than null.

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

traversePublicParts(visit: (structure: IStructure) => void): void

Inherited from IElement.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Generated using TypeDoc