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

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

@@ -1,53 +1,53 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-import { Id64String } from "@itwin/core-bentley";
-import { IModelConnection } from "@itwin/core-frontend";
-import { KeySet, Ruleset } from "@itwin/presentation-common";
-/** @internal */
-export declare const HILITE_RULESET: Ruleset;
-/**
- * A set of model, subcategory and element ids that can be used for specifying
- * viewport hilite.
- *
- * @public
- */
-export interface HiliteSet {
-    models?: Id64String[];
-    subCategories?: Id64String[];
-    elements?: Id64String[];
-}
-/**
- * Properties for creating a `HiliteSetProvider` instance.
- * @public
- */
-export interface HiliteSetProviderProps {
-    imodel: IModelConnection;
-}
-/**
- * Presentation-based provider which uses presentation ruleset to determine
- * what `HiliteSet` should be hilited in the graphics viewport based on the
- * supplied `KeySet`.
- *
- * @public
- */
-export declare class HiliteSetProvider {
-    private _imodel;
-    private _cached;
-    private constructor();
-    /**
-     * Create a hilite set provider for the specified iModel.
-     */
-    static create(props: HiliteSetProviderProps): HiliteSetProvider;
-    private getRecords;
-    private createHiliteSet;
-    /**
-     * Get hilite set for instances and/or nodes whose keys are specified in the
-     * given KeySet.
-     *
-     * Note: The provider caches result of the last request, so subsequent requests
-     * for the same input doesn't cost.
-     */
-    getHiliteSet(selection: Readonly<KeySet>): Promise<HiliteSet>;
-}
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+import { KeySet, Ruleset } from "@itwin/presentation-common";
+/** @internal */
+export declare const HILITE_RULESET: Ruleset;
+/**
+ * A set of model, subcategory and element ids that can be used for specifying
+ * viewport hilite.
+ *
+ * @public
+ */
+export interface HiliteSet {
+    models?: Id64String[];
+    subCategories?: Id64String[];
+    elements?: Id64String[];
+}
+/**
+ * Properties for creating a `HiliteSetProvider` instance.
+ * @public
+ */
+export interface HiliteSetProviderProps {
+    imodel: IModelConnection;
+}
+/**
+ * Presentation-based provider which uses presentation ruleset to determine
+ * what `HiliteSet` should be hilited in the graphics viewport based on the
+ * supplied `KeySet`.
+ *
+ * @public
+ */
+export declare class HiliteSetProvider {
+    private _imodel;
+    private _cached;
+    private constructor();
+    /**
+     * Create a hilite set provider for the specified iModel.
+     */
+    static create(props: HiliteSetProviderProps): HiliteSetProvider;
+    private getRecords;
+    private createHiliteSet;
+    /**
+     * Get hilite set for instances and/or nodes whose keys are specified in the
+     * given KeySet.
+     *
+     * Note: The provider caches result of the last request, so subsequent requests
+     * for the same input doesn't cost.
+     */
+    getHiliteSet(selection: Readonly<KeySet>): Promise<HiliteSet>;
+}
 //# sourceMappingURL=HiliteSetProvider.d.ts.map

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

