@itwin/presentation-frontend 4.0.0-dev.21 → 4.0.0-dev.23

package/lib/cjs/presentation-frontend/selection/SelectionHandler.d.ts

@@ -1,104 +1,104 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-import { IDisposable } from "@itwin/core-bentley";
-import { IModelConnection } from "@itwin/core-frontend";
-import { Keys, KeySet } from "@itwin/presentation-common";
-import { ISelectionProvider } from "./ISelectionProvider";
-import { SelectionChangeEventArgs, SelectionChangesListener } from "./SelectionChangeEvent";
-import { SelectionManager } from "./SelectionManager";
-/**
- * Properties for creating a `SelectionHandler` instance.
- * @public
- */
-export interface SelectionHandlerProps {
-    /** SelectionManager used to store overall selection. */
-    manager: SelectionManager;
-    /** iModel connection the selection changes will be associated with. */
-    imodel: IModelConnection;
-    /**
-     * Name of the selection handler. This is an identifier of what caused the
-     * selection to change, set as `SelectionChangeEventArgs.source` when firing
-     * selection change events. `SelectionHandler.shouldHandle` uses `name` to filter
-     * events that it doesn't need to handle.
-     */
-    name: string;
-    /**
-     * ID of presentation ruleset used by the component using this handler. The ID is set as
-     * `SelectionChangeEventArgs.rulesetId` when making selection changes and event
-     * listeners can use or ignore this information.
-     */
-    rulesetId?: string;
-    /** Callback function called when selection changes. */
-    onSelect?: SelectionChangesListener;
-}
-/**
- * A class that handles selection changes and helps to change
- * internal the selection state.
- *
- * @public
- */
-export declare class SelectionHandler implements IDisposable {
-    private _inSelect;
-    private _disposables;
-    /** Selection manager used by this handler to manage selection */
-    readonly manager: SelectionManager;
-    /** Name that's used as `SelectionChangeEventArgs.source` when making selection changes */
-    name: string;
-    /** iModel whose selection is being handled */
-    imodel: IModelConnection;
-    /**
-     * Id of a ruleset selection changes will be associated with.
-     * @see `SelectionHandlerProps.rulesetId`
-     */
-    rulesetId?: string;
-    /** Callback function called when selection changes */
-    onSelect?: SelectionChangesListener;
-    /**
-     * Constructor.
-     */
-    constructor(props: SelectionHandlerProps);
-    /**
-     * Destructor. Must be called before disposing this object to make sure it cleans
-     * up correctly.
-     */
-    dispose(): void;
-    /**
-     * Called when the selection changes. Handles this callback by first checking whether
-     * the event should be handled at all (using the `shouldHandle` method) and then calling `onSelect`
-     */
-    protected onSelectionChanged: (evt: SelectionChangeEventArgs, provider: ISelectionProvider) => void;
-    /** Called to check whether the event should be handled by this handler */
-    protected shouldHandle(evt: SelectionChangeEventArgs): boolean;
-    /** Get selection levels for the imodel managed by this handler */
-    getSelectionLevels(): number[];
-    /**
-     * Get selection for the imodel managed by this handler.
-     * @param level Level of the selection to get. Defaults to 0.
-     */
-    getSelection(level?: number): Readonly<KeySet>;
-    /**
-     * Add to selection.
-     * @param keys The keys to add to selection.
-     * @param level Level of the selection.
-     */
-    addToSelection(keys: Keys, level?: number): void;
-    /**
-     * Remove from selection.
-     * @param keys The keys to remove from selection.
-     * @param level Level of the selection.
-     */
-    removeFromSelection(keys: Keys, level?: number): void;
-    /**
-     * Change selection.
-     * @param keys The keys indicating the new selection.
-     * @param level Level of the selection.
-     */
-    replaceSelection(keys: Keys, level?: number): void;
-    /**
-     * Clear selection.
-     * @param level Level of the selection.
-     */
-    clearSelection(level?: number): void;
-}
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { IDisposable } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+import { Keys, KeySet } from "@itwin/presentation-common";
+import { ISelectionProvider } from "./ISelectionProvider";
+import { SelectionChangeEventArgs, SelectionChangesListener } from "./SelectionChangeEvent";
+import { SelectionManager } from "./SelectionManager";
+/**
+ * Properties for creating a `SelectionHandler` instance.
+ * @public
+ */
+export interface SelectionHandlerProps {
+    /** SelectionManager used to store overall selection. */
+    manager: SelectionManager;
+    /** iModel connection the selection changes will be associated with. */
+    imodel: IModelConnection;
+    /**
+     * Name of the selection handler. This is an identifier of what caused the
+     * selection to change, set as `SelectionChangeEventArgs.source` when firing
+     * selection change events. `SelectionHandler.shouldHandle` uses `name` to filter
+     * events that it doesn't need to handle.
+     */
+    name: string;
+    /**
+     * ID of presentation ruleset used by the component using this handler. The ID is set as
+     * `SelectionChangeEventArgs.rulesetId` when making selection changes and event
+     * listeners can use or ignore this information.
+     */
+    rulesetId?: string;
+    /** Callback function called when selection changes. */
+    onSelect?: SelectionChangesListener;
+}
+/**
+ * A class that handles selection changes and helps to change
+ * internal the selection state.
+ *
+ * @public
+ */
+export declare class SelectionHandler implements IDisposable {
+    private _inSelect;
+    private _disposables;
+    /** Selection manager used by this handler to manage selection */
+    readonly manager: SelectionManager;
+    /** Name that's used as `SelectionChangeEventArgs.source` when making selection changes */
+    name: string;
+    /** iModel whose selection is being handled */
+    imodel: IModelConnection;
+    /**
+     * Id of a ruleset selection changes will be associated with.
+     * @see `SelectionHandlerProps.rulesetId`
+     */
+    rulesetId?: string;
+    /** Callback function called when selection changes */
+    onSelect?: SelectionChangesListener;
+    /**
+     * Constructor.
+     */
+    constructor(props: SelectionHandlerProps);
+    /**
+     * Destructor. Must be called before disposing this object to make sure it cleans
+     * up correctly.
+     */
+    dispose(): void;
+    /**
+     * Called when the selection changes. Handles this callback by first checking whether
+     * the event should be handled at all (using the `shouldHandle` method) and then calling `onSelect`
+     */
+    protected onSelectionChanged: (evt: SelectionChangeEventArgs, provider: ISelectionProvider) => void;
+    /** Called to check whether the event should be handled by this handler */
+    protected shouldHandle(evt: SelectionChangeEventArgs): boolean;
+    /** Get selection levels for the imodel managed by this handler */
+    getSelectionLevels(): number[];
+    /**
+     * Get selection for the imodel managed by this handler.
+     * @param level Level of the selection to get. Defaults to 0.
+     */
+    getSelection(level?: number): Readonly<KeySet>;
+    /**
+     * Add to selection.
+     * @param keys The keys to add to selection.
+     * @param level Level of the selection.
+     */
+    addToSelection(keys: Keys, level?: number): void;
+    /**
+     * Remove from selection.
+     * @param keys The keys to remove from selection.
+     * @param level Level of the selection.
+     */
+    removeFromSelection(keys: Keys, level?: number): void;
+    /**
+     * Change selection.
+     * @param keys The keys indicating the new selection.
+     * @param level Level of the selection.
+     */
+    replaceSelection(keys: Keys, level?: number): void;
+    /**
+     * Clear selection.
+     * @param level Level of the selection.
+     */
+    clearSelection(level?: number): void;
+}
 //# sourceMappingURL=SelectionHandler.d.ts.map

