Class Entity

See: relevant section in reference guide

Hierarchy

Element<IModel>

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Entity(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): Entity

Overwrites Element.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit
- container: AbstractElement
Returns Entity

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

accessRules

get (): IList<AccessRule>

Returns IList<AccessRule>

attributes

get (): IList<Attribute>

Returns IList<Attribute>

capabilities

get (): EntityCapabilities
set (newValue: EntityCapabilities): any

In version 9.0.1: deleted In version 8.12.0: introduced

Returns EntityCapabilities
In version 9.0.1: deleted In version 8.12.0: introduced

Parameters
- newValue: EntityCapabilities
Returns any

container

get (): AbstractElement

Inherited from AbstractUnit.container

Returns AbstractElement

containerAsDomainModel

get (): DomainModel

Returns DomainModel

dataStorageGuid

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

documentation

get (): string
set (newValue: string): any

In version 9.10.0: added public

Returns string
In version 9.10.0: added public

Parameters
- newValue: string
Returns any

eventHandlers

get (): IList<EventHandler>

Returns IList<EventHandler>

exportLevel

get (): ExportLevel
set (newValue: ExportLevel): any

In version 9.3.0: introduced

Returns ExportLevel
In version 9.3.0: introduced

Parameters
- newValue: ExportLevel
Returns any

generalization

get (): GeneralizationBase
set (newValue: GeneralizationBase): any

Returns GeneralizationBase
Parameters
- newValue: GeneralizationBase
Returns any

image

get (): IImage | null
set (newValue: IImage | null): any

Returns IImage | null
Parameters
- newValue: IImage | null
Returns any

imageQualifiedName

get (): string | null

Returns string | null

indexes

get (): IList<Index>

Returns IList<Index>

isLoaded

get (): boolean

Inherited from Element.isLoaded

Overwrites AbstractElement.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

isRemote

get (): boolean
set (newValue: boolean): any

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

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

Parameters
- newValue: boolean
Returns any

location

get (): IPoint
set (newValue: IPoint): any

In version 9.10.0: added public

Returns IPoint
In version 9.10.0: added public

Parameters
- newValue: IPoint
Returns any

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

name

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

qualifiedName

get (): string | null

Returns string | null

remoteSource

get (): string
set (newValue: string): any

In version 8.10.0: deleted In version 7.17.0: introduced

Returns string
In version 8.10.0: deleted In version 7.17.0: introduced

Parameters
- newValue: string
Returns any

remoteSourceDocumentQualifiedName

get (): string | null

Returns string | null

source

get (): EntitySource | null
set (newValue: EntitySource | null): any

In version 8.10.0: introduced

Returns EntitySource | null
In version 8.10.0: introduced

Parameters
- newValue: EntitySource | null
Returns any

unit

get (): ModelUnit<IAbstractModel>

Inherited from Element.unit

Overwrites AbstractUnit.unit

Returns ModelUnit<IAbstractModel>

validationRules

get (): IList<ValidationRule>

Returns IList<ValidationRule>

Methods

allProperties

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

Implementation of IEntity.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): this

Implementation of IEntity.asLoaded

Inherited from ModelUnit.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.
Returns this

deepCopy

deepCopy(targetModel: IAbstractModel): this

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns this

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): object

Inherited from Element.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns object
- copy: Element
- idMap: IMap<Structure>

delete

delete(): void

Inherited from AbstractElement.delete

Overwrites AbstractUnit.delete

Deletes this element from the model.

Returns void

detach

detach(): this

Inherited from Element.detach

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

Returns this

findElementById

findElementById(id: string): AbstractElement | null

Implementation of IEntity.findElementById

Inherited from AbstractElement.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

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

Inherited from ModelUnit.load
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: this): void
    - Parameters
      - elem: this
      Returns void
- Optional forceRefresh: undefined | false | true
Returns void
Implementation of IEntity.load

Inherited from ModelUnit.load

Parameters
- Optional forceRefresh: undefined | false | true
Returns Promise<this>

loadedProperties

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

Implementation of IEntity.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IEntity.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of IEntity.toJSON

Inherited from AbstractUnit.toJSON

Returns IStructureJSON

traverse

traverse(visit: function): void

Inherited from AbstractUnit.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

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

Inherited from AbstractUnit.traverseFind

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

traversePublicParts

traversePublicParts(visit: function): void

Inherited from AbstractUnit.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): Entity

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
- model: IModel
Returns Entity

Static createIn

createIn(container: DomainModel): Entity

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
- container: DomainModel
Returns Entity

Generated using TypeDoc