API Reference › linear-referencing-backend› LinearReferencing › Referent

Referent Class

Referent-implementation turning any bis:SpatialElement not inherently Linearly-Referenced into a Referent for Linear-Referencing purposes.

Extends

Methods

Name Description
constructor(props: ReferentElementProps, iModel: IModelDb): Referent    
insertAt(iModel: IModelDb, linearElementId: string, atPosition: LinearlyReferencedAtLocationProps): string    
create(iModel: IModelDb, modelId: string, categoryId: string, referencedElementId: string): Referent Static    
insertAt(iModel: IModelDb, modelId: string, categoryId: string, linearElementId: string, atPosition: LinearlyReferencedAtLocationProps, referencedElementId: string): string Static    

Inherited methods

Name Inherited from Description
calculateRange3d(): Range3d ReferentElement  
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected ReferentElement Collect the Ids of this element's references at this level of the class hierarchy.
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected ReferentElement  
delete(): void ReferentElement Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom?: boolean): void ReferentElement Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData ReferentElement Get the class metadata for this element.
getDisplayLabel(): string ReferentElement Get a display label for this Element.
getJsonProperty(nameSpace: string): any ReferentElement Get a JSON property of this element, by namespace
getLinearElementId(): undefined | string ReferentElement  
getPlacementTransform(): Transform ReferentElement Get the Transform from the Placement of this GeometricElement
getPredecessorIds(): Id64Set ReferentElement Get the Ids of this element's references.
getReferenceIds(): EntityReferenceSet ReferentElement Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] ReferentElement Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any ReferentElement Get a set of JSON user properties by namespace
insert(): string ReferentElement Insert this Element into the iModel.
is2d(): this is GeometricElement2d ReferentElement Type guard for instanceof GeometricElement2d
is3d(): this is GeometricElement3d ReferentElement Type guard for instanceof GeometricElement3d
removeUserProperties(nameSpace: string): void ReferentElement Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void ReferentElement  
setUserProperties(nameSpace: string, value: any): void ReferentElement Change a set of user JSON properties of this Element by namespace.
toJSON(): GeometricElement3dProps ReferentElement  
update(): void ReferentElement Update this Element in the iModel.
is(otherClass: ): boolean Static ReferentElement return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static ReferentElement Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void Protected Static ReferentElement Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static ReferentElement Called when an existing element is about to be updated so that an instance of this class will become its new parent.
onChildAdded(_arg: OnChildElementIdArg): void Protected Static ReferentElement Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void Protected Static ReferentElement Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(_arg: OnChildElementIdArg): void Protected Static ReferentElement Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static ReferentElement Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
onChildDropped(_arg: OnChildElementIdArg): void Protected Static ReferentElement Called after an element with an instance of this class as its previous parent was updated to have a new parent.
onChildInsert(_arg: OnChildElementPropsArg): void Protected Static ReferentElement Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(_arg: OnChildElementIdArg): void Protected Static ReferentElement Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static ReferentElement Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(_arg: OnChildElementIdArg): void Protected Static ReferentElement Called after an element with an instance of this the class as its parent was updated.
onCloned(_context: IModelElementCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void Protected Static ReferentElement Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel.
onDelete(arg: OnElementIdArg): void Protected Static ReferentElement Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void Protected Static ReferentElement Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void Protected Static ReferentElement Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void Protected Static ReferentElement Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static ReferentElement Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void Protected Static ReferentElement Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void Protected Static ReferentElement Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void Protected Static ReferentElement Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void Protected Static ReferentElement Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void Protected Static ReferentElement Called after an Element was updated.

Inherited properties

Name Type Inherited from Description
category string ReferentElement The Id of the Category for this GeometricElement.
classFullName Accessor ReadOnly string ReferentElement Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static ReadOnly string ReferentElement Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string ReferentElement The name of the BIS class associated with this class.
code Code ReferentElement The Code for this element
elementGeometryBuilderParams ElementGeometryBuilderParams | undefined ReferentElement How to build the element's GeometryStream.
federationGuid string | undefined ReferentElement A FederationGuid assigned to this element by some other federated database
geom GeometryStreamProps | undefined ReferentElement The GeometryStream for this GeometricElement.
id string ReferentElement The Id of this Entity.
iModel IModelDb ReferentElement The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" ReferentElement An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
jsonProperties Readonly [key: string]: any ReferentElement Optional json properties of this element.
model Readonly string ReferentElement The ModelId of the Model containing this element
parent RelatedElement | undefined ReferentElement The parent element, if present, of this element.
placement Placement3d ReferentElement  
referencedElement IReferentReferencesElement | undefined ReferentElement  
requiredReferenceKeys Static Readonly ReferentElement  
schema Static ReferentElement The Schema that defines this class.
schemaName Accessor ReadOnly string ReferentElement The name of the BIS Schema that defines this class
typeDefinition TypeDefinition | undefined ReferentElement  
userLabel string | undefined ReferentElement A user-assigned label for this element.

Defined in

Last Updated: 13 May, 2024