@@ -1,98 +1,98 @@
-"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.HiliteSetProvider = exports.HILITE_RULESET = void 0;
-const presentation_common_1 = require("@itwin/presentation-common");
-const Presentation_1 = require("../Presentation");
-const SelectionManager_1 = require("./SelectionManager");
-/** @internal */
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-exports.HILITE_RULESET = require("./HiliteRules.json");
-/**
- * Presentation-based provider which uses presentation ruleset to determine
- * what `HiliteSet` should be hilited in the graphics viewport based on the
- * supplied `KeySet`.
- *
- * @public
- */
-class HiliteSetProvider {
-    constructor(props) {
-        this._imodel = props.imodel;
-    }
-    /**
-     * Create a hilite set provider for the specified iModel.
-     */
-    static create(props) { return new HiliteSetProvider(props); }
-    async getRecords(keys) {
-        const descriptor = {
-            displayType: presentation_common_1.DefaultContentDisplayTypes.Viewport,
-            contentFlags: presentation_common_1.ContentFlags.KeysOnly,
-        };
-        const options = {
-            imodel: this._imodel,
-            rulesetOrId: exports.HILITE_RULESET,
-            descriptor,
-        };
-        const contentPromises = new Array();
-        keys.forEachBatch(presentation_common_1.DEFAULT_KEYS_BATCH_SIZE, (batch) => {
-            contentPromises.push(Presentation_1.Presentation.presentation.getContent({ ...options, keys: batch }));
-        });
-        return (await Promise.all(contentPromises)).reduce((items, content) => {
-            if (content)
-                items.push(...content.contentSet);
-            return items;
-        }, new Array());
-    }
-    createHiliteSet(records, transientIds) {
-        if (!records.length)
-            return { elements: transientIds };
-        const modelIds = new Array();
-        const subCategoryIds = new Array();
-        const elementIds = transientIds; // note: not making a copy here since we're throwing away `transientIds` anyway
-        records.forEach((rec) => {
-            const ids = isModelRecord(rec) ? modelIds : isSubCategoryRecord(rec) ? subCategoryIds : elementIds;
-            rec.primaryKeys.forEach((pk) => ids.push(pk.id));
-        });
-        return {
-            models: modelIds.length ? modelIds : undefined,
-            subCategories: subCategoryIds.length ? subCategoryIds : undefined,
-            elements: elementIds.length ? elementIds : undefined,
-        };
-    }
-    /**
-     * Get hilite set for instances and/or nodes whose keys are specified in the
-     * given KeySet.
-     *
-     * Note: The provider caches result of the last request, so subsequent requests
-     * for the same input doesn't cost.
-     */
-    async getHiliteSet(selection) {
-        const selectionGuid = selection.guid;
-        if (!this._cached || this._cached.keysGuid !== selectionGuid) {
-            // need to create a new set without transients
-            const transientIds = new Array();
-            const keys = new presentation_common_1.KeySet();
-            keys.add(selection, (key) => {
-                if (presentation_common_1.Key.isInstanceKey(key) && key.className === SelectionManager_1.TRANSIENT_ELEMENT_CLASSNAME) {
-                    transientIds.push(key.id);
-                    return false;
-                }
-                return true;
-            });
-            const records = await this.getRecords(keys);
-            const result = this.createHiliteSet(records, transientIds);
-            this._cached = { keysGuid: selectionGuid, result };
-        }
-        return this._cached.result;
-    }
-}
-exports.HiliteSetProvider = HiliteSetProvider;
-const isModelRecord = (rec) => (rec.extendedData && rec.extendedData.isModel);
-const isSubCategoryRecord = (rec) => (rec.extendedData && rec.extendedData.isSubCategory);
+"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.HiliteSetProvider = exports.HILITE_RULESET = void 0;
+const presentation_common_1 = require("@itwin/presentation-common");
+const Presentation_1 = require("../Presentation");
+const SelectionManager_1 = require("./SelectionManager");
+/** @internal */
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+exports.HILITE_RULESET = require("./HiliteRules.json");
+/**
+ * Presentation-based provider which uses presentation ruleset to determine
+ * what `HiliteSet` should be hilited in the graphics viewport based on the
+ * supplied `KeySet`.
+ *
+ * @public
+ */
+class HiliteSetProvider {
+    constructor(props) {
+        this._imodel = props.imodel;
+    }
+    /**
+     * Create a hilite set provider for the specified iModel.
+     */
+    static create(props) { return new HiliteSetProvider(props); }
+    async getRecords(keys) {
+        const descriptor = {
+            displayType: presentation_common_1.DefaultContentDisplayTypes.Viewport,
+            contentFlags: presentation_common_1.ContentFlags.KeysOnly,
+        };
+        const options = {
+            imodel: this._imodel,
+            rulesetOrId: exports.HILITE_RULESET,
+            descriptor,
+        };
+        const contentPromises = new Array();
+        keys.forEachBatch(presentation_common_1.DEFAULT_KEYS_BATCH_SIZE, (batch) => {
+            contentPromises.push(Presentation_1.Presentation.presentation.getContent({ ...options, keys: batch }));
+        });
+        return (await Promise.all(contentPromises)).reduce((items, content) => {
+            if (content)
+                items.push(...content.contentSet);
+            return items;
+        }, new Array());
+    }
+    createHiliteSet(records, transientIds) {
+        if (!records.length)
+            return { elements: transientIds };
+        const modelIds = new Array();
+        const subCategoryIds = new Array();
+        const elementIds = transientIds; // note: not making a copy here since we're throwing away `transientIds` anyway
+        records.forEach((rec) => {
+            const ids = isModelRecord(rec) ? modelIds : isSubCategoryRecord(rec) ? subCategoryIds : elementIds;
+            rec.primaryKeys.forEach((pk) => ids.push(pk.id));
+        });
+        return {
+            models: modelIds.length ? modelIds : undefined,
+            subCategories: subCategoryIds.length ? subCategoryIds : undefined,
+            elements: elementIds.length ? elementIds : undefined,
+        };
+    }
+    /**
+     * Get hilite set for instances and/or nodes whose keys are specified in the
+     * given KeySet.
+     *
+     * Note: The provider caches result of the last request, so subsequent requests
+     * for the same input doesn't cost.
+     */
+    async getHiliteSet(selection) {
+        const selectionGuid = selection.guid;
+        if (!this._cached || this._cached.keysGuid !== selectionGuid) {
+            // need to create a new set without transients
+            const transientIds = new Array();
+            const keys = new presentation_common_1.KeySet();
+            keys.add(selection, (key) => {
+                if (presentation_common_1.Key.isInstanceKey(key) && key.className === SelectionManager_1.TRANSIENT_ELEMENT_CLASSNAME) {
+                    transientIds.push(key.id);
+                    return false;
+                }
+                return true;
+            });
+            const records = await this.getRecords(keys);
+            const result = this.createHiliteSet(records, transientIds);
+            this._cached = { keysGuid: selectionGuid, result };
+        }
+        return this._cached.result;
+    }
+}
+exports.HiliteSetProvider = HiliteSetProvider;
+const isModelRecord = (rec) => (rec.extendedData && rec.extendedData.isModel);
+const isSubCategoryRecord = (rec) => (rec.extendedData && rec.extendedData.isSubCategory);
 //# sourceMappingURL=HiliteSetProvider.js.map

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

