SelectionSet

Classes for working with the set of selected elements. See the learning articles.

Classes

Name Description  
HiliteSet A set of hilited elements for an IModelConnection, by element id.  
SelectionSet A set of currently selected geometric elements, models and subcategories for an IModelConnection.  
SelectionTool Tool for picking a set of elements of interest, selected by the user.  

Enumerations

Name Description  
SelectionMethod The method for choosing elements with the SelectionTool  
SelectionMode The mode for choosing elements with the SelectionTool  
SelectionProcessing The processing method to use to update the current selection.  
SelectionSetEventType Identifies the type of changes made to the SelectionSet to produce a SelectionSetEvent.  

Interfaces

Name Description  
SelectableIds A collection of geometric element, model and subcategory ids that can be added to  
SelectAddEvent Passed to onChanged event listeners when ids are added to the selection set.  
SelectRemoveEvent Passed to onChanged event listeners when ids are removed from the selection set.  
SelectReplaceEvent Passed to onChanged event listeners when ids are simultaneously added to and removed from the selection set.  

Type Aliases

Name Description  
ModelSubCategoryHiliteMode Describes how the sets of hilited models and subcategories in a HiliteSet interact.  
SelectionSetEvent Payload sent to onChanged event listeners to describe how the contents of the set have changed.  

Last Updated: 12 December, 2024