# SelectionManager

class `Selection.``SelectionManager`()

  This class provides the main interface into the selection functionality of the viewer. The class manages a list of selection items that are optionally highlighted as the user selects objects in the scene.

  ## Index

  Accessors

  - `viewer`

  Methods

  - `add`
  - `advanceIncrementalSelection`
  - `beginConvexPolyhedronSelection`
  - `beginRayDrillSelection`
  - `beginScreenSelectByArea`
  - `beginSphereSelection`
  - `clear`
  - `contains`
  - `containsParent`
  - `each`
  - `endIncrementalSelection`
  - `exportSelectionData`
  - `getFirst`
  - `getHighlightFaceElementSelection`
  - `getHighlightLineElementSelection`
  - `getHighlightNodeSelection`
  - `getHighlightPointElementSelection`
  - `getIgnoreEntityWhenTogglingChildSelection`
  - `getLast`
  - `getNodeElementSelectionColor`
  - `getNodeElementSelectionHighlightMode`
  - `getNodeElementSelectionOutlineColor`
  - `getNodeSelectionColor`
  - `getNodeSelectionHighlightMode`
  - `getNodeSelectionOutlineColor`
  - `getPickTolerance`
  - `getPruneSelectionDescendants`
  - `getResult`
  - `getResults`
  - `getSelectedLayers`
  - `getSelectedTypes`
  - `getSelectionFilter`
  - `getSelectParentIfSelected`
  - `getSingleEntityToggleModeEnabled`
  - `getSuppressImplicitRemovalCallback`
  - `isNodeSelected`
  - `isSelected`
  - `loadSelectionData`
  - `remove`
  - `selectAllFromPoint`
  - `selectAllFromRay`
  - `selectFromPoint`
  - `selectFromRay`
  - `selectLayer`
  - `selectNode`
  - `selectType`
  - `set`
  - `setHighlightFaceElementSelection`
  - `setHighlightLineElementSelection`
  - `setHighlightNodeSelection`
  - `setHighlightPointElementSelection`
  - `setIgnoreEntityWhenTogglingChildSelection`
  - `setNodeElementSelectionColor`
  - `setNodeElementSelectionHighlightMode`
  - `setNodeElementSelectionOutlineColor`
  - `setNodeSelectionColor`
  - `setNodeSelectionHighlightMode`
  - `setNodeSelectionOutlineColor`
  - `setPickTolerance`
  - `setPruneSelectionDescendants`
  - `setSelectionFilter`
  - `setSelectParentIfSelected`
  - `setSingleEntityToggleModeEnabled`
  - `setSuppressImplicitRemovalCallback`
  - `size`
  - `toggle`

## Accessors

`Selection.SelectionManager.``viewer`()
  get viewer(): `IWebViewer`

  Returns: `IWebViewer`

## Methods

`Selection.SelectionManager.``add`()
  add(itemOrItems: (None | `NodeSelectionItem` | `NodeSelectionItem`[]), suppressCallback: boolean?): void

  Manually adds an item or array of items to the selection set. Triggers a selection event.

  Parameters

  > itemOrItems: (None | `NodeSelectionItem` | `NodeSelectionItem`[])

  > > A selectionItem or selectionItem array that will be added to the current selection set.

  > suppressCallback: boolean = false

  > > Optional boolean param to suppress the selectionArray callbacks calls to this generate.

  Returns: void

`Selection.SelectionManager.``advanceIncrementalSelection`()
  advanceIncrementalSelection(handle: `IncrementalSelectionId`, predicate: (None | (item: `NodeSelectionItem`) => Promise)?): Promise

  Adds the next batch of instances selected by the supplied selection context to the selection set.

  Parameters

  > handle: `IncrementalSelectionId`

  > > The handle to an active area selection context.

  > predicate: (None | (item: `NodeSelectionItem`) => Promise) = null

  > > An optional function that returns `true` if a given [[NodeSelectionItem]] should be added to the selection set. If `false` is returned, the item will not be added.

  Returns: Promise

  > `true` if there are possibly more items to select and `false` if not.