package/lib/cjs/presentation-frontend/selection/SelectionHandler.js

@@ -1,109 +1,109 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectionHandler = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-/**
- * A class that handles selection changes and helps to change
- * internal the selection state.
- *
- * @public
- */
-class SelectionHandler {
-    /**
-     * Constructor.
-     */
-    constructor(props) {
-        /**
-         * Called when the selection changes. Handles this callback by first checking whether
-         * the event should be handled at all (using the `shouldHandle` method) and then calling `onSelect`
-         */
-        // eslint-disable-next-line @typescript-eslint/naming-convention
-        this.onSelectionChanged = (evt, provider) => {
-            if (!this.onSelect || !this.shouldHandle(evt))
-                return;
-            this._inSelect = true;
-            this.onSelect(evt, provider);
-            this._inSelect = false;
-        };
-        this._inSelect = false;
-        this.manager = props.manager;
-        this._disposables = new core_bentley_1.DisposableList();
-        this.name = props.name;
-        this.rulesetId = props.rulesetId;
-        this.imodel = props.imodel;
-        this.onSelect = props.onSelect;
-        this._disposables.add(this.manager.selectionChange.addListener(this.onSelectionChanged));
-    }
-    /**
-     * Destructor. Must be called before disposing this object to make sure it cleans
-     * up correctly.
-     */
-    dispose() {
-        this._disposables.dispose();
-    }
-    /** Called to check whether the event should be handled by this handler */
-    shouldHandle(evt) {
-        if (this.name === evt.source)
-            return false;
-        return true;
-    }
-    /** Get selection levels for the imodel managed by this handler */
-    getSelectionLevels() {
-        return this.manager.getSelectionLevels(this.imodel);
-    }
-    /**
-     * Get selection for the imodel managed by this handler.
-     * @param level Level of the selection to get. Defaults to 0.
-     */
-    getSelection(level) {
-        return this.manager.getSelection(this.imodel, level);
-    }
-    /**
-     * Add to selection.
-     * @param keys The keys to add to selection.
-     * @param level Level of the selection.
-     */
-    addToSelection(keys, level = 0) {
-        if (this._inSelect)
-            return;
-        return this.manager.addToSelection(this.name, this.imodel, keys, level, this.rulesetId);
-    }
-    /**
-     * Remove from selection.
-     * @param keys The keys to remove from selection.
-     * @param level Level of the selection.
-     */
-    removeFromSelection(keys, level = 0) {
-        if (this._inSelect)
-            return;
-        return this.manager.removeFromSelection(this.name, this.imodel, keys, level, this.rulesetId);
-    }
-    /**
-     * Change selection.
-     * @param keys The keys indicating the new selection.
-     * @param level Level of the selection.
-     */
-    replaceSelection(keys, level = 0) {
-        if (this._inSelect)
-            return;
-        return this.manager.replaceSelection(this.name, this.imodel, keys, level, this.rulesetId);
-    }
-    /**
-     * Clear selection.
-     * @param level Level of the selection.
-     */
-    clearSelection(level = 0) {
-        if (this._inSelect)
-            return;
-        return this.manager.clearSelection(this.name, this.imodel, level, this.rulesetId);
-    }
-}
-exports.SelectionHandler = SelectionHandler;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectionHandler = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * A class that handles selection changes and helps to change
+ * internal the selection state.
+ *
+ * @public
+ */
+class SelectionHandler {
+    /**
+     * Constructor.
+     */
+    constructor(props) {
+        /**
+         * Called when the selection changes. Handles this callback by first checking whether
+         * the event should be handled at all (using the `shouldHandle` method) and then calling `onSelect`
+         */
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        this.onSelectionChanged = (evt, provider) => {
+            if (!this.onSelect || !this.shouldHandle(evt))
+                return;
+            this._inSelect = true;
+            this.onSelect(evt, provider);
+            this._inSelect = false;
+        };
+        this._inSelect = false;
+        this.manager = props.manager;
+        this._disposables = new core_bentley_1.DisposableList();
+        this.name = props.name;
+        this.rulesetId = props.rulesetId;
+        this.imodel = props.imodel;
+        this.onSelect = props.onSelect;
+        this._disposables.add(this.manager.selectionChange.addListener(this.onSelectionChanged));
+    }
+    /**
+     * Destructor. Must be called before disposing this object to make sure it cleans
+     * up correctly.
+     */
+    dispose() {
+        this._disposables.dispose();
+    }
+    /** Called to check whether the event should be handled by this handler */
+    shouldHandle(evt) {
+        if (this.name === evt.source)
+            return false;
+        return true;
+    }
+    /** Get selection levels for the imodel managed by this handler */
+    getSelectionLevels() {
+        return this.manager.getSelectionLevels(this.imodel);
+    }
+    /**
+     * Get selection for the imodel managed by this handler.
+     * @param level Level of the selection to get. Defaults to 0.
+     */
+    getSelection(level) {
+        return this.manager.getSelection(this.imodel, level);
+    }
+    /**
+     * Add to selection.
+     * @param keys The keys to add to selection.
+     * @param level Level of the selection.
+     */
+    addToSelection(keys, level = 0) {
+        if (this._inSelect)
+            return;
+        return this.manager.addToSelection(this.name, this.imodel, keys, level, this.rulesetId);
+    }
+    /**
+     * Remove from selection.
+     * @param keys The keys to remove from selection.
+     * @param level Level of the selection.
+     */
+    removeFromSelection(keys, level = 0) {
+        if (this._inSelect)
+            return;
+        return this.manager.removeFromSelection(this.name, this.imodel, keys, level, this.rulesetId);
+    }
+    /**
+     * Change selection.
+     * @param keys The keys indicating the new selection.
+     * @param level Level of the selection.
+     */
+    replaceSelection(keys, level = 0) {
+        if (this._inSelect)
+            return;
+        return this.manager.replaceSelection(this.name, this.imodel, keys, level, this.rulesetId);
+    }
+    /**
+     * Clear selection.
+     * @param level Level of the selection.
+     */
+    clearSelection(level = 0) {
+        if (this._inSelect)
+            return;
+        return this.manager.clearSelection(this.name, this.imodel, level, this.rulesetId);
+    }
+}
+exports.SelectionHandler = SelectionHandler;
 //# sourceMappingURL=SelectionHandler.js.map

