API Reference > imodeljs-backend > Models > PhysicalModel

PhysicalModel Class

A container for persisting physical elements that model physical space.

see PhysicalPartition

Extends

Implements

Methods

Name Description
insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: false | true): Id64String Static Insert a PhysicalPartition and a PhysicalModel that sub-models it.  

Inherited methods

Name Inherited from Description
buildConcurrencyControlRequest(opcode: DbOpcode): void Model Add a request for the locks that would be needed to carry out the specified operation.
delete(): void Model Delete this Model from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = false): void Entity Call a function for each property of this Entity.
getJsonProperty(name: string): any Model  
getUserProperties(namespace: string): any Model Get a set of JSON user properties by namespace
insert(): string Model Insert this Model in the iModel
queryExtents(): AxisAlignedBox3d GeometricModel Query for the union of the extents of the elements contained by this model.
removeUserProperties(nameSpace: string): void Model Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void Model  
setUserProperties(nameSpace: string, value: any): void Model Change a set of user JSON properties of this Element by namespace.
update(): void Model Update this Model in the iModel.
onDelete(props: ModelProps, iModel: IModelDb): void ProtectedStatic Model Called before a model is deleted.
onDeleted(_props: ModelProps, _iModel: IModelDb): void ProtectedStatic Model Called after a model is deleted.
onInsert(props: ModelProps, iModel: IModelDb): void ProtectedStatic Model Called before a new model is inserted.
onInserted(id: string, iModel: IModelDb): void ProtectedStatic Model Called after a new model is inserted.
onUpdate(props: ModelProps, iModel: IModelDb): void ProtectedStatic Model Called before a model is updated.
onUpdated(props: ModelProps, iModel: IModelDb): void ProtectedStatic Model Called after a model is updated.
populateRequest(req: ConcurrencyControl.Request, props: ModelProps, iModel: IModelDb, opcode: DbOpcode): void Static Model Disclose the codes and locks needed to perform the specified operation on this model

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.
geometryGuid undefined | GuidString GeometricModel  
id Id64String Entity The Id of this Entity.
iModel IModelDb Entity The IModelDb that contains this Entity
isNotSpatiallyLocated boolean GeometricModel3d If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index.
iSpatiallyLocated Accessor ReadOnly boolean GeometricModel3d If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index.
isPlanProjection boolean GeometricModel3d If true, then the elements in this GeometricModel3d are expected to be in an XY plane.
isPrivate boolean Model  
isTemplate boolean Model  
jsonProperties [key: string]: any Model  
modeledElement RelatedElement Model  
name string Model  
parentModel Id64String Model  
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: 13 June, 2024