`Selection.SelectionManager.``beginConvexPolyhedronSelection`()
  beginConvexPolyhedronSelection(volumePlanes: `Plane`[], heuristicOrigin: `Point3`, config: `IncrementalPickConfig`): Promise

  Creates a new and active selection context for the provided selection volume. The selection volume is a convex polyhedron defined by the bounded intersection of its half-spaces.

  Parameters

  > volumePlanes: `Plane`[]

  > > The planes used to define volume. A point p is inside the volume if and only if (plane.determineSide(p) == true) for all supplied planes.

  > heuristicOrigin: `Point3`

  > > A point used to compute distances against for ordering returned results. This is typically (but not necessarily) the center of the volume.

  > config: `IncrementalPickConfig`

  > > The configuration object used for this selection operation.

  Returns: Promise

  > The handle for the selection context.

`Selection.SelectionManager.``beginRayDrillSelection`()
  beginRayDrillSelection(rayCssOrigin: `Point2`, rayCssBoxRadius: number, config: `IncrementalPickConfig`, view: `IView`?): Promise

  Creates a new and active selection context for the provided selection ray. The ray is created at the supplied ray origin and is cast into the scene. Faces are selected if they lie along the ray. Lines and points are selected if they lie within the ray’s box radius.

  Note: Somewhat confusingly ray drill selection is actually a selection by volume. The provided ray origin and radius are used to create a frustum to preform the selection. This has some consequences. For example, the `SelectionResult`s returned by advancing a ray drill selection will not have selection positions, since they were not selected at a single point.

  Parameters

  > rayCssOrigin: `Point2`

  > > The coordinate in css pixel space for the selection ray’s origin.

  > rayCssBoxRadius: number

  > > The radius around the ray in css pixel space used for line and point selection proximity.

  > config: `IncrementalPickConfig`

  > > The configuration object used for this selection operation.

  > view: `IView` = …

  > > The view to use when projecting the point into the scene.

  Returns: Promise

  > The handle for the selection context.

`Selection.SelectionManager.``beginScreenSelectByArea`()
  beginScreenSelectByArea(areaCssMin: `Point2`, areaCssMax: `Point2`, config: `IncrementalPickConfig`, view: `IView`?): Promise

  Creates a new and active selection context for the provided selection window.

  Parameters

  > areaCssMin: `Point2`

  > > The minimum coordinate in css pixel space for the selection window.

  > areaCssMax: `Point2`

  > > The maximum coordinate in css pixel space for the selection window.

  > config: `IncrementalPickConfig`

  > > The configuration object used for this selection operation.

  > view: `IView` = …

  > > The view to use when projecting the point into the scene.

  Returns: Promise

  > The handle for the selection context.

`Selection.SelectionManager.``beginSphereSelection`()
  beginSphereSelection(sphereCenter: `Point3`, sphereRadius: number, config: `IncrementalPickConfig`): Promise

  Creates a new and active selection context for the provided selection sphere.

  Parameters

  > sphereCenter: `Point3`

  > > The center of the selection sphere.

  > sphereRadius: number

  > > The radius of the selection sphere.

  > config: `IncrementalPickConfig`

  > > The configuration object used for this selection operation.

  Returns: Promise

  > The handle for the selection context.

`Selection.SelectionManager.``clear`()
  clear(triggerCallback: boolean?): void

  Removes all items from the selection set.

  Parameters

  > triggerCallback: boolean = true

  > > triggers a null selection callback when true.

  Returns: void

`Selection.SelectionManager.``contains`()
  contains(item: `SelectionItem`): boolean

  Parameters

  > item: `SelectionItem`

  Returns: boolean