package/lib/cjs/presentation-frontend/selection/SelectionHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"SelectionHandler.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/SelectionHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAiClE;;;;;GAKG;AACH,MAAa,gBAAgB;IAkB3B;;OAEG;IACH,YAAY,KAA4B;QAmBxC;;;WAGG;QACH,gEAAgE;QACtD,uBAAkB,GAAG,CAAC,GAA6B,EAAE,QAA4B,EAAQ,EAAE;YACnG,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC;gBAC3C,OAAO;YAET,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC7B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,CAAC,CAAC;QA9BA,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,IAAI,6BAAc,EAAE,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAgBD,0EAA0E;IAChE,YAAY,CAAC,GAA6B;QAClD,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM;YAC1B,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC3D,kBAAkB;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,KAAc;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAU,EAAE,QAAgB,CAAC;QACjD,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,IAAU,EAAE,QAAgB,CAAC;QACtD,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAAU,EAAE,QAAgB,CAAC;QACnD,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,QAAgB,CAAC;QACrC,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACpF,CAAC;CACF;AAxHD,4CAwHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module UnifiedSelection\r\n */\r\n\r\nimport { DisposableList, IDisposable } from \"@itwin/core-bentley\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { Keys, KeySet } from \"@itwin/presentation-common\";\r\nimport { ISelectionProvider } from \"./ISelectionProvider\";\r\nimport { SelectionChangeEventArgs, SelectionChangesListener } from \"./SelectionChangeEvent\";\r\nimport { SelectionManager } from \"./SelectionManager\";\r\n\r\n/**\r\n * Properties for creating a `SelectionHandler` instance.\r\n * @public\r\n */\r\nexport interface SelectionHandlerProps {\r\n  /** SelectionManager used to store overall selection. */\r\n  manager: SelectionManager;\r\n  /** iModel connection the selection changes will be associated with. */\r\n  imodel: IModelConnection;\r\n  /**\r\n   * Name of the selection handler. This is an identifier of what caused the\r\n   * selection to change, set as `SelectionChangeEventArgs.source` when firing\r\n   * selection change events. `SelectionHandler.shouldHandle` uses `name` to filter\r\n   * events that it doesn't need to handle.\r\n   */\r\n  name: string;\r\n  /**\r\n   * ID of presentation ruleset used by the component using this handler. The ID is set as\r\n   * `SelectionChangeEventArgs.rulesetId` when making selection changes and event\r\n   * listeners can use or ignore this information.\r\n   */\r\n  rulesetId?: string;\r\n  /** Callback function called when selection changes. */\r\n  onSelect?: SelectionChangesListener;\r\n}\r\n\r\n/**\r\n * A class that handles selection changes and helps to change\r\n * internal the selection state.\r\n *\r\n * @public\r\n */\r\nexport class SelectionHandler implements IDisposable {\r\n  private _inSelect: boolean;\r\n  private _disposables: DisposableList;\r\n\r\n  /** Selection manager used by this handler to manage selection */\r\n  public readonly manager: SelectionManager;\r\n  /** Name that's used as `SelectionChangeEventArgs.source` when making selection changes */\r\n  public name: string;\r\n  /** iModel whose selection is being handled */\r\n  public imodel: IModelConnection;\r\n  /**\r\n   * Id of a ruleset selection changes will be associated with.\r\n   * @see `SelectionHandlerProps.rulesetId`\r\n   */\r\n  public rulesetId?: string;\r\n  /** Callback function called when selection changes */\r\n  public onSelect?: SelectionChangesListener;\r\n\r\n  /**\r\n   * Constructor.\r\n   */\r\n  constructor(props: SelectionHandlerProps) {\r\n    this._inSelect = false;\r\n    this.manager = props.manager;\r\n    this._disposables = new DisposableList();\r\n    this.name = props.name;\r\n    this.rulesetId = props.rulesetId;\r\n    this.imodel = props.imodel;\r\n    this.onSelect = props.onSelect;\r\n    this._disposables.add(this.manager.selectionChange.addListener(this.onSelectionChanged));\r\n  }\r\n\r\n  /**\r\n   * Destructor. Must be called before disposing this object to make sure it cleans\r\n   * up correctly.\r\n   */\r\n  public dispose(): void {\r\n    this._disposables.dispose();\r\n  }\r\n\r\n  /**\r\n   * Called when the selection changes. Handles this callback by first checking whether\r\n   * the event should be handled at all (using the `shouldHandle` method) and then calling `onSelect`\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  protected onSelectionChanged = (evt: SelectionChangeEventArgs, provider: ISelectionProvider): void => {\r\n    if (!this.onSelect || !this.shouldHandle(evt))\r\n      return;\r\n\r\n    this._inSelect = true;\r\n    this.onSelect(evt, provider);\r\n    this._inSelect = false;\r\n  };\r\n\r\n  /** Called to check whether the event should be handled by this handler */\r\n  protected shouldHandle(evt: SelectionChangeEventArgs): boolean {\r\n    if (this.name === evt.source)\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /** Get selection levels for the imodel managed by this handler */\r\n  public getSelectionLevels(): number[] {\r\n    return this.manager.getSelectionLevels(this.imodel);\r\n  }\r\n\r\n  /**\r\n   * Get selection for the imodel managed by this handler.\r\n   * @param level Level of the selection to get. Defaults to 0.\r\n   */\r\n  public getSelection(level?: number): Readonly<KeySet> {\r\n    return this.manager.getSelection(this.imodel, level);\r\n  }\r\n\r\n  /**\r\n   * Add to selection.\r\n   * @param keys The keys to add to selection.\r\n   * @param level Level of the selection.\r\n   */\r\n  public addToSelection(keys: Keys, level: number = 0): void {\r\n    if (this._inSelect)\r\n      return;\r\n\r\n    return this.manager.addToSelection(this.name, this.imodel, keys, level, this.rulesetId);\r\n  }\r\n\r\n  /**\r\n   * Remove from selection.\r\n   * @param keys The keys to remove from selection.\r\n   * @param level Level of the selection.\r\n   */\r\n  public removeFromSelection(keys: Keys, level: number = 0): void {\r\n    if (this._inSelect)\r\n      return;\r\n\r\n    return this.manager.removeFromSelection(this.name, this.imodel, keys, level, this.rulesetId);\r\n  }\r\n\r\n  /**\r\n   * Change selection.\r\n   * @param keys The keys indicating the new selection.\r\n   * @param level Level of the selection.\r\n   */\r\n  public replaceSelection(keys: Keys, level: number = 0): void {\r\n    if (this._inSelect)\r\n      return;\r\n\r\n    return this.manager.replaceSelection(this.name, this.imodel, keys, level, this.rulesetId);\r\n  }\r\n\r\n  /**\r\n   * Clear selection.\r\n   * @param level Level of the selection.\r\n   */\r\n  public clearSelection(level: number = 0): void {\r\n    if (this._inSelect)\r\n      return;\r\n\r\n    return this.manager.clearSelection(this.name, this.imodel, level, this.rulesetId);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SelectionHandler.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/SelectionHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAiClE;;;;;GAKG;AACH,MAAa,gBAAgB;IAkB3B;;OAEG;IACH,YAAY,KAA4B;QAmBxC;;;WAGG;QACH,gEAAgE;QACtD,uBAAkB,GAAG,CAAC,GAA6B,EAAE,QAA4B,EAAQ,EAAE;YACnG,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC;gBAC3C,OAAO;YAET,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC7B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,CAAC,CAAC;QA9BA,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,IAAI,6BAAc,EAAE,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAgBD,0EAA0E;IAChE,YAAY,CAAC,GAA6B;QAClD,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM;YAC1B,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC3D,kBAAkB;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,KAAc;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAU,EAAE,QAAgB,CAAC;QACjD,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,IAAU,EAAE,QAAgB,CAAC;QACtD,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAAU,EAAE,QAAgB,CAAC;QACnD,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,QAAgB,CAAC;QACrC,IAAI,IAAI,CAAC,SAAS;YAChB,OAAO;QAET,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACpF,CAAC;CACF;AAxHD,4CAwHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UnifiedSelection\n */\n\nimport { DisposableList, IDisposable } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport { Keys, KeySet } from \"@itwin/presentation-common\";\nimport { ISelectionProvider } from \"./ISelectionProvider\";\nimport { SelectionChangeEventArgs, SelectionChangesListener } from \"./SelectionChangeEvent\";\nimport { SelectionManager } from \"./SelectionManager\";\n\n/**\n * Properties for creating a `SelectionHandler` instance.\n * @public\n */\nexport interface SelectionHandlerProps {\n  /** SelectionManager used to store overall selection. */\n  manager: SelectionManager;\n  /** iModel connection the selection changes will be associated with. */\n  imodel: IModelConnection;\n  /**\n   * Name of the selection handler. This is an identifier of what caused the\n   * selection to change, set as `SelectionChangeEventArgs.source` when firing\n   * selection change events. `SelectionHandler.shouldHandle` uses `name` to filter\n   * events that it doesn't need to handle.\n   */\n  name: string;\n  /**\n   * ID of presentation ruleset used by the component using this handler. The ID is set as\n   * `SelectionChangeEventArgs.rulesetId` when making selection changes and event\n   * listeners can use or ignore this information.\n   */\n  rulesetId?: string;\n  /** Callback function called when selection changes. */\n  onSelect?: SelectionChangesListener;\n}\n\n/**\n * A class that handles selection changes and helps to change\n * internal the selection state.\n *\n * @public\n */\nexport class SelectionHandler implements IDisposable {\n  private _inSelect: boolean;\n  private _disposables: DisposableList;\n\n  /** Selection manager used by this handler to manage selection */\n  public readonly manager: SelectionManager;\n  /** Name that's used as `SelectionChangeEventArgs.source` when making selection changes */\n  public name: string;\n  /** iModel whose selection is being handled */\n  public imodel: IModelConnection;\n  /**\n   * Id of a ruleset selection changes will be associated with.\n   * @see `SelectionHandlerProps.rulesetId`\n   */\n  public rulesetId?: string;\n  /** Callback function called when selection changes */\n  public onSelect?: SelectionChangesListener;\n\n  /**\n   * Constructor.\n   */\n  constructor(props: SelectionHandlerProps) {\n    this._inSelect = false;\n    this.manager = props.manager;\n    this._disposables = new DisposableList();\n    this.name = props.name;\n    this.rulesetId = props.rulesetId;\n    this.imodel = props.imodel;\n    this.onSelect = props.onSelect;\n    this._disposables.add(this.manager.selectionChange.addListener(this.onSelectionChanged));\n  }\n\n  /**\n   * Destructor. Must be called before disposing this object to make sure it cleans\n   * up correctly.\n   */\n  public dispose(): void {\n    this._disposables.dispose();\n  }\n\n  /**\n   * Called when the selection changes. Handles this callback by first checking whether\n   * the event should be handled at all (using the `shouldHandle` method) and then calling `onSelect`\n   */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  protected onSelectionChanged = (evt: SelectionChangeEventArgs, provider: ISelectionProvider): void => {\n    if (!this.onSelect || !this.shouldHandle(evt))\n      return;\n\n    this._inSelect = true;\n    this.onSelect(evt, provider);\n    this._inSelect = false;\n  };\n\n  /** Called to check whether the event should be handled by this handler */\n  protected shouldHandle(evt: SelectionChangeEventArgs): boolean {\n    if (this.name === evt.source)\n      return false;\n    return true;\n  }\n\n  /** Get selection levels for the imodel managed by this handler */\n  public getSelectionLevels(): number[] {\n    return this.manager.getSelectionLevels(this.imodel);\n  }\n\n  /**\n   * Get selection for the imodel managed by this handler.\n   * @param level Level of the selection to get. Defaults to 0.\n   */\n  public getSelection(level?: number): Readonly<KeySet> {\n    return this.manager.getSelection(this.imodel, level);\n  }\n\n  /**\n   * Add to selection.\n   * @param keys The keys to add to selection.\n   * @param level Level of the selection.\n   */\n  public addToSelection(keys: Keys, level: number = 0): void {\n    if (this._inSelect)\n      return;\n\n    return this.manager.addToSelection(this.name, this.imodel, keys, level, this.rulesetId);\n  }\n\n  /**\n   * Remove from selection.\n   * @param keys The keys to remove from selection.\n   * @param level Level of the selection.\n   */\n  public removeFromSelection(keys: Keys, level: number = 0): void {\n    if (this._inSelect)\n      return;\n\n    return this.manager.removeFromSelection(this.name, this.imodel, keys, level, this.rulesetId);\n  }\n\n  /**\n   * Change selection.\n   * @param keys The keys indicating the new selection.\n   * @param level Level of the selection.\n   */\n  public replaceSelection(keys: Keys, level: number = 0): void {\n    if (this._inSelect)\n      return;\n\n    return this.manager.replaceSelection(this.name, this.imodel, keys, level, this.rulesetId);\n  }\n\n  /**\n   * Clear selection.\n   * @param level Level of the selection.\n   */\n  public clearSelection(level: number = 0): void {\n    if (this._inSelect)\n      return;\n\n    return this.manager.clearSelection(this.name, this.imodel, level, this.rulesetId);\n  }\n}\n"]}

