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

LinearlyReferencedAtLocation Class @beta

Concrete multi-aspect class carrying 'at' linearly-referenced positions along a Linear-Element.

Extends

Methods

Name Description
constructor(props: LinearlyReferencedAtLocationAspectProps, iModel: IModelDb): LinearlyReferencedAtLocation    
create(iModel: IModelDb, locatedElementId: string, at: DistanceExpression, fromReferentId?: string): LinearlyReferencedAtLocation Static    
insert(iModel: IModelDb, locatedElementId: string, at: DistanceExpression, fromReferentId?: string): void Static    

Inherited methods

Name Inherited from Description
collectReferenceIds(_referenceIds: EntityReferenceSet): void Protected Inherited LinearlyReferencedLocation Collect the Ids of this entity's references at this level of the class hierarchy.
forEach(func: PropertyHandler, includeCustom?: boolean): void Inherited LinearlyReferencedLocation Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom?: boolean): void Inherited LinearlyReferencedLocation Call a function for each property of this Entity.
getMetaData(): Promise<EntityClass | RelationshipClass> Inherited LinearlyReferencedLocation Query metadata for this entity class from the iModel's schema.
getReferenceIds(): EntityReferenceSet Inherited LinearlyReferencedLocation Get the set of this entity's entity references, EntityReferenceSet.
toJSON(): ElementAspectProps Inherited LinearlyReferencedLocation Obtain the JSON representation of this Entity.
deserialize(props: DeserializeEntityArgs): EntityProps Static Inherited LinearlyReferencedLocation Converts an ECSqlRow of an Entity to an EntityProps.
is(otherClass: Entity): boolean Static Inherited LinearlyReferencedLocation return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnAspectIdArg): void Protected Static Inherited LinearlyReferencedLocation Called before an ElementAspect is deleted.
onDeleted(_arg: OnAspectIdArg): void Protected Static Inherited LinearlyReferencedLocation Called after an ElementAspect was deleted.
onInsert(arg: OnAspectPropsArg): void Protected Static Inherited LinearlyReferencedLocation Called before a new ElementAspect is inserted.
onInserted(_arg: OnAspectPropsArg): void Protected Static Inherited LinearlyReferencedLocation Called after a new ElementAspect was inserted.
onUpdate(arg: OnAspectPropsArg): void Protected Static Inherited LinearlyReferencedLocation Called before an ElementAspect is updated.
onUpdated(_arg: OnAspectPropsArg): void Protected Static Inherited LinearlyReferencedLocation Called after an ElementAspect was updated.
serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow Static Inherited LinearlyReferencedLocation Converts an EntityProps to an ECSqlRow.

Properties

Name Type Description
atPosition DistanceExpression    
fromReferent LinearlyReferencedAtPositionRefersToReferent | undefined    

Inherited properties

Name Type Inherited from Description
_customHandledProps Protected Static Readonly Inherited CustomHandledProperty[] LinearlyReferencedLocation List of properties that are need to be custom handled during deserialization and serialization.
_metadata Protected Inherited EntityClass | RelationshipClass LinearlyReferencedLocation Cached Metadata for the ECClass
classFullName Accessor Inherited ReadOnly string LinearlyReferencedLocation Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string LinearlyReferencedLocation Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string LinearlyReferencedLocation The name of the BIS class associated with this class.
element Inherited RelatedElement LinearlyReferencedLocation  
id Inherited string LinearlyReferencedLocation The Id of this Entity.
iModel Inherited IModelDb LinearlyReferencedLocation The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" LinearlyReferencedLocation An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
schema Static Inherited Schema LinearlyReferencedLocation The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey LinearlyReferencedLocation Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey LinearlyReferencedLocation Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string LinearlyReferencedLocation The name of the BIS Schema that defines this class

Defined in

Last Updated: 28 October, 2025