`Selection.SelectionManager.``containsParent`()
  containsParent(item: `NodeSelectionItem`): (None | `NodeSelectionItem`)

  Checks if the parent of a selection item is in the selection set.

  Parameters

  > item: `NodeSelectionItem`

  Returns: (None | `NodeSelectionItem`)

  > parent selection item, or null if not found

`Selection.SelectionManager.``each`()
  each(func: (s: `NodeSelectionItem`) => void): void

  Iterates over all selection items. The function passed in will be called once for every selection item and will receive the item as its parameter.

  Parameters

  > func: (s: `NodeSelectionItem`) => void

  > > a function to be called for every selection item.

  Returns: void

`Selection.SelectionManager.``endIncrementalSelection`()
  endIncrementalSelection(handle: `IncrementalSelectionId`): Promise

  Deactivates and destroys the provided selection context.

  Parameters

  > handle: `IncrementalSelectionId`

  > > The selection context to destroy.

  Returns: Promise

`Selection.SelectionManager.``exportSelectionData`()
  exportSelectionData(): object[]

  Exports selection objects so that they may be loaded back into the the system at a later time using loadSelectionData.

  Returns: object[]

  > exported selection data.

`Selection.SelectionManager.``getFirst`()
  getFirst(): (None | `NodeSelectionItem`)

  Gets the least recent selection item.

  Returns: (None | `NodeSelectionItem`)

  > the least recently selected item (if any).

`Selection.SelectionManager.``getHighlightFaceElementSelection`()
  getHighlightFaceElementSelection(): boolean

  Gets whether face elements will be highlighted on selection.

  Returns: boolean

  > boolean the current value for face element selection highlighting.

`Selection.SelectionManager.``getHighlightLineElementSelection`()
  getHighlightLineElementSelection(): boolean

  Gets whether line elements will be highlighted on selection.

  Returns: boolean

  > boolean the current value for line element selection highlighting.

`Selection.SelectionManager.``getHighlightNodeSelection`()
  getHighlightNodeSelection(): boolean

  Gets whether nodes will be highlighted on selection.

  Returns: boolean

  > the current value for node selection highlighting.

`Selection.SelectionManager.``getHighlightPointElementSelection`()
  getHighlightPointElementSelection(): boolean

  Gets whether point elements will be highlighted on selection.

  Returns: boolean

  > boolean the current value for point element selection highlighting.

`Selection.SelectionManager.``getIgnoreEntityWhenTogglingChildSelection`()
  getIgnoreEntityWhenTogglingChildSelection(): boolean

  Gets whether ignore entity when toggling child selection mode is enabled. See also: [[setIgnoreEntityWhenTogglingChildSelection]]

  Returns: boolean

`Selection.SelectionManager.``getLast`()
  getLast(): (None | `NodeSelectionItem`)

  Gets the most recent selection item.

  Returns: (None | `NodeSelectionItem`)

  > the most recently selected item (if any).

`Selection.SelectionManager.``getNodeElementSelectionColor`()
  getNodeElementSelectionColor(): `Color`

  Gets the color to use for face and line selection.

  Returns: `Color`

  > the color used for face and line selection.

`Selection.SelectionManager.``getNodeElementSelectionHighlightMode`()
  getNodeElementSelectionHighlightMode(): `SelectionHighlightMode`

  Returns: `SelectionHighlightMode`

`Selection.SelectionManager.``getNodeElementSelectionOutlineColor`()
  getNodeElementSelectionOutlineColor(): `Color`

  Gets the color to use for outlining face and line selection.

  Returns: `Color`

  > color the color used for outlining face and line selection.

`Selection.SelectionManager.``getNodeSelectionColor`()
  getNodeSelectionColor(): `Color`

  Gets the color to be used when selecting nodes.

  Returns: `Color`

  > the color that is applied to a selected node.

`Selection.SelectionManager.``getNodeSelectionHighlightMode`()
  getNodeSelectionHighlightMode(): `SelectionHighlightMode`

  Gets the highlighting mode for selected nodes.

  Returns: `SelectionHighlightMode`

  > the current

