ElementRefersToElements Class
A Relationship where one Element refers to another Element
Extends
Extended by
- PhysicalElementFulfillsFunction
- DrawingGraphicRepresentsElement
- GraphicalElement3dRepresentsElement
- SynchronizationConfigProcessesSources
- ElementGroupsMembers
Methods
| Name | Description | |
|---|---|---|
| create<T extends ElementRefersToElements<T>>(iModel: IModelDb, sourceId: string, targetId: string): T Static | Create an instance of the Relationship. | |
| insert<T extends ElementRefersToElements<T>>(iModel: IModelDb, sourceId: string, targetId: string): string Static | Insert a new instance of the Relationship. |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| collectReferenceIds(referenceIds: Set<string>): void Protected | Relationship | Collect the Ids of this entity's references at this level of the class hierarchy. |
| delete(): void | Relationship | Delete this Relationship from the iModel. |
| forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void | Relationship | Call a function for each property of this Entity. |
| getReferenceIds(): Set<string> | Relationship | Get the Ids of this element's references. |
| insert(): string | Relationship | Insert this Relationship into the iModel. |
| update(): void | Relationship | Update this Relationship in the iModel. |
| getInstance<T extends Relationship<T>>(iModel: IModelDb, criteria: string | SourceAndTarget): T Static | Relationship | |
| is(otherClass: undefined): boolean Static | Relationship | return whether this Entity class is a subclass of another Entity class |
| onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void Static | Relationship | Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted. |
| onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void Static | Relationship | Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| classFullName Accessor ReadOnly | string | Relationship | Get the full BIS class name of this Entity in the form "schema:class". |
| classFullName Accessor StaticReadOnly | string | Relationship | Get the full BIS class name of this Entity in the form "schema:class" |
| className Accessor ReadOnly | string | Relationship | The name of the BIS class associated with this class. |
| id | string | Relationship | The Id of this Entity. |
| iModel | IModelDb | Relationship | The IModelDb that contains this Entity |
| isInstanceOfEntity Readonly | "true" | Relationship | An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types |
| schema Static | undefined | Relationship | The Schema that defines this class. |
| schemaName Accessor ReadOnly | string | Relationship | The name of the BIS Schema that defines this class |
| sourceId Readonly | string | Relationship | |
| targetId Readonly | string | Relationship |
Defined in
- backend/src/Relationship.ts Line 71
Last Updated: 30 November, 2023