ModelState Class

Represents the front-end state of a Model.

Extends

• EntityState

Extended by

• GeometricModelState

Implements

• ModelProps

Methods

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 Inherited	EntityState	Make an independent copy of this EntityState
equals(other: this): boolean Inherited	EntityState	Return true if this EntityState is equal to another one.

Properties

Name	Type	Description
asGeometricModel Accessor ReadOnly	undefined | GeometricModelState	Attempts to cast this model to a geometric model.
asGeometricModel2d Accessor ReadOnly	undefined | GeometricModel2dState	Attempts to cast this model to a 2d geometric model.
asGeometricModel3d Accessor ReadOnly	undefined | GeometricModel3dState	Attempts to cast this model to a 3d geometric model.
asSpatialModel Accessor ReadOnly	undefined | SpatialModelState	Attempts to cast this model to a spatial model.
className Accessor Static ReadOnly	string	The name of the BIS class associated with this class.
isGeometricModel Accessor ReadOnly	boolean	Determine whether this is a GeometricModel
isPrivate Readonly	boolean
isTemplate Readonly	boolean
modeledElement Readonly	RelatedElement
name Readonly	string
parentModel	string

Inherited properties

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

Defined in

• 92/itwinjs-core/core/frontend/src/ModelState.ts Line 26