`Selection.SelectionManager.``getNodeSelectionOutlineColor`()
  getNodeSelectionOutlineColor(): `Color`

  Gets the color to be used for outlining the node selection.

  Returns: `Color`

  > the color for node selection outline.

`Selection.SelectionManager.``getPickTolerance`()
  getPickTolerance(): number

  Gets the pick tolerance in pixels for line and point picking.

  The default value is 20.

  Returns: number

  > number Pick tolerance value in pixels

`Selection.SelectionManager.``getPruneSelectionDescendants`()
  getPruneSelectionDescendants(): boolean

  Gets whether descendant pruning is enabled. See also: [[setPruneSelectionDescendants]]

  Returns: boolean

`Selection.SelectionManager.``getResult`()
  getResult(index: number): (None | `NodeSelectionItem`)

  Gets a selection at the specified index. The first selected item will be at index 0.

  Parameters

  > index: number

  > > index of selection item to get

  Returns: (None | `NodeSelectionItem`)

  > the selection result at the given index.

`Selection.SelectionManager.``getResults`()
  getResults(): `NodeSelectionItem`[]

  Gets all current selection items.

  Returns: `NodeSelectionItem`[]

  > array of all selection items.

`Selection.SelectionManager.``getSelectedLayers`()
  getSelectedLayers(): string[]

  Gets all selected layers.

  Returns: string[]

`Selection.SelectionManager.``getSelectedTypes`()
  getSelectedTypes(): string[]

  Gets all selected IFC types.

  Returns: string[]

`Selection.SelectionManager.``getSelectionFilter`()
  getSelectionFilter(): (None | `SelectionFilter`)

  Returns: (None | `SelectionFilter`)

  > [[SelectionFilter]] function or null if none is set.

`Selection.SelectionManager.``getSelectParentIfSelected`()
  getSelectParentIfSelected(): boolean

  Gets whether automatic parent selection is enabled. See also: [[setSelectParentIfSelected]]

  Returns: boolean

`Selection.SelectionManager.``getSingleEntityToggleModeEnabled`()
  getSingleEntityToggleModeEnabled(): boolean

  Gets whether single entity toggle mode is enabled. See also: [[setSingleEntityToggleModeEnabled]]

  Returns: boolean

`Selection.SelectionManager.``getSuppressImplicitRemovalCallback`()
  getSuppressImplicitRemovalCallback(): boolean

  Gets whether implicit removal callbacks are being suppressed See also: [[setSuppressImplicitRemovalCallback]]

  Returns: boolean

`Selection.SelectionManager.``isNodeSelected`()
  isNodeSelected(nodeId: number): boolean

  Checks whether a node, or its parents, appear in the selection set or not. Note: for the purposes of this function element selections on a node are considered the same as node selection.

  Parameters

  > nodeId: number

  > > Node to check for

  Returns: boolean

  > `true` if the node or its parents appear in the selection set. `false` otherwise

`Selection.SelectionManager.``isSelected`()
  isSelected(item: `SelectionItem`): boolean

  Parameters

  > item: `SelectionItem`

  Returns: boolean

`Selection.SelectionManager.``loadSelectionData`()
  loadSelectionData(datas: (string | object[])): void

  Loads serialized selection items exported using [[exportSelectionData]] back into the [[SelectionManager]]. The current selection will be cleared. A selection event will be triggered for each loaded item. This method should not be called before the [[CallbackMap.modelStructureReady]] callback has been triggered.

  Parameters

  > datas: (string | object[])

  Returns: void

`Selection.SelectionManager.``remove`()
  remove(itemOrItems: (`NodeSelectionItem` | `NodeSelectionItem`[]), suppressCallback: boolean?): void

  Manually removes an item or an array of items from the selection set. Triggers a selection event.

  Parameters

  > itemOrItems: (`NodeSelectionItem` | `NodeSelectionItem`[])

  > > A selectionItem or an array of selection items that will be removed from the current selection set.

  > suppressCallback: boolean = false

  > > Optional boolean param to suppress the selectionArray callbacks calls to this generate.

  Returns: void

