ModelState Class

Represents the front-end state of a Model.


Extended by



Name Description
constructor(props: ModelProps, iModel: IModelConnection, state?: ModelState): ModelState    
toJSON(): ModelProps Add all custom-handled properties of a Model to a json object.  

Inherited methods

Name Inherited from Description
clone(iModel?: IModelConnection): this EntityState Make an independent copy of this EntityState
equals(other: this): boolean EntityState Return true if this EntityState is equal to another one.


Name Type Description
asGeometricModel Accessor ReadOnly GeometricModelState | undefined Attempts to cast this model to a geometric model.  
asGeometricModel2d Accessor ReadOnly GeometricModel2dState | undefined Attempts to cast this model to a 2d geometric model.  
asGeometricModel3d Accessor ReadOnly GeometricModel3dState | undefined Attempts to cast this model to a 3d geometric model.  
asSpatialModel Accessor ReadOnly SpatialModelState | undefined Attempts to cast this model to a spatial model.  
isGeometricModel Accessor ReadOnly boolean Determine whether this is a GeometricModel  
isPrivate boolean    
isTemplate boolean    
modeledElement RelatedElement    
name string    
parentModel Id64String    

Inherited properties

Name Type Inherited from Description
classFullName Accessor StaticReadOnly string EntityState Get full BIS class name of this Entity in the form "SchemaName:ClassName".
classFullName string EntityState The full class name in the form "schema:class".
className Accessor ReadOnly string EntityState The name of the BIS class associated with this class.
id Id64String EntityState The Id of this Entity.
iModel IModelConnection EntityState The iModel from which this Entity was loaded
jsonProperties [key: string]: any EntityState Optional json properties of this Entity.
schemaName Accessor StaticReadOnly string EntityState The name of the BIS schema for this class.

Defined in

Last Updated: 05 June, 2020