API Reference › core-backend› Models › SpatialModel

SpatialModel Class

A container for persisting 3d geometric elements that are spatially located.

Extends

Extended by

Methods

Name Description
constructor(props: GeometricModel3dProps, iModel: IModelDb): SpatialModel Protected    

Inherited methods

Name Inherited from Description
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Inherited GeometricModel3d Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void Inherited GeometricModel3d Delete this Model from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void Inherited GeometricModel3d Call a function for each property of this Entity.
getJsonProperty(name: string): any Inherited GeometricModel3d  
getReferenceIds(): EntityReferenceSet Inherited GeometricModel3d Get the set of this entity's entity references, EntityReferenceSet.
getUserProperties(namespace: string): any Inherited GeometricModel3d Get a set of JSON user properties by namespace
insert(): string Inherited GeometricModel3d Insert this Model in the iModel
queryExtents(): Range3d Inherited GeometricModel3d Query for the union of the extents of the elements contained by this model.
queryRange(): Promise<Range3d> Inherited GeometricModel3d Query for the union of the extents of all elements contained within this model.
removeUserProperties(nameSpace: string): void Inherited GeometricModel3d Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void Inherited GeometricModel3d  
setUserProperties(nameSpace: string, value: any): void Inherited GeometricModel3d Change a set of user JSON properties of this Element by namespace.
toJSON(): GeometricModel3dProps Inherited GeometricModel3d Obtain the JSON representation of this Entity.
update(): void Inherited GeometricModel3d Update this Model in the iModel.
is(otherClass: ): boolean Static Inherited GeometricModel3d return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnModelIdArg): void Protected Static Inherited GeometricModel3d Called before a Model is deleted.
onDeleted(_arg: OnModelIdArg): void Protected Static Inherited GeometricModel3d Called after a Model was deleted.
onDeletedElement(_arg: OnElementInModelIdArg): void Protected Static Inherited GeometricModel3d Called after an Element in an instance of a Model of this class has been deleted.
onDeleteElement(_arg: OnElementInModelIdArg): void Protected Static Inherited GeometricModel3d Called when an Element in an instance of a Model of this class is about to be deleted.
onInsert(arg: OnModelPropsArg): void Protected Static Inherited GeometricModel3d Called before a new Model is inserted.
onInserted(_arg: OnModelIdArg): void Protected Static Inherited GeometricModel3d Called after a new Model is inserted.
onInsertedElement(_arg: OnElementInModelIdArg): void Protected Static Inherited GeometricModel3d Called after an Element has been inserted into an instance of a Model of this class.
onInsertElement(_arg: OnElementInModelPropsArg): void Protected Static Inherited GeometricModel3d Called before a prospective Element is to be inserted into an instance of a Model of this class.
onUpdate(arg: OnModelPropsArg): void Protected Static Inherited GeometricModel3d Called before a Model is updated.
onUpdated(_arg: OnModelIdArg): void Protected Static Inherited GeometricModel3d Called after a Model is updated.
onUpdatedElement(_arg: OnElementInModelIdArg): void Protected Static Inherited GeometricModel3d Called after an Element in an instance of a Model of this class has been updated.
onUpdateElement(_arg: OnElementInModelPropsArg): void Protected Static Inherited GeometricModel3d Called when an Element in an instance of a Model of this class is about to be updated.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  

Inherited properties

Name Type Inherited from Description
classFullName Accessor Inherited ReadOnly string GeometricModel3d Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string GeometricModel3d Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string GeometricModel3d The name of the BIS class associated with this class.
geometryGuid Inherited string | undefined GeometricModel3d  
id Inherited string GeometricModel3d The Id of this Entity.
iModel Inherited IModelDb GeometricModel3d The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" GeometricModel3d An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isNotSpatiallyLocated Readonly Inherited boolean GeometricModel3d If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index.
isPlanProjection Readonly Inherited boolean GeometricModel3d If true, then the elements in this GeometricModel3d are expected to be in an XY plane.
isPrivate Inherited boolean GeometricModel3d  
isSpatiallyLocated Accessor Inherited ReadOnly boolean GeometricModel3d If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index.
isTemplate Inherited boolean GeometricModel3d  
jsonProperties Readonly Inherited [key: string]: any GeometricModel3d  
modeledElement Readonly Inherited RelatedElement GeometricModel3d  
name Readonly Inherited string GeometricModel3d  
parentModel Readonly Inherited string GeometricModel3d  
schema Static Inherited GeometricModel3d The Schema that defines this class.
schemaName Accessor Inherited ReadOnly string GeometricModel3d The name of the BIS Schema that defines this class

Defined in

Last Updated: 24 June, 2025