package/lib/cjs/presentation-frontend/selection/SelectionHelper.d.ts

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-import { Key, Keys } from "@itwin/presentation-common";
-/**
- * Helper class for working with selection.
- * @public
- */
-export declare class SelectionHelper {
-    private constructor();
-    /**
-     * Re-map the given keyset for selection. This means all instance node keys get converted
-     * to instance keys, because in that case we want to select instances instead of nodes. All
-     * other types of keys ar left as is.
-     */
-    static getKeysForSelection(keys: Readonly<Keys>): Key[];
-}
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { Key, Keys } from "@itwin/presentation-common";
+/**
+ * Helper class for working with selection.
+ * @public
+ */
+export declare class SelectionHelper {
+    private constructor();
+    /**
+     * Re-map the given keyset for selection. This means all instance node keys get converted
+     * to instance keys, because in that case we want to select instances instead of nodes. All
+     * other types of keys ar left as is.
+     */
+    static getKeysForSelection(keys: Readonly<Keys>): Key[];
+}
 //# sourceMappingURL=SelectionHelper.d.ts.map

package/lib/cjs/presentation-frontend/selection/SelectionHelper.js

@@ -1,41 +1,41 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectionHelper = void 0;
-const presentation_common_1 = require("@itwin/presentation-common");
-/**
- * Helper class for working with selection.
- * @public
- */
-class SelectionHelper {
-    // istanbul ignore next
-    constructor() { }
-    /**
-     * Re-map the given keyset for selection. This means all instance node keys get converted
-     * to instance keys, because in that case we want to select instances instead of nodes. All
-     * other types of keys ar left as is.
-     */
-    static getKeysForSelection(keys) {
-        const result = new Array();
-        keys.forEach((key) => {
-            if (presentation_common_1.Key.isNodeKey(key)) {
-                if (presentation_common_1.NodeKey.isInstancesNodeKey(key))
-                    result.push(...key.instanceKeys);
-                else
-                    result.push(key);
-            }
-            else {
-                result.push(key);
-            }
-        });
-        return result;
-    }
-}
-exports.SelectionHelper = SelectionHelper;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectionHelper = void 0;
+const presentation_common_1 = require("@itwin/presentation-common");
+/**
+ * Helper class for working with selection.
+ * @public
+ */
+class SelectionHelper {
+    // istanbul ignore next
+    constructor() { }
+    /**
+     * Re-map the given keyset for selection. This means all instance node keys get converted
+     * to instance keys, because in that case we want to select instances instead of nodes. All
+     * other types of keys ar left as is.
+     */
+    static getKeysForSelection(keys) {
+        const result = new Array();
+        keys.forEach((key) => {
+            if (presentation_common_1.Key.isNodeKey(key)) {
+                if (presentation_common_1.NodeKey.isInstancesNodeKey(key))
+                    result.push(...key.instanceKeys);
+                else
+                    result.push(key);
+            }
+            else {
+                result.push(key);
+            }
+        });
+        return result;
+    }
+}
+exports.SelectionHelper = SelectionHelper;
 //# sourceMappingURL=SelectionHelper.js.map

