API Reference › core-backend › ElementAspects › ElementAspect

ElementAspect Class

An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element. Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted. BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.

Extends

Extended by

Methods

Name Description
constructor(props: ElementAspectProps, iModel: IModelDb): ElementAspect Construct an aspect from its JSON representation and its containing iModel.  
toJSON(): ElementAspectProps Obtain the JSON representation of this Entity.  
onDelete(arg: OnAspectIdArg): void ProtectedStatic Called before an ElementAspect is deleted.  
onDeleted(_arg: OnAspectIdArg): void ProtectedStatic Called after an ElementAspect was deleted.  
onInsert(arg: OnAspectPropsArg): void ProtectedStatic Called before a new ElementAspect is inserted.  
onInserted(_arg: OnAspectPropsArg): void ProtectedStatic Called after a new ElementAspect was inserted.  
onUpdate(arg: OnAspectPropsArg): void ProtectedStatic Called before an ElementAspect is updated.  
onUpdated(_arg: OnAspectPropsArg): void ProtectedStatic Called after an ElementAspect was updated.  

Inherited methods

Name Inherited from Description
collectReferenceIds(_referenceIds: EntityReferenceSet): void Protected Entity Collect the Ids of this entity's references at this level of the class hierarchy.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Entity Call a function for each property of this Entity.
getReferenceIds(): EntityReferenceSet Entity Get the set of this entity's entity references, EntityReferenceSet.
is(otherClass: undefined): boolean Static Entity return whether this Entity class is a subclass of another Entity class

Properties

Name Type Description
element RelatedElement    

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 string Entity The Id of this Entity.
iModel IModelDb Entity The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" Entity An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
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

Defined in

Last Updated: 16 April, 2024