Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IEntity

Hierarchy

Implemented by

Index

Properties

attributes

attributes: IList<IAttribute>

capabilities

capabilities: IEntityCapabilities

This property is required and cannot be set to null.

In version 9.0.1: deleted In version 8.12.0: introduced

container

container: IAbstractElement

containerAsDomainModel

containerAsDomainModel: IDomainModel

documentation

documentation: string

In version 9.10.0: added public

generalization

generalization: IGeneralizationBase

This property is required and cannot be set to null.

id

id: string

isLoaded

isLoaded: boolean

isRemote

isRemote: boolean

In version 8.10.0: deleted In version 8.2.0: added public In version 7.17.0: introduced

location

location: IPoint

In version 9.10.0: added public

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string | null

Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

remoteSourceDocumentQualifiedName

remoteSourceDocumentQualifiedName: string | null

source

source: IEntitySource | null

In version 8.10.0: introduced

structureTypeName

structureTypeName: string

unit

Unit that owns/contains this thing.

Methods

allProperties

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

asLoaded

findElementById

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<Entity>
  • Parameters

    • callback: function
        • Parameters

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<Entity>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]
  • Returns all properties when this structure is loaded, otherwise just the public properties.

    Returns AbstractProperty<any, any>[]

publicProperties

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

toJSON

  • 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

  • traverse(visit: function): 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

  • traverseFind<T>(visit: function): T | null
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc