@itwin/tree-widget-react 4.0.0-alpha.2 → 4.0.0-alpha.20

package/lib/esm/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.d.ts

@@ -1,42 +1,30 @@
-import type { Viewport } from "@itwin/core-frontend";
+import type { Id64Array, Id64String } from "@itwin/core-bentley";
+import type { TreeWidgetViewport } from "./TreeWidgetViewport.js";
 /**
  * Data structure that describes category.
  * @beta
  */
 export interface CategoryInfo {
-    categoryId: string;
-    subCategoryIds?: string[];
+    categoryId: Id64String;
+    subCategoryIds?: Id64Array;
 }
-/**
- * Toggles visibility of categories to show or hide.
- */
-export declare function toggleAllCategories(viewport: Viewport, display: boolean): Promise<void>;
-/**
- * Gets ids of all categories from specified imodel and viewport.
- */
-export declare function getCategories(viewport: Viewport): Promise<string[]>;
-/**
- * Changes category display in the viewport.
- */
-export declare function enableCategoryDisplay(viewport: Viewport, ids: string[], enabled: boolean, enableAllSubCategories?: boolean): Promise<void>;
-/**
- * Changes subcategory display in the viewport
- */
-export declare function enableSubCategoryDisplay(viewport: Viewport, key: string, enabled: boolean): void;
-export declare function loadCategoriesFromViewport(vp: Viewport): Promise<CategoryInfo[]>;
 /**
  * Enable display of all given categories.
  * @public
  */
-export declare function showAllCategories(categories: string[], viewport: Viewport): Promise<void>;
+export declare function showAllCategories(categories: Id64Array, viewport: TreeWidgetViewport): Promise<void>;
 /**
  * Disable display of all given categories.
  * @public
  */
-export declare function hideAllCategories(categories: string[], viewport: Viewport): Promise<void>;
+export declare function hideAllCategories(categories: Id64Array, viewport: TreeWidgetViewport): Promise<void>;
 /**
  * Invert display of all given categories.
+ * Categories are inverted like this:
+ * - If category is visible, it will be hidden.
+ * - If category is hidden, it will be visible.
+ * - If category is partially visible, it will be fully visible.
  * @public
  */
-export declare function invertAllCategories(categories: CategoryInfo[], viewport: Viewport): Promise<void>;
+export declare function invertAllCategories(categories: CategoryInfo[], viewport: TreeWidgetViewport): Promise<void>;
 //# sourceMappingURL=CategoriesVisibilityUtils.d.ts.map

package/lib/esm/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.js

@@ -2,64 +2,7 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { QueryRowFormat } from "@itwin/core-common";
-import { PerModelCategoryVisibility } from "@itwin/core-frontend";
-/**
- * Toggles visibility of categories to show or hide.
- */
-export async function toggleAllCategories(viewport, display) {
-    const ids = await getCategories(viewport);
-    if (ids.length === 0) {
-        return;
-    }
-    await enableCategoryDisplay(viewport, ids, display);
-}
-/**
- * Gets ids of all categories from specified imodel and viewport.
- */
-export async function getCategories(viewport) {
-    const categories = await loadCategoriesFromViewport(viewport);
-    return categories.map((category) => category.categoryId);
-}
-/**
- * Changes category display in the viewport.
- */
-export async function enableCategoryDisplay(viewport, ids, enabled, enableAllSubCategories = true) {
-    viewport.changeCategoryDisplay(ids, enabled, enableAllSubCategories);
-    // remove category overrides per model
-    const modelsContainingOverrides = [];
-    for (const ovr of viewport.perModelCategoryVisibility) {
-        if (ids.findIndex((id) => id === ovr.categoryId) !== -1) {
-            modelsContainingOverrides.push(ovr.modelId);
-        }
-    }
-    viewport.perModelCategoryVisibility.setOverride(modelsContainingOverrides, ids, PerModelCategoryVisibility.Override.None);
-    // changeCategoryDisplay only enables subcategories, it does not disabled them. So we must do that ourselves.
-    if (false === enabled) {
-        (await viewport.iModel.categories.getCategoryInfo(ids)).forEach((categoryInfo) => {
-            categoryInfo.subCategories.forEach((value) => enableSubCategoryDisplay(viewport, value.id, false));
-        });
-    }
-}
-/**
- * Changes subcategory display in the viewport
- */
-export function enableSubCategoryDisplay(viewport, key, enabled) {
-    viewport.changeSubCategoryDisplay(key, enabled);
-}
-export async function loadCategoriesFromViewport(vp) {
-    // Query categories and add them to state
-    const selectUsedSpatialCategoryIds = "SELECT DISTINCT Category.Id as id from BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId from BisCore.SpatialCategory)";
-    const selectUsedDrawingCategoryIds = "SELECT DISTINCT Category.Id as id from BisCore.GeometricElement2d WHERE Model.Id=? AND Category.Id IN (SELECT ECInstanceId from BisCore.DrawingCategory)";
-    const ecsql = vp.view.is3d() ? selectUsedSpatialCategoryIds : selectUsedDrawingCategoryIds;
-    const ecsql2 = `SELECT ECInstanceId as id FROM ${vp.view.is3d() ? "BisCore.SpatialCategory" : "BisCore.DrawingCategory"} WHERE ECInstanceId IN (${ecsql})`;
-    const categories = [];
-    const rows = await vp.iModel.createQueryReader(ecsql2, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames }).toArray();
-    (await vp.iModel.categories.getCategoryInfo(rows.map((row) => row.id))).forEach((val) => {
-        categories.push({ categoryId: val.id, subCategoryIds: val.subCategories.size ? [...val.subCategories.keys()] : undefined });
-    });
-    return categories;
-}
+import { enableCategoryDisplay } from "./internal/VisibilityUtils.js";
 /**
  * Enable display of all given categories.
  * @public
@@ -76,33 +19,36 @@ export async function hideAllCategories(categories, viewport) {
 }
 /**
  * Invert display of all given categories.
+ * Categories are inverted like this:
+ * - If category is visible, it will be hidden.
+ * - If category is hidden, it will be visible.
+ * - If category is partially visible, it will be fully visible.
  * @public
  */
 export async function invertAllCategories(categories, viewport) {
-    const enabled = [];
-    const disabled = [];
-    const enabledSubCategories = [];
-    const disabledSubCategories = [];
+    const categoriesToEnable = new Set();
+    const categoriesToDisable = new Set();
     for (const category of categories) {
-        if (!viewport.view.viewsCategory(category.categoryId)) {
-            disabled.push(category.categoryId);
+        if (!viewport.viewsCategory(category.categoryId)) {
+            categoriesToEnable.add(category.categoryId);
             continue;
         }
-        // First, we need to check if at least one subcategory is disabled. If it is true, then only subcategories should change display, not categories.
-        if (category.subCategoryIds?.some((subCategory) => !viewport.isSubCategoryVisible(subCategory))) {
-            for (const subCategory of category.subCategoryIds) {
-                viewport.isSubCategoryVisible(subCategory) ? enabledSubCategories.push(subCategory) : disabledSubCategories.push(subCategory);
-            }
+        // Check if category is in partial state
+        if (category.subCategoryIds?.some((subCategory) => !viewport.viewsSubCategory(subCategory))) {
+            categoriesToEnable.add(category.categoryId);
         }
         else {
-            enabled.push(category.categoryId);
+            categoriesToDisable.add(category.categoryId);
+        }
+    }
+    // collect per model overrides that need to be inverted
+    for (const { categoryId, visible } of viewport.perModelCategoryOverrides) {
+        if (!visible && categoriesToDisable.has(categoryId)) {
+            categoriesToEnable.add(categoryId);
+            categoriesToDisable.delete(categoryId);
         }
     }
-    // Disable enabled
-    enabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, false));
-    await enableCategoryDisplay(viewport, enabled, false, true);
-    // Enable disabled
-    disabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, true));
-    await enableCategoryDisplay(viewport, disabled, true, true);
+    await enableCategoryDisplay(viewport, categoriesToDisable, false, true);
+    await enableCategoryDisplay(viewport, categoriesToEnable, true, true);
 }
 //# sourceMappingURL=CategoriesVisibilityUtils.js.map