`Selection.SelectionManager.``selectAllFromPoint`()
  selectAllFromPoint(point: `Point2`, config: `PickConfig`, selectionMode: `SelectionMode`?, view: `IView`?): Promise

  Performs a selection operation from the given position on the canvas. All candidate entities are selected. This method triggers a selection event.

  Parameters

  > point: `Point2`

  > > The canvas position to select from.

  > config: `PickConfig`

  > > The configuration object used for this picking operation.

  > selectionMode: `SelectionMode` = SelectionMode.Set

  > > The mode to use for this selection.

  > view: `IView` = …

  > > The view to use when projecting the point into the scene.

  Returns: Promise

  > Promise that resolves when this operation has completed.

`Selection.SelectionManager.``selectAllFromRay`()
  selectAllFromRay(ray: `Ray`, config: `PickConfig`, selectionMode: `SelectionMode`?, view: `IView`?): Promise

  Performs a selection operation from the given world-space ray. All candidate entities are selected. This method triggers a selection event.

  Parameters

  > ray: `Ray`

  > > The world-space ray to perform the selection with.

  > config: `PickConfig`

  > > The configuration object used for this picking operation.

  > selectionMode: `SelectionMode` = SelectionMode.Set

  > > The mode to use for this selection.

  > view: `IView` = …

  > > The view to use when projecting the point into the scene.

  Returns: Promise

  > Promise that resolves when this operation has completed.

`Selection.SelectionManager.``selectFromPoint`()
  selectFromPoint(point: `Point2`, config: `PickConfig`, selectionMode: `SelectionMode`?, view: `IView`?): Promise

  Performs a selection operation from the given position on the canvas. The best candidate entity is selected. This method triggers a selection event.

  Parameters

  > point: `Point2`

  > > The canvas position to select from.

  > config: `PickConfig`

  > > The configuration object used for this picking operation.

  > selectionMode: `SelectionMode` = SelectionMode.Set

  > > The mode to use for this selection.

  > view: `IView` = …

  > > The view to use when projecting the point into the scene.

  Returns: Promise

  > Promise that resolves when this operation has completed.

`Selection.SelectionManager.``selectFromRay`()
  selectFromRay(ray: `Ray`, config: `PickConfig`, selectionMode: `SelectionMode`?, view: `IView`?): Promise

  Performs a selection operation from the given world-space ray. The best candidate entity is selected. This method triggers a selection event.

  Parameters

  > ray: `Ray`

  > > The world-space ray to perform the selection with.

  > config: `PickConfig`

  > > The configuration object used for this picking operation.

  > selectionMode: `SelectionMode` = SelectionMode.Set

  > > The mode to use for this selection.

  > view: `IView` = …

  > > The view to use when projecting the point into the scene.

  Returns: Promise

  > Promise that resolves when this operation has completed.

`Selection.SelectionManager.``selectLayer`()
  selectLayer(layerName: string, selectionMode: `SelectionMode`): void

  Adds all items in a layer to the selection set.

  Parameters

  > layerName: string

  > selectionMode: `SelectionMode`

  Returns: void

`Selection.SelectionManager.``selectNode`()
  selectNode(nodeId: (None | number), selectionMode: `SelectionMode`?): `SelectionType`

  Selects a node with the given Id.

  Parameters

  > nodeId: (None | number)

  > > nodeId of the node to select. Pass null to clear the selection.

  > selectionMode: `SelectionMode` = SelectionMode.Set

  Returns: `SelectionType`

  > the selection type of this operation.

`Selection.SelectionManager.``selectType`()
  selectType(genericType: string, selectionMode: `SelectionMode`): void

  Adds all items with an IFC type to the selection set.

  Parameters

  > genericType: string

  > selectionMode: `SelectionMode`

  Returns: void

