@itwin/presentation-frontend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/esm/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/esm/presentation-frontend/selection/SelectionHandler.js

@@ -1,105 +1,105 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { DisposableList } from "@itwin/core-bentley";
-/**
- * A class that handles selection changes and helps to change
- * internal the selection state.
- *
- * @public
- */
-export 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 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);
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { DisposableList } from "@itwin/core-bentley";
+/**
+ * A class that handles selection changes and helps to change
+ * internal the selection state.
+ *
+ * @public
+ */
+export 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 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);
+    }
+}
 //# sourceMappingURL=SelectionHandler.js.map

package/lib/esm/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/esm/presentation-frontend/selection/SelectionHelper.js

@@ -1,37 +1,37 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { Key, NodeKey } from "@itwin/presentation-common";
-/**
- * Helper class for working with selection.
- * @public
- */
-export 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 (Key.isNodeKey(key)) {
-                if (NodeKey.isInstancesNodeKey(key))
-                    result.push(...key.instanceKeys);
-                else
-                    result.push(key);
-            }
-            else {
-                result.push(key);
-            }
-        });
-        return result;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { Key, NodeKey } from "@itwin/presentation-common";
+/**
+ * Helper class for working with selection.
+ * @public
+ */
+export 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 (Key.isNodeKey(key)) {
+                if (NodeKey.isInstancesNodeKey(key))
+                    result.push(...key.instanceKeys);
+                else
+                    result.push(key);
+            }
+            else {
+                result.push(key);
+            }
+        });
+        return result;
+    }
+}
 //# sourceMappingURL=SelectionHelper.js.map