ModelState Class
Represents the front-end state of a Model.
Extends
Extended by
Implements
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): ModelState | EntityState | Make an independent copy of this EntityState |
equals(other: ModelState): boolean | 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 StaticReadOnly | 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 StaticReadOnly | string | EntityState | Get full BIS class name of this Entity in the form "SchemaName:ClassName". |
classFullName Readonly | 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 Readonly | string | EntityState | The Id of this Entity. |
iModel Readonly | IModelConnection | EntityState | The iModel from which this Entity was loaded |
jsonProperties Readonly | { T } | EntityState | Optional json properties of this Entity. |
schemaName Accessor StaticReadOnly | string | EntityState | The name of the BIS schema for this class. |
Defined in
- core/frontend/src/ModelState.ts Line 26
Last Updated: 28 March, 2024
Found something wrong, missing, or unclear on this page?
Raise an issue in our repo.