`Selection.SelectionManager.``set`()
  set(selection: (None | `NodeSelectionItem`)): void

  Manually removes all currently selected items (if any) from the selection set and adds the supplied item. Triggers a selection event.

  Parameters

  > selection: (None | `NodeSelectionItem`)

  Returns: void

`Selection.SelectionManager.``setHighlightFaceElementSelection`()
  setHighlightFaceElementSelection(highlightFaceElementSelection: boolean): Promise

  Sets whether face elements should be highlighted when a selection occurs. By default the system will automatically highlight face elements associated with a selection item.

  Parameters

  > highlightFaceElementSelection: boolean

  > > value indicating whether selected face elements should be highlighted.

  Returns: Promise

`Selection.SelectionManager.``setHighlightLineElementSelection`()
  setHighlightLineElementSelection(highlightLineElementSelection: boolean): Promise

  Sets whether line elements should be highlighted when a selection occurs. By default the system will automatically highlight line elements associated with a selection item.

  Parameters

  > highlightLineElementSelection: boolean

  > > value indicating whether selected line elements should be highlighted.

  Returns: Promise

`Selection.SelectionManager.``setHighlightNodeSelection`()
  setHighlightNodeSelection(highlightSelection: boolean): Promise

  Sets whether nodes should be highlighted when a selection occurs. By default, the system will automatically highlight the node associated with a selection item.

  Parameters

  > highlightSelection: boolean

  Returns: Promise

`Selection.SelectionManager.``setHighlightPointElementSelection`()
  setHighlightPointElementSelection(highlightPointElementSelection: boolean): Promise

  Sets whether point elements should be highlighted when a selection occurs. By default the system will automatically highlight point elements associated with a selection item.

  Parameters

  > highlightPointElementSelection: boolean

  > > value indicating whether selected point elements should be highlighted.

  Returns: Promise

`Selection.SelectionManager.``setIgnoreEntityWhenTogglingChildSelection`()
  setIgnoreEntityWhenTogglingChildSelection(strictMode: boolean): void

  Enables / disables ignore entity when toggling child selection mode.

  When enabled, a [[NodeSelectionItem]] that has a selected ancestor may only be toggled if it does not contain an entity selection. A selection item without an entity selection is usually generated from selecting a node via a model tree control. A selection item containing an entity selection is usually generated as a result of a viewport picking operation.

  This behavior is enabled by default. See Also: [[toggle]]

  Parameters

  > strictMode: boolean

  Returns: void

`Selection.SelectionManager.``setNodeElementSelectionColor`()
  setNodeElementSelectionColor(color: `Color`): Promise

  Sets the color to use for node element selection. This method should not be called before the sceneReady callback has been triggered.

  Parameters

  > color: `Color`

  > > the color to apply to selected node elements.

  Returns: Promise

`Selection.SelectionManager.``setNodeElementSelectionHighlightMode`()
  setNodeElementSelectionHighlightMode(highlightMode: `SelectionHighlightMode`): Promise

  Sets the highlighting mode for selected node elements. The default behavior is to highlight the node element and render an overlay outline. This method should not be called before the sceneReady callback has been triggered.

  Parameters

  > highlightMode: `SelectionHighlightMode`

  > > the highlighting mode that will be applied to selected nodes.

  Returns: Promise

`Selection.SelectionManager.``setNodeElementSelectionOutlineColor`()
  setNodeElementSelectionOutlineColor(color: `Color`): Promise

  Gets the color to use for outlining node element selection. This method should not be called before the sceneReady callback has been triggered.

  Parameters

  > color: `Color`

  > > the color used for outlining face and line selection.

  Returns: Promise