package/lib/esm/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"CategoriesVisibilityUtils.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAalE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,QAAkB,EAAE,OAAgB;IAC5E,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;QACpB,OAAO;KACR;IAED,MAAM,qBAAqB,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,QAAkB;IACpD,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAC9D,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAkB,EAAE,GAAa,EAAE,OAAgB,EAAE,sBAAsB,GAAG,IAAI;IAC5H,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC;IAErE,sCAAsC;IACtC,MAAM,yBAAyB,GAAa,EAAE,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,0BAA0B,EAAE;QACrD,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE;YACvD,yBAAyB,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC7C;KACF;IACD,QAAQ,CAAC,0BAA0B,CAAC,WAAW,CAAC,yBAAyB,EAAE,GAAG,EAAE,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAE1H,6GAA6G;IAC7G,IAAI,KAAK,KAAK,OAAO,EAAE;QACrB,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC/E,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,QAAkB,EAAE,GAAW,EAAE,OAAgB;IACxF,QAAQ,CAAC,wBAAwB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,EAAY;IAC3D,yCAAyC;IACzC,MAAM,4BAA4B,GAChC,2IAA2I,CAAC;IAC9I,MAAM,4BAA4B,GAChC,0JAA0J,CAAC;IAC7J,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,4BAA4B,CAAC;IAC3F,MAAM,MAAM,GAAG,kCAAkC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,yBAAyB,2BAA2B,KAAK,GAAG,CAAC;IAE3J,MAAM,UAAU,GAAmB,EAAE,CAAC;IAEtC,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,cAAc,CAAC,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9H,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACtF,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,EAAE,cAAc,EAAE,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9H,CAAC,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAoB,EAAE,QAAkB;IAC9E,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAoB,EAAE,QAAkB;IAC9E,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AACjE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,UAA0B,EAAE,QAAkB;IACtF,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAC1C,MAAM,qBAAqB,GAAa,EAAE,CAAC;IAE3C,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;QACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACrD,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACnC,SAAS;SACV;QACD,iJAAiJ;QACjJ,IAAI,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,EAAE;YAC/F,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,cAAc,EAAE;gBACjD,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAC/H;SACF;aAAM;YACL,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnC;KACF;IAED,kBAAkB;IAClB,oBAAoB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;IAEtG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAE5D,kBAAkB;IAClB,qBAAqB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;IAEtG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9D,CAAC","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\nimport { QueryRowFormat } from \"@itwin/core-common\";\nimport { PerModelCategoryVisibility } from \"@itwin/core-frontend\";\n\nimport type { Viewport } from \"@itwin/core-frontend\";\n\n/**\n * Data structure that describes category.\n * @beta\n */\nexport interface CategoryInfo {\n  categoryId: string;\n  subCategoryIds?: string[];\n}\n\n/**\n * Toggles visibility of categories to show or hide.\n */\nexport async function toggleAllCategories(viewport: Viewport, display: boolean) {\n  const ids = await getCategories(viewport);\n  if (ids.length === 0) {\n    return;\n  }\n\n  await enableCategoryDisplay(viewport, ids, display);\n}\n\n/**\n * Gets ids of all categories from specified imodel and viewport.\n */\nexport async function getCategories(viewport: Viewport) {\n  const categories = await loadCategoriesFromViewport(viewport);\n  return categories.map((category) => category.categoryId);\n}\n\n/**\n * Changes category display in the viewport.\n */\nexport async function enableCategoryDisplay(viewport: Viewport, ids: string[], enabled: boolean, enableAllSubCategories = true) {\n  viewport.changeCategoryDisplay(ids, enabled, enableAllSubCategories);\n\n  // remove category overrides per model\n  const modelsContainingOverrides: string[] = [];\n  for (const ovr of viewport.perModelCategoryVisibility) {\n    if (ids.findIndex((id) => id === ovr.categoryId) !== -1) {\n      modelsContainingOverrides.push(ovr.modelId);\n    }\n  }\n  viewport.perModelCategoryVisibility.setOverride(modelsContainingOverrides, ids, PerModelCategoryVisibility.Override.None);\n\n  // changeCategoryDisplay only enables subcategories, it does not disabled them. So we must do that ourselves.\n  if (false === enabled) {\n    (await viewport.iModel.categories.getCategoryInfo(ids)).forEach((categoryInfo) => {\n      categoryInfo.subCategories.forEach((value) => enableSubCategoryDisplay(viewport, value.id, false));\n    });\n  }\n}\n\n/**\n * Changes subcategory display in the viewport\n */\nexport function enableSubCategoryDisplay(viewport: Viewport, key: string, enabled: boolean) {\n  viewport.changeSubCategoryDisplay(key, enabled);\n}\n\nexport async function loadCategoriesFromViewport(vp: Viewport) {\n  // Query categories and add them to state\n  const selectUsedSpatialCategoryIds =\n    \"SELECT DISTINCT Category.Id as id from BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId from BisCore.SpatialCategory)\";\n  const selectUsedDrawingCategoryIds =\n    \"SELECT DISTINCT Category.Id as id from BisCore.GeometricElement2d WHERE Model.Id=? AND Category.Id IN (SELECT ECInstanceId from BisCore.DrawingCategory)\";\n  const ecsql = vp.view.is3d() ? selectUsedSpatialCategoryIds : selectUsedDrawingCategoryIds;\n  const ecsql2 = `SELECT ECInstanceId as id FROM ${vp.view.is3d() ? \"BisCore.SpatialCategory\" : \"BisCore.DrawingCategory\"} WHERE ECInstanceId IN (${ecsql})`;\n\n  const categories: CategoryInfo[] = [];\n\n  const rows = await vp.iModel.createQueryReader(ecsql2, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames }).toArray();\n  (await vp.iModel.categories.getCategoryInfo(rows.map((row) => row.id))).forEach((val) => {\n    categories.push({ categoryId: val.id, subCategoryIds: val.subCategories.size ? [...val.subCategories.keys()] : undefined });\n  });\n  return categories;\n}\n\n/**\n * Enable display of all given categories.\n * @public\n */\nexport async function showAllCategories(categories: string[], viewport: Viewport) {\n  await enableCategoryDisplay(viewport, categories, true, true);\n}\n\n/**\n * Disable display of all given categories.\n * @public\n */\nexport async function hideAllCategories(categories: string[], viewport: Viewport) {\n  await enableCategoryDisplay(viewport, categories, false, true);\n}\n\n/**\n * Invert display of all given categories.\n * @public\n */\nexport async function invertAllCategories(categories: CategoryInfo[], viewport: Viewport) {\n  const enabled: string[] = [];\n  const disabled: string[] = [];\n  const enabledSubCategories: string[] = [];\n  const disabledSubCategories: string[] = [];\n\n  for (const category of categories) {\n    if (!viewport.view.viewsCategory(category.categoryId)) {\n      disabled.push(category.categoryId);\n      continue;\n    }\n    // First, we need to check if at least one subcategory is disabled. If it is true, then only subcategories should change display, not categories.\n    if (category.subCategoryIds?.some((subCategory) => !viewport.isSubCategoryVisible(subCategory))) {\n      for (const subCategory of category.subCategoryIds) {\n        viewport.isSubCategoryVisible(subCategory) ? enabledSubCategories.push(subCategory) : disabledSubCategories.push(subCategory);\n      }\n    } else {\n      enabled.push(category.categoryId);\n    }\n  }\n\n  // Disable enabled\n  enabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, false));\n\n  await enableCategoryDisplay(viewport, enabled, false, true);\n\n  // Enable disabled\n  disabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, true));\n\n  await enableCategoryDisplay(viewport, disabled, true, true);\n}\n"]}
+{"version":3,"file":"CategoriesVisibilityUtils.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AActE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAqB,EAAE,QAA4B;IACzF,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAqB,EAAE,QAA4B;IACzF,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,UAA0B,EAAE,QAA4B;IAChG,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAc,CAAC;IACjD,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAc,CAAC;IAElD,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACjD,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC5C,SAAS;QACX,CAAC;QACD,wCAAwC;QACxC,IAAI,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;YAC5F,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,uDAAuD;IACvD,KAAK,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,QAAQ,CAAC,yBAAyB,EAAE,CAAC;QACzE,IAAI,CAAC,OAAO,IAAI,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACnC,mBAAmB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,MAAM,qBAAqB,CAAC,QAAQ,EAAE,mBAAmB,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAExE,MAAM,qBAAqB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AACxE,CAAC","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\nimport { enableCategoryDisplay } from \"./internal/VisibilityUtils.js\";\n\nimport type { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport type { TreeWidgetViewport } from \"./TreeWidgetViewport.js\";\n\n/**\n * Data structure that describes category.\n * @beta\n */\nexport interface CategoryInfo {\n  categoryId: Id64String;\n  subCategoryIds?: Id64Array;\n}\n\n/**\n * Enable display of all given categories.\n * @public\n */\nexport async function showAllCategories(categories: Id64Array, viewport: TreeWidgetViewport) {\n  await enableCategoryDisplay(viewport, categories, true, true);\n}\n\n/**\n * Disable display of all given categories.\n * @public\n */\nexport async function hideAllCategories(categories: Id64Array, viewport: TreeWidgetViewport) {\n  await enableCategoryDisplay(viewport, categories, false, true);\n}\n\n/**\n * Invert display of all given categories.\n * Categories are inverted like this:\n * - If category is visible, it will be hidden.\n * - If category is hidden, it will be visible.\n * - If category is partially visible, it will be fully visible.\n * @public\n */\nexport async function invertAllCategories(categories: CategoryInfo[], viewport: TreeWidgetViewport) {\n  const categoriesToEnable = new Set<Id64String>();\n  const categoriesToDisable = new Set<Id64String>();\n\n  for (const category of categories) {\n    if (!viewport.viewsCategory(category.categoryId)) {\n      categoriesToEnable.add(category.categoryId);\n      continue;\n    }\n    // Check if category is in partial state\n    if (category.subCategoryIds?.some((subCategory) => !viewport.viewsSubCategory(subCategory))) {\n      categoriesToEnable.add(category.categoryId);\n    } else {\n      categoriesToDisable.add(category.categoryId);\n    }\n  }\n\n  // collect per model overrides that need to be inverted\n  for (const { categoryId, visible } of viewport.perModelCategoryOverrides) {\n    if (!visible && categoriesToDisable.has(categoryId)) {\n      categoriesToEnable.add(categoryId);\n      categoriesToDisable.delete(categoryId);\n    }\n  }\n\n  await enableCategoryDisplay(viewport, categoriesToDisable, false, true);\n\n  await enableCategoryDisplay(viewport, categoriesToEnable, true, true);\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/common/FocusedInstancesContext.d.ts

@@ -1,11 +1,35 @@
-/// <reference types="react" />
-import type { InstanceKey } from "@itwin/presentation-shared";
+import type { PropsWithChildren } from "react";
 import type { GroupingHierarchyNode } from "@itwin/presentation-hierarchies";
-export interface FocusedInstancesContext {
+import type { SelectionStorage } from "@itwin/presentation-hierarchies-react";
+import type { InstanceKey } from "@itwin/presentation-shared";
+/** @public */
+interface FocusedInstancesContext {
+    /**
+     * A function, returning an async iterator of items that should be focused. The function is not set
+     * when instances focus mode is disabled or selection is empty.
+     */
     loadFocusedItems?: () => AsyncIterableIterator<InstanceKey | GroupingHierarchyNode>;
+    /** A flag indicating whether instances focus mode is enabled. */
     enabled: boolean;
+    /** Toggle enable or disable instances focus mode. */
     toggle: () => void;
 }
-export declare const focusedInstancesContext: import("react").Context<FocusedInstancesContext>;
+/**
+ * A React hook for getting focused instances context. The context must be provided
+ * using `FocusedInstancesContextProvider`.
+ *
+ * @public
+ */
 export declare function useFocusedInstancesContext(): FocusedInstancesContext;
+/**
+ * A React context provider for setting up focused instances context, which can then be acquired
+ * using `useFocusedInstancesContext` hook.
+ *
+ * @public
+ */
+export declare function FocusedInstancesContextProvider({ selectionStorage, imodelKey, children, }: PropsWithChildren<{
+    selectionStorage: SelectionStorage;
+    imodelKey: string;
+}>): import("react/jsx-runtime").JSX.Element;
+export {};
 //# sourceMappingURL=FocusedInstancesContext.d.ts.map

package/lib/esm/tree-widget-react/components/trees/common/FocusedInstancesContext.js

@@ -1,10 +1,81 @@
+import { jsx as _jsx } from "react/jsx-runtime";
 /*---------------------------------------------------------------------------------------------
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { createContext, useContext } from "react";
-export const focusedInstancesContext = createContext({ enabled: false, toggle: () => { } });
+import { createContext, useContext, useEffect, useState } from "react";
+import { HierarchyNode } from "@itwin/presentation-hierarchies-react";
+import { Selectable, Selectables } from "@itwin/unified-selection";
+const focusedInstancesContext = createContext({ enabled: false, toggle: () => { } });
+/**
+ * A React hook for getting focused instances context. The context must be provided
+ * using `FocusedInstancesContextProvider`.
+ *
+ * @public
+ */
 export function useFocusedInstancesContext() {
     return useContext(focusedInstancesContext);
 }
+/**
+ * A React context provider for setting up focused instances context, which can then be acquired
+ * using `useFocusedInstancesContext` hook.
+ *
+ * @public
+ */
+export function FocusedInstancesContextProvider({ selectionStorage, imodelKey, children, }) {
+    const [state, setState] = useState({
+        enabled: false,
+        toggle: () => {
+            setState((prev) => ({ ...prev, enabled: !prev.enabled }));
+        },
+    });
+    const enabled = state.enabled;
+    useEffect(() => {
+        if (!enabled) {
+            setState((prev) => ({ ...prev, loadFocusedItems: undefined }));
+            return;
+        }
+        const onSelectionChanged = () => {
+            const selection = selectionStorage.getSelection({ imodelKey, level: 0 });
+            if (Selectables.isEmpty(selection)) {
+                setState((prev) => ({ ...prev, loadFocusedItems: undefined }));
+                return;
+            }
+            const selected = [];
+            Selectables.forEach(selection, (selectable) => {
+                if (Selectable.isInstanceKey(selectable)) {
+                    selected.push(selectable);
+                    return;
+                }
+                if (isHierarchyNode(selectable.data) && HierarchyNode.isGroupingNode(selectable.data)) {
+                    selected.push(selectable.data);
+                    return;
+                }
+                selected.push(selectable.loadInstanceKeys);
+            });
+            const loadFocusedItems = async function* () {
+                for (const item of selected) {
+                    if (typeof item === "function") {
+                        yield* item();
+                    }
+                    else {
+                        yield item;
+                    }
+                }
+            };
+            setState((prev) => ({ ...prev, loadFocusedItems }));
+        };
+        onSelectionChanged();
+        return selectionStorage.selectionChangeEvent.addListener(({ imodelKey: changeImodelKey, level }) => {
+            if (changeImodelKey !== imodelKey || level !== 0) {
+                return;
+            }
+            onSelectionChanged();
+        });
+    }, [enabled, imodelKey, selectionStorage]);
+    return _jsx(focusedInstancesContext.Provider, { value: state, children: children });
+}
+function isHierarchyNode(data) {
+    return !!data && typeof data === "object" && "key" in data;
+}
 //# sourceMappingURL=FocusedInstancesContext.js.map

package/lib/esm/tree-widget-react/components/trees/common/FocusedInstancesContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"FocusedInstancesContext.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/FocusedInstancesContext.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAWlD,MAAM,CAAC,MAAM,uBAAuB,GAAG,aAAa,CAA0B,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;AAEpH,MAAM,UAAU,0BAA0B;IACxC,OAAO,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAC7C,CAAC","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\nimport { createContext, useContext } from \"react\";\n\nimport type { InstanceKey } from \"@itwin/presentation-shared\";\nimport type { GroupingHierarchyNode } from \"@itwin/presentation-hierarchies\";\n\nexport interface FocusedInstancesContext {\n  loadFocusedItems?: () => AsyncIterableIterator<InstanceKey | GroupingHierarchyNode>;\n  enabled: boolean;\n  toggle: () => void;\n}\n\nexport const focusedInstancesContext = createContext<FocusedInstancesContext>({ enabled: false, toggle: () => {} });\n\nexport function useFocusedInstancesContext() {\n  return useContext(focusedInstancesContext);\n}\n"]}
+{"version":3,"file":"FocusedInstancesContext.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/FocusedInstancesContext.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAsBnE,MAAM,uBAAuB,GAAG,aAAa,CAA0B,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;AAE7G;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B;IACxC,OAAO,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAAC,EAC9C,gBAAgB,EAChB,SAAS,EACT,QAAQ,GACqE;IAC7E,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAA0B;QAC1D,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,GAAG,EAAE;YACX,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAE9B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC/D,OAAO;QACT,CAAC;QAED,MAAM,kBAAkB,GAAG,GAAG,EAAE;YAC9B,MAAM,SAAS,GAAG,gBAAgB,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACzE,IAAI,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;gBAC/D,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAA4F,EAAE,CAAC;YAC7G,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE;gBAC5C,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;oBACzC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBAC1B,OAAO;gBACT,CAAC;gBAED,IAAI,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtF,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;oBAC/B,OAAO;gBACT,CAAC;gBAED,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAqE,KAAK,SAAS,CAAC;gBACxG,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;oBAC5B,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;wBAC/B,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;oBAChB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,CAAC;oBACb,CAAC;gBACH,CAAC;YACH,CAAC,CAAC;YAEF,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,kBAAkB,EAAE,CAAC;QACrB,OAAO,gBAAgB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,EAAE;YACjG,IAAI,eAAe,KAAK,SAAS,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBACjD,OAAO;YACT,CAAC;YACD,kBAAkB,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAE3C,OAAO,KAAC,uBAAuB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAAoC,CAAC;AACvG,CAAC;AAED,SAAS,eAAe,CAAC,IAAa;IACpC,OAAO,CAAC,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,CAAC;AAC7D,CAAC","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\nimport { createContext, useContext, useEffect, useState } from \"react\";\nimport { HierarchyNode } from \"@itwin/presentation-hierarchies-react\";\nimport { Selectable, Selectables } from \"@itwin/unified-selection\";\n\nimport type { PropsWithChildren } from \"react\";\nimport type { GroupingHierarchyNode } from \"@itwin/presentation-hierarchies\";\nimport type { SelectionStorage } from \"@itwin/presentation-hierarchies-react\";\nimport type { InstanceKey } from \"@itwin/presentation-shared\";\n\n/** @public */\ninterface FocusedInstancesContext {\n  /**\n   * A function, returning an async iterator of items that should be focused. The function is not set\n   * when instances focus mode is disabled or selection is empty.\n   */\n  loadFocusedItems?: () => AsyncIterableIterator<InstanceKey | GroupingHierarchyNode>;\n\n  /** A flag indicating whether instances focus mode is enabled. */\n  enabled: boolean;\n\n  /** Toggle enable or disable instances focus mode. */\n  toggle: () => void;\n}\n\nconst focusedInstancesContext = createContext<FocusedInstancesContext>({ enabled: false, toggle: () => {} });\n\n/**\n * A React hook for getting focused instances context. The context must be provided\n * using `FocusedInstancesContextProvider`.\n *\n * @public\n */\nexport function useFocusedInstancesContext(): FocusedInstancesContext {\n  return useContext(focusedInstancesContext);\n}\n\n/**\n * A React context provider for setting up focused instances context, which can then be acquired\n * using `useFocusedInstancesContext` hook.\n *\n * @public\n */\nexport function FocusedInstancesContextProvider({\n  selectionStorage,\n  imodelKey,\n  children,\n}: PropsWithChildren<{ selectionStorage: SelectionStorage; imodelKey: string }>) {\n  const [state, setState] = useState<FocusedInstancesContext>({\n    enabled: false,\n    toggle: () => {\n      setState((prev) => ({ ...prev, enabled: !prev.enabled }));\n    },\n  });\n  const enabled = state.enabled;\n\n  useEffect(() => {\n    if (!enabled) {\n      setState((prev) => ({ ...prev, loadFocusedItems: undefined }));\n      return;\n    }\n\n    const onSelectionChanged = () => {\n      const selection = selectionStorage.getSelection({ imodelKey, level: 0 });\n      if (Selectables.isEmpty(selection)) {\n        setState((prev) => ({ ...prev, loadFocusedItems: undefined }));\n        return;\n      }\n\n      const selected: Array<InstanceKey | GroupingHierarchyNode | (() => AsyncIterableIterator<InstanceKey>)> = [];\n      Selectables.forEach(selection, (selectable) => {\n        if (Selectable.isInstanceKey(selectable)) {\n          selected.push(selectable);\n          return;\n        }\n\n        if (isHierarchyNode(selectable.data) && HierarchyNode.isGroupingNode(selectable.data)) {\n          selected.push(selectable.data);\n          return;\n        }\n\n        selected.push(selectable.loadInstanceKeys);\n      });\n\n      const loadFocusedItems: () => AsyncIterableIterator<InstanceKey | GroupingHierarchyNode> = async function* () {\n        for (const item of selected) {\n          if (typeof item === \"function\") {\n            yield* item();\n          } else {\n            yield item;\n          }\n        }\n      };\n\n      setState((prev) => ({ ...prev, loadFocusedItems }));\n    };\n\n    onSelectionChanged();\n    return selectionStorage.selectionChangeEvent.addListener(({ imodelKey: changeImodelKey, level }) => {\n      if (changeImodelKey !== imodelKey || level !== 0) {\n        return;\n      }\n      onSelectionChanged();\n    });\n  }, [enabled, imodelKey, selectionStorage]);\n\n  return <focusedInstancesContext.Provider value={state}>{children}</focusedInstancesContext.Provider>;\n}\n\nfunction isHierarchyNode(data: unknown): data is HierarchyNode {\n  return !!data && typeof data === \"object\" && \"key\" in data;\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/common/TreeErrors.js

@@ -7,6 +7,7 @@
  * @beta
  */
 export class FilterLimitExceededError extends Error {
+    limit;
     constructor(limit) {
         super("Too many filter matches");
         this.limit = limit;

package/lib/esm/tree-widget-react/components/trees/common/TreeErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"TreeErrors.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/TreeErrors.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IACjD,YAAmC,KAAa;QAC9C,KAAK,CAAC,yBAAyB,CAAC,CAAC;QADA,UAAK,GAAL,KAAK,CAAQ;IAEhD,CAAC;CACF","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\n/**\n * Error that is thrown when too many matches are found while filtering the tree.\n * @beta\n */\nexport class FilterLimitExceededError extends Error {\n  public constructor(public readonly limit: number) {\n    super(\"Too many filter matches\");\n  }\n}\n"]}
+{"version":3,"file":"TreeErrors.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/TreeErrors.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IACd;IAAnC,YAAmC,KAAa;QAC9C,KAAK,CAAC,yBAAyB,CAAC,CAAC;QADA,UAAK,GAAL,KAAK,CAAQ;IAEhD,CAAC;CACF","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\n/**\n * Error that is thrown when too many matches are found while filtering the tree.\n * @beta\n */\nexport class FilterLimitExceededError extends Error {\n  public constructor(public readonly limit: number) {\n    super(\"Too many filter matches\");\n  }\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/common/TreeWidgetViewport.d.ts

@@ -0,0 +1,186 @@
+import type { BeEvent, Id64Arg, Id64String } from "@itwin/core-bentley";
+import type { IModelConnection, Viewport } from "@itwin/core-frontend";
+/** @public */
+export type PerModelCategoryOverride = "show" | "hide" | "none";
+/**
+ * Creates a `TreeWidgetViewport`.
+ * @beta
+ */
+export declare function createTreeWidgetViewport(viewport: Viewport): TreeWidgetViewport;
+/**
+ * A simplified interface for a Viewport that is used by the Tree Widget to control and determine visibility.
+ *
+ * Viewport should only display elements. Since elements have model, category and sub-category assigned to them, each of these can affect element visibility.
+ *
+ * The order of precedence for visibility is:
+ * 1. Model visibility - if model is not visible, elements from that model should never be displayed.
+ * 2. `neverDrawn` set - elements in that set should never be displayed.
+ * 3. `alwaysDrawn` set - elements in that set should always be displayed.
+ * 4. Per-model category visibility overrides:
+ * -  if a per-model-category has `Hide` override, elements which have that category and model should not be displayed.
+ * -  if a per-model-category has `Show` override, elements which have that category and model should be displayed.
+ * 5. Category and sub-category visibility - if element's category or sub-category is turned off, it should not be displayed.
+ *
+ * Based on this order of precedence, element can only be displayed in these scenarios:
+ * - Model is visible *AND* element is in `alwaysDrawn` set.
+ * - Model is visible *AND* element is not in `neverDrawn` set *AND* per-model category override is set to show `Show`.
+ * - Model is visible *AND* element is not in `neverDrawn` set *AND* per-model category override is not set to `Hide` *AND* category and sub-category are visible.
+ * @public
+ */
+export interface TreeWidgetViewport {
+    /**
+     * The type of the view. Generally it should be either `3d` or `2d`.
+     *
+     * The `other` value is reserved for edge cases when viewport doesn't show any elements, e.g. a blank viewport.
+     */
+    viewType: "2d" | "3d" | "other";
+    /** The iModel of this Viewport. */
+    iModel: IModelConnection;
+    /**
+     * Should return true if model specified by `modelId` is visible in the viewport.
+     *
+     * Model display should not take into account its' child elements display.
+     *
+     * When model is not displayed, all elements that have that model should not be shown in the viewport.
+     */
+    viewsModel: (modelId: Id64String) => boolean;
+    /**
+     * Should add or remove a set of models from those models currently displayed in this viewport.
+     *
+     * **NOTE** When turning model display to:
+     * - `true`, model display should be turned on. This does not mean that any elements should be turned on, it only means that
+     * model visibility should not interfere with elements visibility.
+     * - `false`, model display should be turned off. All elements which have that model should not be displayed in the viewport.
+     */
+    changeModelDisplay: (props: {
+        modelIds: Id64Arg;
+        display: boolean;
+    }) => void;
+    /**
+     * Should return true if category specified by `categoryId` is visible in the viewport.
+     *
+     * Category display should not take into account its' child elements or sub-categories display.
+     *
+     * When category is not displayed, all elements and sub-categories which have that category should not be shown in the viewport.
+     *
+     * **NOTE** Elements might still be visible if per-model category `Show` override or `alwaysDrawn` set makes them visible.
+     */
+    viewsCategory: (categoryId: Id64String) => boolean;
+    /**
+     * Should enable or disable display of elements belonging to a set of categories specified by Id.
+     *
+     * Visibility of individual sub-categories belonging to a category can be controlled separately through the use of `changeSubCategoryDisplay`.
+     *
+     * By default, enabling display of a category does not affect display of sub-categories thereof which have been set to be invisible.
+     *
+     * Changing category visibility should not change per-model category overrides.
+     *
+     * **NOTE** When turning category display to:
+     * - `true`, category display should be turned on. All elements which have specified category should be turned on if model is visible,
+     * category does not have per-model `hide` override and element is not in the `neverDrawn` set.
+     * - `false`, category and its' sub-categories display should be turned off. All elements which have that category should not be displayed in the viewport,
+     * unless element has per-model category `Show` override, or is in the `alwaysDrawn` set.
+     */
+    changeCategoryDisplay: (props: {
+        categoryIds: Id64Arg;
+        display: boolean;
+        enableAllSubCategories?: boolean;
+    }) => void;
+    /**
+     * Should return true if sub-category specified by `subCategoryId` is visible in the viewport.
+     *
+     * Sub-category display should not take into account its' child elements.
+     *
+     * When sub-category is not displayed, all elements that have that sub-category should not be shown in the viewport, unless they have per-model category `Show` override or are in the `alwaysDrawn` list.
+     */
+    viewsSubCategory: (subCategoryId: Id64String) => boolean;
+    /**
+     * Should enable or disable display of elements belonging to sub-category specified by Id.
+     *
+     * Changing sub-category display should not change category display.
+     *
+     * **NOTE** When turning sub-category display to:
+     * - `true`, sub-category display should be turned on. All elements which have specified sub-category should be turned on if model and category are visible,
+     * category does not have per-model `hide` override and element is not in the `neverDrawn` set.
+     * - `false`, sub-category display should be turned off. All elements that have that sub-category should not be displayed in the viewport,
+     * unless element has per-model category `Show` override, or is in the `alwaysDrawn` set.
+     */
+    changeSubCategoryDisplay: (props: {
+        subCategoryId: Id64String;
+        display: boolean;
+    }) => void;
+    /** Returns an iterable of per-model-category overrides. */
+    perModelCategoryOverrides: Readonly<Iterable<{
+        modelId: Id64String;
+        categoryId: Id64String;
+        visible: boolean;
+    }>>;
+    /** Should change the override state of one or more categories for one or more models. */
+    setPerModelCategoryOverride: (props: {
+        modelIds: Id64Arg;
+        categoryIds: Id64Arg;
+        override: PerModelCategoryOverride;
+    }) => void;
+    /** Should return the per-model category override. */
+    getPerModelCategoryOverride: (props: {
+        modelId: Id64String;
+        categoryId: Id64String;
+    }) => PerModelCategoryOverride;
+    /** Should remove per-model category override for the specified models. */
+    clearPerModelCategoryOverrides: (props?: {
+        modelIds?: Id64Arg;
+    }) => void;
+    /**
+     * Ids of elements which should not be displayed.
+     *
+     * This set takes precedence over category and sub-category display, per-model category overrides, and the `alwaysDrawn` set.
+     */
+    neverDrawn: ReadonlySet<Id64String> | undefined;
+    /** Ids of elements which should not be displayed in the viewport, regardless of category and sub-category visibility. */
+    setNeverDrawn: (props: {
+        elementIds: Set<Id64String>;
+    }) => void;
+    /** Should clear the set of never-drawn elements. */
+    clearNeverDrawn: () => void;
+    /**
+     * Ids of elements which should be displayed.
+     *
+     * Elements in this set should be displayed only when model is displayed as well.
+     *
+     * This set takes precedence over category and sub-category display and per-model category override.
+     */
+    alwaysDrawn: ReadonlySet<Id64String> | undefined;
+    /**
+     * Ids of elements which should be displayed in the viewport, regardless of category and sub-category visibility.
+     *
+     * These elements should be displayed only when their models are displayed as well.
+     *
+     * When the `exclusive` prop is set to `true`, only the specified elements should be drawn.
+     */
+    setAlwaysDrawn: (props: {
+        elementIds: Set<Id64String>;
+        exclusive?: boolean;
+    }) => void;
+    /** Should clear the set of always-drawn elements. */
+    clearAlwaysDrawn: () => void;
+    /**
+     * Should return true if elements in the [[alwaysDrawn]] set are the *only* elements that are displayed when their models are visible.
+     *
+     * Should be set to true when `setAlwaysDrawn` is called with `exclusive` flag. Should be set to false
+     * when `setAlwaysDrawn` is called with `exclusive` set to `false` or `undefined`, or when `clearAlwaysDrawn` is called.
+     */
+    readonly isAlwaysDrawnExclusive: boolean;
+    /** Event that should be raised when set of always-drawn elements changes. */
+    onAlwaysDrawnChanged: BeEvent<() => void>;
+    /** Event that should be raised when set of never-drawn elements changes. */
+    onNeverDrawnChanged: BeEvent<() => void>;
+    /** Event that should be raised when per-model category overrides changes. */
+    onPerModelCategoriesOverridesChanged: BeEvent<() => void>;
+    /** Event that should be raised when category display changes. */
+    onDisplayedCategoriesChanged: BeEvent<() => void>;
+    /** Event that should be raised when model display changes. */
+    onDisplayedModelsChanged: BeEvent<() => void>;
+    /** Event that should be raised when view changes between `2d`, `3d` or `other`. */
+    onDisplayStyleChanged: BeEvent<() => void>;
+}
+//# sourceMappingURL=TreeWidgetViewport.d.ts.map

package/lib/esm/tree-widget-react/components/trees/common/TreeWidgetViewport.js

@@ -0,0 +1,79 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { PerModelCategoryVisibility } from "@itwin/core-frontend";
+/**
+ * Creates a `TreeWidgetViewport`.
+ * @beta
+ */
+export function createTreeWidgetViewport(viewport) {
+    return {
+        get viewType() {
+            return viewport.view.is2d() ? "2d" : viewport.view.isSpatialView() ? "3d" : "other";
+        },
+        get iModel() {
+            return viewport.iModel;
+        },
+        viewsModel: (modelId) => viewport.view.viewsModel(modelId),
+        changeModelDisplay: (props) => {
+            if (props.display) {
+                void viewport.addViewedModels(props.modelIds);
+                return;
+            }
+            viewport.changeModelDisplay(props.modelIds, false);
+        },
+        viewsCategory: (categoryId) => viewport.view.viewsCategory(categoryId),
+        changeCategoryDisplay: (props) => viewport.changeCategoryDisplay(props.categoryIds, props.display, props.enableAllSubCategories),
+        viewsSubCategory: (subCategoryId) => viewport.isSubCategoryVisible(subCategoryId),
+        changeSubCategoryDisplay: (props) => viewport.changeSubCategoryDisplay(props.subCategoryId, props.display),
+        get perModelCategoryOverrides() {
+            return viewport.perModelCategoryVisibility;
+        },
+        setPerModelCategoryOverride: (props) => {
+            const override = props.override === "show"
+                ? PerModelCategoryVisibility.Override.Show
+                : props.override === "hide"
+                    ? PerModelCategoryVisibility.Override.Hide
+                    : PerModelCategoryVisibility.Override.None;
+            viewport.perModelCategoryVisibility.setOverride(props.modelIds, props.categoryIds, override);
+        },
+        getPerModelCategoryOverride: (props) => {
+            const override = viewport.perModelCategoryVisibility.getOverride(props.modelId, props.categoryId);
+            return override === PerModelCategoryVisibility.Override.Show ? "show" : override === PerModelCategoryVisibility.Override.Hide ? "hide" : "none";
+        },
+        clearPerModelCategoryOverrides: (props) => viewport.perModelCategoryVisibility.clearOverrides(props?.modelIds),
+        get neverDrawn() {
+            return viewport.neverDrawn;
+        },
+        setNeverDrawn: (props) => viewport.setNeverDrawn(props.elementIds),
+        clearNeverDrawn: () => viewport.clearNeverDrawn(),
+        get alwaysDrawn() {
+            return viewport.alwaysDrawn;
+        },
+        setAlwaysDrawn: (props) => viewport.setAlwaysDrawn(props.elementIds, props.exclusive),
+        clearAlwaysDrawn: () => viewport.clearAlwaysDrawn(),
+        get isAlwaysDrawnExclusive() {
+            return viewport.isAlwaysDrawnExclusive;
+        },
+        get onAlwaysDrawnChanged() {
+            return viewport.onAlwaysDrawnChanged;
+        },
+        get onNeverDrawnChanged() {
+            return viewport.onNeverDrawnChanged;
+        },
+        get onDisplayStyleChanged() {
+            return viewport.view.onDisplayStyleChanged;
+        },
+        get onDisplayedModelsChanged() {
+            return viewport.onViewedModelsChanged;
+        },
+        get onDisplayedCategoriesChanged() {
+            return viewport.onViewedCategoriesChanged;
+        },
+        get onPerModelCategoriesOverridesChanged() {
+            return viewport.onViewedCategoriesPerModelChanged;
+        },
+    };
+}
+//# sourceMappingURL=TreeWidgetViewport.js.map