@@ -1,20 +1,20 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-import { IModelConnection } from "@itwin/core-frontend";
-import { KeySet } from "@itwin/presentation-common";
-import { SelectionChangeEvent } from "./SelectionChangeEvent";
-/**
- * Selection provider interface which provides main selection and sub-selection.
- * @public
- */
-export interface ISelectionProvider {
-    /** An event that's fired when selection changes */
-    selectionChange: SelectionChangeEvent;
-    /** Get the selection stored in the provider.
-     * @param imodel iModel connection which the selection is associated with.
-     * @param level Level of the selection (see [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels))
-     */
-    getSelection(imodel: IModelConnection, level: number): Readonly<KeySet>;
-}
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { IModelConnection } from "@itwin/core-frontend";
+import { KeySet } from "@itwin/presentation-common";
+import { SelectionChangeEvent } from "./SelectionChangeEvent";
+/**
+ * Selection provider interface which provides main selection and sub-selection.
+ * @public
+ */
+export interface ISelectionProvider {
+    /** An event that's fired when selection changes */
+    selectionChange: SelectionChangeEvent;
+    /** Get the selection stored in the provider.
+     * @param imodel iModel connection which the selection is associated with.
+     * @param level Level of the selection (see [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels))
+     */
+    getSelection(imodel: IModelConnection, level: number): Readonly<KeySet>;
+}
 //# sourceMappingURL=ISelectionProvider.d.ts.map

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

@@ -1,10 +1,10 @@
-"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 });
+"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 });
 //# sourceMappingURL=ISelectionProvider.js.map

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