`Selection.SelectionManager.``setNodeSelectionColor`()
  setNodeSelectionColor(color: `Color`): Promise

  Sets the color to be used when selecting nodes. This method should not be called before the sceneReady callback has been triggered.

  Parameters

  > color: `Color`

  > > the color to apply to the selected node.

  Returns: Promise

`Selection.SelectionManager.``setNodeSelectionHighlightMode`()
  setNodeSelectionHighlightMode(highlightMode: `SelectionHighlightMode`): Promise

  Sets the highlighting mode for selected nodes. The default behavior is to highlight the node and render an overlay outline. This method should not be called before the sceneReady callback has been triggered.

  Parameters

  > highlightMode: `SelectionHighlightMode`

  > > the highlighting mode that will be applied to selected nodes.

  Returns: Promise

`Selection.SelectionManager.``setNodeSelectionOutlineColor`()
  setNodeSelectionOutlineColor(color: `Color`): Promise

  Sets color for the node selection outline. This method should not be called before the sceneReady callback has been triggered.

  Parameters

  > color: `Color`

  > > the color to apply to the node selection outline.

  Returns: Promise

`Selection.SelectionManager.``setPickTolerance`()
  setPickTolerance(tolerance: number): void

  Sets the pick tolerance in pixels for line and point picking. If a line or point is within this pixel tolerance of the click point, it will be prioritized over the face at the click position.

  The default value is 20.

  Parameters

  > tolerance: number

  Returns: void

`Selection.SelectionManager.``setPruneSelectionDescendants`()
  setPruneSelectionDescendants(pruneSelectionDescendants: boolean): void

  Enables / disables descendant pruning and clears the current selection set. When enabled, a parent and child will not be present in the same selection set. This behavior is enabled by default.

  Parameters

  > pruneSelectionDescendants: boolean

  Returns: void

`Selection.SelectionManager.``setSelectionFilter`()
  setSelectionFilter(selectionFilter: (None | `SelectionFilter`)): void

  This allows manipulating the selected NodeId. To reset the filter, set it to null.

  Parameters

  > selectionFilter: (None | `SelectionFilter`)

  > > function that manipulates the selected NodeId.

  Returns: void

`Selection.SelectionManager.``setSelectParentIfSelected`()
  setSelectParentIfSelected(selectParent: boolean): void

  Enables / disables automatic parent selection. When enabled, if a selected part is selected again, its parent will be selected. This behavior is enabled by default.

  Parameters

  > selectParent: boolean

  Returns: void

`Selection.SelectionManager.``setSingleEntityToggleModeEnabled`()
  setSingleEntityToggleModeEnabled(enabled: boolean): void

  Enables / disables single entity toggle mode.

  When enabled, limits the selection set to containing only one entity selection for each node id. Toggling with an entity selection that has the same node id as a [[NodeSelectionItem]] already in the selection set will remove that item from the selection set.

  This behavior is disabled by default. See Also: [[toggle]]

  Parameters

  > enabled: boolean

  Returns: void

`Selection.SelectionManager.``setSuppressImplicitRemovalCallback`()
  setSuppressImplicitRemovalCallback(suppress: boolean): void

  Sets whether to generate selectionArray callbacks with implicitly removed nodes.

  For example, consider the case where you have a parent node that has a multiple child nodes. Normally, if the parent begins selected and then a child is removed from the selection set there will be two selectionArray callbacks generated. The first will for the removal of the parent node. The second wil be for the addition of all of it’s children except the one that was initially removed.

  When this behavior is enabled only a single selectionArray callback will be generated for the child node that was removed.

  This behavior is disabled by default.

  Parameters

  > suppress: boolean

  Returns: void

`Selection.SelectionManager.``size`()
  size(): number

  Gets the number of selection items.

  Returns: number

  > the number of selected items.

`Selection.SelectionManager.``toggle`()
  toggle(item: `NodeSelectionItem`): void

  Manually adds or removes an item from the selection set. Triggers a selection event.

  Parameters

  > item: `NodeSelectionItem`

  Returns: void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...