API Reference › core-backend› Models › PhysicalModel

PhysicalModel Class @preview

A container for persisting physical elements that model physical space.

@see PhysicalPartition

Extends

Methods

Name Description
constructor(props: GeometricModel3dProps, iModel: IModelDb): PhysicalModel Protected    
insert(iModelDb: IModelDb, parentSubjectId: string, name: string, isPlanProjection?: boolean): string Static Insert a PhysicalPartition and a PhysicalModel that sub-models it.  

Inherited methods

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

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
_customHandledProps Protected Static Readonly Inherited CustomHandledProperty[] SpatialModel List of properties that are need to be custom handled during deserialization and serialization.
_metadata Protected Inherited EntityClass | RelationshipClass SpatialModel Cached Metadata for the ECClass
classFullName Accessor Inherited ReadOnly string SpatialModel Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string SpatialModel Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string SpatialModel The name of the BIS class associated with this class.
geometryGuid Inherited string | undefined SpatialModel  
id Inherited string SpatialModel The Id of this Entity.
iModel Inherited IModelDb SpatialModel The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" SpatialModel An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isNotSpatiallyLocated Readonly Inherited boolean SpatialModel 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 SpatialModel If true, then the elements in this GeometricModel3d are expected to be in an XY plane.
isPrivate Inherited boolean SpatialModel  
isSpatiallyLocated Accessor Inherited ReadOnly boolean SpatialModel If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index.
isTemplate Inherited boolean SpatialModel  
jsonProperties Readonly Inherited [key: string]: any SpatialModel  
modeledElement Readonly Inherited RelatedElement SpatialModel  
name Readonly Inherited string SpatialModel  
parentModel Readonly Inherited string | undefined SpatialModel  
schema Static Inherited Schema SpatialModel The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey SpatialModel Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey SpatialModel Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string SpatialModel The name of the BIS Schema that defines this class

Defined in

Last Updated: 24 October, 2025