package/lib/cjs/presentation-frontend/selection/SelectionHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"SelectionHelper.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/SelectionHelper.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oEAAgE;AAEhE;;;GAGG;AACH,MAAa,eAAe;IAE1B,uBAAuB;IACvB,gBAAwB,CAAC;IAEzB;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAoB;QACpD,MAAM,MAAM,GAAG,IAAI,KAAK,EAAO,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,EAAE;YACxB,IAAI,yBAAG,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;gBACtB,IAAI,6BAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACjC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;;oBAEjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACpB;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAClB;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CAEF;AAzBD,0CAyBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module UnifiedSelection\r\n */\r\n\r\nimport { Key, Keys, NodeKey } from \"@itwin/presentation-common\";\r\n\r\n/**\r\n * Helper class for working with selection.\r\n * @public\r\n */\r\nexport class SelectionHelper {\r\n\r\n  // istanbul ignore next\r\n  private constructor() { }\r\n\r\n  /**\r\n   * Re-map the given keyset for selection. This means all instance node keys get converted\r\n   * to instance keys, because in that case we want to select instances instead of nodes. All\r\n   * other types of keys ar left as is.\r\n   */\r\n  public static getKeysForSelection(keys: Readonly<Keys>): Key[] {\r\n    const result = new Array<Key>();\r\n    keys.forEach((key: Key) => {\r\n      if (Key.isNodeKey(key)) {\r\n        if (NodeKey.isInstancesNodeKey(key))\r\n          result.push(...key.instanceKeys);\r\n        else\r\n          result.push(key);\r\n      } else {\r\n        result.push(key);\r\n      }\r\n    });\r\n    return result;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"SelectionHelper.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/SelectionHelper.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oEAAgE;AAEhE;;;GAGG;AACH,MAAa,eAAe;IAE1B,uBAAuB;IACvB,gBAAwB,CAAC;IAEzB;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAoB;QACpD,MAAM,MAAM,GAAG,IAAI,KAAK,EAAO,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,EAAE;YACxB,IAAI,yBAAG,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;gBACtB,IAAI,6BAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC;oBACjC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;;oBAEjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACpB;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAClB;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CAEF;AAzBD,0CAyBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UnifiedSelection\n */\n\nimport { Key, Keys, NodeKey } from \"@itwin/presentation-common\";\n\n/**\n * Helper class for working with selection.\n * @public\n */\nexport class SelectionHelper {\n\n  // istanbul ignore next\n  private constructor() { }\n\n  /**\n   * Re-map the given keyset for selection. This means all instance node keys get converted\n   * to instance keys, because in that case we want to select instances instead of nodes. All\n   * other types of keys ar left as is.\n   */\n  public static getKeysForSelection(keys: Readonly<Keys>): Key[] {\n    const result = new Array<Key>();\n    keys.forEach((key: Key) => {\n      if (Key.isNodeKey(key)) {\n        if (NodeKey.isInstancesNodeKey(key))\n          result.push(...key.instanceKeys);\n        else\n          result.push(key);\n      } else {\n        result.push(key);\n      }\n    });\n    return result;\n  }\n\n}\n"]}