API Reference > imodeljs-frontend > Views > ModelSelectorState

ModelSelectorState Class

The state of a ModelSelector. It holds a set of ids of GeometricModels for a SpatialViewState. It defines the set of ModelStates drawn within the view as a set of IDs.

Extends

Implements

Methods

Name Description
constructor(props: ModelSelectorProps, iModel: IModelConnection): ModelSelectorState    
addModels(arg: Id64Arg): void Add one or more models to this ModelSelectorState  
containsModel(modelId: Id64String): boolean Determine whether this ModelSelectorState includes the specified modelId  
dropModels(arg: Id64Arg): void Drop one or more models from this ModelSelectorState  
equalState(other: ModelSelectorState): boolean Determine if this model selector is logically equivalent to the specified model selector.  
has(id: string): boolean Determine whether this ModelSelectorState includes the specified modelId value  
load(): Promise<void> Make sure all models referenced by this ModelSelectorState are loaded.  
toJSON(): ModelSelectorProps    

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.

Properties

Name Type Description
models Set<string> The set of ModelIds of this ModelSelectorState  
name Accessor ReadOnly string The name of this ModelSelector  

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.
code Code ElementState The Code for this element
federationGuid undefined | GuidString ElementState A FederationGuid assigned to this element by some other federated database
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.
model Id64String ElementState The ModelId of the Model containing this element
parent undefined | RelatedElement ElementState The parent Element of this, or undefined if no parent.
schemaName Accessor StaticReadOnly string EntityState The name of the BIS schema for this class.
userLabel undefined | string ElementState A user-assigned label for this element.

Defined in

Last Updated: 13 June, 2024