API Reference > core-backend > Elements > SpatialElement

SpatialElement Class

An Element that occupies real world space. Its coordinates are in the project space of its iModel.

Extends

Extended by

Inherited methods

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

Inherited properties

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

Defined in

Last Updated: 20 June, 2023