Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

Hierarchy

Implements

Index

Constructors

constructor

Properties

accessRules

accessRules: IList<AccessRule>

attributes

attributes: IList<Attribute>

container

container: AbstractElement

containerAsDomainModel

containerAsDomainModel: DomainModel

dataStorageGuid

dataStorageGuid: string

documentation

documentation: string

eventHandlers

eventHandlers: IList<EventHandler>

generalization

generalization: GeneralizationBase

id

id: string

image

image: IImage | null

imageQualifiedName

imageQualifiedName: string | null

indexes

indexes: IList<Index>

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

isRemote

isRemote: boolean

In version 7.17.0: introduced

location

location: IPoint

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string | null

remoteSource

remoteSource: string

In version 7.17.0: introduced

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

validationRules

validationRules: IList<ValidationRule>

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

  • asLoaded()
  • 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.

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • 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: function
        • (elem: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

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

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new Entity instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns Entity

Static createIn

  • Creates and returns a new Entity instance in the SDK and on the server. The new Entity will be automatically stored in the 'entities' property of the parent DomainModel element passed as argument.

    Parameters

    Returns Entity

Generated using TypeDoc