HiliteSet Class
A set of hilited elements for an IModelConnection, by element id. Hilited elements are displayed with a customizable hilite effect within a Viewport. The set exposes 3 types of elements in 3 separate collections: geometric elements, subcategories, and geometric models.
note Typically, elements are hilited by virtue of their presence in the IModelConnection's SelectionSet. The HiliteSet allows additional elements to be displayed with the hilite effect without adding them to the SelectionSet. If you add elements to the HiliteSet directly, you are also responsible for removing them as appropriate.
note Support for subcategories and geometric models in the HiliteSet is currently beta
.
see IModelConnection.hilited for the HiliteSet associated with an iModel.
see Hilite.Settings for customization of the hilite effect.
Methods
Name | Description | |
---|---|---|
clear(): void | Remove all elements from the hilited set. | |
setHilite(arg: Id64Arg, onOff: boolean): void | Toggle the hilited state of one or more elements. |
Properties
Name | Type | Description | |
---|---|---|---|
elements Accessor ReadOnly | Uint32Set | The set of hilited elements. | |
iModel | IModelConnection | ||
isEmpty Accessor ReadOnly | boolean | Returns true if nothing is hilited. | |
models Readonly | Uint32Set | The set of hilited GeometricModelStates. | Beta |
subcategories Readonly | Uint32Set | The set of hilited subcategories. | Beta |
wantSyncWithSelectionSet Accessor | boolean | Control whether the hilited elements will be synchronized with the contents of the SelectionSet. |
Defined in
- core/frontend/src/SelectionSet.ts Line 176
Last Updated: 11 June, 2024