@@ -1,53 +1,53 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { IModelConnection } from "@itwin/core-frontend";
-import { KeySet } from "@itwin/presentation-common";
-import { ISelectionProvider } from "./ISelectionProvider";
-/**
- * An interface for selection change listeners.
- * @public
- */
-export declare type SelectionChangesListener = (args: SelectionChangeEventArgs, provider: ISelectionProvider) => void;
-/**
- * An event broadcasted on selection changes
- * @public
- */
-export declare class SelectionChangeEvent extends BeEvent<SelectionChangesListener> {
-}
-/**
- * The type of selection change
- * @public
- */
-export declare enum SelectionChangeType {
-    /** Added to selection. */
-    Add = 0,
-    /** Removed from selection. */
-    Remove = 1,
-    /** Selection was replaced. */
-    Replace = 2,
-    /** Selection was cleared. */
-    Clear = 3
-}
-/**
- * The event object that's sent when the selection changes.
- * @public
- */
-export interface SelectionChangeEventArgs {
-    /** The name of the selection source which caused the selection change. */
-    source: string;
-    /** Level of the selection. See [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels). */
-    level: number;
-    /** The selection change type. */
-    changeType: SelectionChangeType;
-    /** Set of keys affected by this selection change event. */
-    keys: Readonly<KeySet>;
-    /** iModel connection with which the selection is associated with. */
-    imodel: IModelConnection;
-    /** The timestamp of when the selection change happened */
-    timestamp: Date;
-    /** Id of the ruleset associated with the selection change. */
-    rulesetId?: string;
-}
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+import { KeySet } from "@itwin/presentation-common";
+import { ISelectionProvider } from "./ISelectionProvider";
+/**
+ * An interface for selection change listeners.
+ * @public
+ */
+export declare type SelectionChangesListener = (args: SelectionChangeEventArgs, provider: ISelectionProvider) => void;
+/**
+ * An event broadcasted on selection changes
+ * @public
+ */
+export declare class SelectionChangeEvent extends BeEvent<SelectionChangesListener> {
+}
+/**
+ * The type of selection change
+ * @public
+ */
+export declare enum SelectionChangeType {
+    /** Added to selection. */
+    Add = 0,
+    /** Removed from selection. */
+    Remove = 1,
+    /** Selection was replaced. */
+    Replace = 2,
+    /** Selection was cleared. */
+    Clear = 3
+}
+/**
+ * The event object that's sent when the selection changes.
+ * @public
+ */
+export interface SelectionChangeEventArgs {
+    /** The name of the selection source which caused the selection change. */
+    source: string;
+    /** Level of the selection. See [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels). */
+    level: number;
+    /** The selection change type. */
+    changeType: SelectionChangeType;
+    /** Set of keys affected by this selection change event. */
+    keys: Readonly<KeySet>;
+    /** iModel connection with which the selection is associated with. */
+    imodel: IModelConnection;
+    /** The timestamp of when the selection change happened */
+    timestamp: Date;
+    /** Id of the ruleset associated with the selection change. */
+    rulesetId?: string;
+}
 //# sourceMappingURL=SelectionChangeEvent.d.ts.map

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

@@ -1,34 +1,34 @@
-"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.SelectionChangeType = exports.SelectionChangeEvent = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-/**
- * An event broadcasted on selection changes
- * @public
- */
-class SelectionChangeEvent extends core_bentley_1.BeEvent {
-}
-exports.SelectionChangeEvent = SelectionChangeEvent;
-/**
- * The type of selection change
- * @public
- */
-var SelectionChangeType;
-(function (SelectionChangeType) {
-    /** Added to selection. */
-    SelectionChangeType[SelectionChangeType["Add"] = 0] = "Add";
-    /** Removed from selection. */
-    SelectionChangeType[SelectionChangeType["Remove"] = 1] = "Remove";
-    /** Selection was replaced. */
-    SelectionChangeType[SelectionChangeType["Replace"] = 2] = "Replace";
-    /** Selection was cleared. */
-    SelectionChangeType[SelectionChangeType["Clear"] = 3] = "Clear";
-})(SelectionChangeType = exports.SelectionChangeType || (exports.SelectionChangeType = {}));
+"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.SelectionChangeType = exports.SelectionChangeEvent = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * An event broadcasted on selection changes
+ * @public
+ */
+class SelectionChangeEvent extends core_bentley_1.BeEvent {
+}
+exports.SelectionChangeEvent = SelectionChangeEvent;
+/**
+ * The type of selection change
+ * @public
+ */
+var SelectionChangeType;
+(function (SelectionChangeType) {
+    /** Added to selection. */
+    SelectionChangeType[SelectionChangeType["Add"] = 0] = "Add";
+    /** Removed from selection. */
+    SelectionChangeType[SelectionChangeType["Remove"] = 1] = "Remove";
+    /** Selection was replaced. */
+    SelectionChangeType[SelectionChangeType["Replace"] = 2] = "Replace";
+    /** Selection was cleared. */
+    SelectionChangeType[SelectionChangeType["Clear"] = 3] = "Clear";
+})(SelectionChangeType = exports.SelectionChangeType || (exports.SelectionChangeType = {}));
 //# sourceMappingURL=SelectionChangeEvent.js.map