ElementRefersToElements Class

A Relationship where one Element refers to another Element

Extends

Extended by

Implements

Methods

Name Description
create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T extends ElementRefersToElements Static Create an instance of the Relationship.  
insert<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String Static Insert a new instance of the Relationship.  

Inherited methods

Name Inherited from Description
buildConcurrencyControlRequest(opcode: DbOpcode): void Relationship Add a request for the locks that would be needed to carry out the specified operation.
delete(): void Relationship Delete this Relationship from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = false): void Entity Call a function for each property of this Entity.
insert(): Id64String Relationship Insert this Relationship into the iModel.
update(): void Relationship Update this Relationship in the iModel.
getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T extends Relationship Static Relationship  
onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void Static Relationship  
onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void Static Relationship  
onValidateOutput(_props: RelationshipProps, _iModel: IModelDb): void Static Relationship  

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string Entity The name of the BIS class associated with this class.
id Id64String Entity The Id of this Entity.
iModel IModelDb Entity The IModelDb that contains this Entity
schema Static undefined Entity The Schema that defines this class.
schemaName Accessor ReadOnly string Entity The name of the BIS Schema that defines this class
sourceId Id64String Relationship  
targetId Id64String Relationship  

Defined in

Last Updated: 13 June, 2024