@itwin/tree-widget-react 3.0.0-dev.0 → 3.0.0-dev.2

package/lib/cjs/components/trees/categories-tree/CategoriesTree.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CategoriesTree = void 0;
+const jsx_runtime_1 = require("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.
+ *--------------------------------------------------------------------------------------------*/
+const react_1 = require("react");
+const core_frontend_1 = require("@itwin/core-frontend");
+const itwinui_icons_react_1 = require("@itwin/itwinui-icons-react");
+const itwinui_react_1 = require("@itwin/itwinui-react");
+const TreeWidget_1 = require("../../../TreeWidget");
+const VisibilityTree_1 = require("../common/components/VisibilityTree");
+const UseFeatureReporting_1 = require("../common/UseFeatureReporting");
+const CategoriesTreeComponent_1 = require("./CategoriesTreeComponent");
+const CategoriesTreeDefinition_1 = require("./CategoriesTreeDefinition");
+const CategoriesVisibilityHandler_1 = require("./CategoriesVisibilityHandler");
+/** @internal */
+function CategoriesTree({ imodel, viewManager, categories, allViewports, getSchemaContext, height, width, activeView, filter, density, hierarchyLevelConfig, selectionMode, onPerformanceMeasured, onFeatureUsed, }) {
+    const [filteringError, setFilteringError] = (0, react_1.useState)();
+    const visibilityHandlerFactory = (0, react_1.useCallback)(() => {
+        const visibilityHandler = new CategoriesVisibilityHandler_1.CategoriesVisibilityHandler({
+            imodel,
+            viewport: activeView,
+            viewManager: viewManager ?? core_frontend_1.IModelApp.viewManager,
+            categories,
+            allViewports,
+        });
+        return {
+            getVisibilityStatus: async (node) => visibilityHandler.getVisibilityStatus(node),
+            changeVisibility: async (node, on) => visibilityHandler.changeVisibility(node, on),
+            onVisibilityChange: visibilityHandler.onVisibilityChange,
+            dispose: () => visibilityHandler.dispose(),
+        };
+    }, [activeView, allViewports, categories, imodel, viewManager]);
+    const { reportUsage } = (0, UseFeatureReporting_1.useFeatureReporting)({ onFeatureUsed, treeIdentifier: CategoriesTreeComponent_1.CategoriesTreeComponent.id });
+    const getDefinitionsProvider = (0, react_1.useCallback)((props) => {
+        return new CategoriesTreeDefinition_1.CategoriesTreeDefinition({ ...props, viewType: activeView.view.is2d() ? "2d" : "3d" });
+    }, [activeView]);
+    const getSearchFilteredPaths = (0, react_1.useMemo)(() => {
+        setFilteringError(undefined);
+        if (!filter) {
+            return undefined;
+        }
+        return async ({ imodelAccess }) => {
+            reportUsage?.({ featureId: "filtering", reportInteraction: true });
+            try {
+                return await CategoriesTreeDefinition_1.CategoriesTreeDefinition.createInstanceKeyPaths({ imodelAccess, label: filter, viewType: activeView.view.is2d() ? "2d" : "3d" });
+            }
+            catch (e) {
+                const newError = e instanceof Error && e.message.match(/Filter matches more than \d+ items/) ? "tooManyFilterMatches" : "unknownFilterError";
+                setFilteringError(newError);
+                return [];
+            }
+        };
+    }, [filter, activeView, reportUsage]);
+    return ((0, jsx_runtime_1.jsx)(VisibilityTree_1.VisibilityTree, { height: height, width: width, imodel: imodel, treeName: CategoriesTreeComponent_1.CategoriesTreeComponent.id, getSchemaContext: getSchemaContext, visibilityHandlerFactory: visibilityHandlerFactory, getHierarchyDefinition: getDefinitionsProvider, getFilteredPaths: getSearchFilteredPaths, hierarchyLevelSizeLimit: hierarchyLevelConfig?.sizeLimit, getSublabel: getSublabel, getIcon: getIcon, density: density, noDataMessage: getNoDataMessage(filter, filteringError), selectionMode: selectionMode ?? "none", onPerformanceMeasured: (action, duration) => {
+            onPerformanceMeasured?.(`${CategoriesTreeComponent_1.CategoriesTreeComponent.id}-${action}`, duration);
+        }, reportUsage: reportUsage, searchText: filter }));
+}
+exports.CategoriesTree = CategoriesTree;
+function getNoDataMessage(filter, error) {
+    if (error) {
+        return (0, jsx_runtime_1.jsx)(itwinui_react_1.Text, { children: TreeWidget_1.TreeWidget.translate(`categoriesTree.filtering.${error}`) });
+    }
+    if (filter) {
+        return (0, jsx_runtime_1.jsx)(itwinui_react_1.Text, { children: TreeWidget_1.TreeWidget.translate("categoriesTree.filtering.noMatches", { filter }) });
+    }
+    return undefined;
+}
+function getIcon() {
+    return (0, jsx_runtime_1.jsx)(itwinui_icons_react_1.SvgLayers, {});
+}
+function getSublabel(node) {
+    return node.extendedData?.description;
+}
+//# sourceMappingURL=CategoriesTree.js.map

package/lib/cjs/components/trees/categories-tree/CategoriesTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoriesTree.js","sourceRoot":"","sources":["../../../../../src/components/trees/categories-tree/CategoriesTree.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,iCAAuD;AACvD,wDAAiD;AACjD,oEAAuD;AACvD,wDAA4C;AAC5C,oDAAiD;AACjD,wEAAqE;AACrE,uEAAoE;AACpE,uEAAoE;AACpE,yEAAsE;AACtE,+EAA4E;AA6B5E,gBAAgB;AAChB,SAAgB,cAAc,CAAC,EAC7B,MAAM,EACN,WAAW,EACX,UAAU,EACV,YAAY,EACZ,gBAAgB,EAChB,MAAM,EACN,KAAK,EACL,UAAU,EACV,MAAM,EACN,OAAO,EACP,oBAAoB,EACpB,aAAa,EACb,qBAAqB,EACrB,aAAa,GACG;IAChB,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,IAAA,gBAAQ,GAA4C,CAAC;IACjG,MAAM,wBAAwB,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;QAChD,MAAM,iBAAiB,GAAG,IAAI,yDAA2B,CAAC;YACxD,MAAM;YACN,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,WAAW,IAAI,yBAAS,CAAC,WAAW;YACjD,UAAU;YACV,YAAY;SACb,CAAC,CAAC;QACH,OAAO;YACL,mBAAmB,EAAE,KAAK,EAAE,IAAmB,EAAE,EAAE,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC;YAC/F,gBAAgB,EAAE,KAAK,EAAE,IAAmB,EAAE,EAAW,EAAE,EAAE,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC;YAC1G,kBAAkB,EAAE,iBAAiB,CAAC,kBAAkB;YACxD,OAAO,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,OAAO,EAAE;SAC3C,CAAC;IACJ,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IAEhE,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,yCAAmB,EAAC,EAAE,aAAa,EAAE,cAAc,EAAE,iDAAuB,CAAC,EAAE,EAAE,CAAC,CAAC;IAE3G,MAAM,sBAAsB,GAAG,IAAA,mBAAW,EACxC,CAAC,KAAoD,EAAE,EAAE;QACvD,OAAO,IAAI,mDAAwB,CAAC,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACpG,CAAC,EACD,CAAC,UAAU,CAAC,CACb,CAAC;IAEF,MAAM,sBAAsB,GAAG,IAAA,eAAO,EAAuC,GAAG,EAAE;QAChF,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;YAChC,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;YACnE,IAAI;gBACF,OAAO,MAAM,mDAAwB,CAAC,sBAAsB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;aAC/I;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,QAAQ,GAAG,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBAC7I,iBAAiB,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,EAAE,CAAC;aACX;QACH,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;IAEtC,OAAO,CACL,uBAAC,+BAAc,IACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,iDAAuB,CAAC,EAAE,EACpC,gBAAgB,EAAE,gBAAgB,EAClC,wBAAwB,EAAE,wBAAwB,EAClD,sBAAsB,EAAE,sBAAsB,EAC9C,gBAAgB,EAAE,sBAAsB,EACxC,uBAAuB,EAAE,oBAAoB,EAAE,SAAS,EACxD,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,gBAAgB,CAAC,MAAM,EAAE,cAAc,CAAC,EACvD,aAAa,EAAE,aAAa,IAAI,MAAM,EACtC,qBAAqB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YAC1C,qBAAqB,EAAE,CAAC,GAAG,iDAAuB,CAAC,EAAE,IAAI,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC;QAC/E,CAAC,EACD,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,GAClB,CACH,CAAC;AACJ,CAAC;AAlFD,wCAkFC;AAED,SAAS,gBAAgB,CAAC,MAAc,EAAE,KAAoC;IAC5E,IAAI,KAAK,EAAE;QACT,OAAO,uBAAC,oBAAI,cAAE,uBAAU,CAAC,SAAS,CAAC,4BAA4B,KAAK,EAAE,CAAC,GAAQ,CAAC;KACjF;IACD,IAAI,MAAM,EAAE;QACV,OAAO,uBAAC,oBAAI,cAAE,uBAAU,CAAC,SAAS,CAAC,oCAAoC,EAAE,EAAE,MAAM,EAAE,CAAC,GAAQ,CAAC;KAC9F;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO;IACd,OAAO,uBAAC,+BAAS,KAAG,CAAC;AACvB,CAAC;AAED,SAAS,WAAW,CAAC,IAA+B;IAClD,OAAO,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC;AACxC,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 { useCallback, useMemo, useState } from \"react\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { SvgLayers } from \"@itwin/itwinui-icons-react\";\nimport { Text } from \"@itwin/itwinui-react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { VisibilityTree } from \"../common/components/VisibilityTree\";\nimport { useFeatureReporting } from \"../common/UseFeatureReporting\";\nimport { CategoriesTreeComponent } from \"./CategoriesTreeComponent\";\nimport { CategoriesTreeDefinition } from \"./CategoriesTreeDefinition\";\nimport { CategoriesVisibilityHandler } from \"./CategoriesVisibilityHandler\";\n\nimport type { CategoryInfo } from \"../common/CategoriesVisibilityUtils\";\nimport type { ComponentPropsWithoutRef } from \"react\";\nimport type { ViewManager, Viewport } from \"@itwin/core-frontend\";\nimport type { HierarchyNode } from \"@itwin/presentation-hierarchies\";\nimport type { PresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\n\ntype CategoriesTreeFilteringError = \"tooManyFilterMatches\" | \"unknownFilterError\";\n\ninterface CategoriesTreeOwnProps {\n  filter: string;\n  activeView: Viewport;\n  categories: CategoryInfo[];\n  viewManager?: ViewManager;\n  allViewports?: boolean;\n  hierarchyLevelConfig?: {\n    sizeLimit?: number;\n  };\n  onPerformanceMeasured?: (featureId: string, duration: number) => void;\n  onFeatureUsed?: (feature: string) => void;\n}\n\ntype VisibilityTreeProps = ComponentPropsWithoutRef<typeof VisibilityTree>;\ntype GetFilteredPathsCallback = VisibilityTreeProps[\"getFilteredPaths\"];\ntype GetHierarchyDefinitionCallback = VisibilityTreeProps[\"getHierarchyDefinition\"];\n\ntype ModelsTreeProps = CategoriesTreeOwnProps & Pick<VisibilityTreeProps, \"imodel\" | \"getSchemaContext\" | \"height\" | \"width\" | \"density\" | \"selectionMode\">;\n\n/** @internal */\nexport function CategoriesTree({\n  imodel,\n  viewManager,\n  categories,\n  allViewports,\n  getSchemaContext,\n  height,\n  width,\n  activeView,\n  filter,\n  density,\n  hierarchyLevelConfig,\n  selectionMode,\n  onPerformanceMeasured,\n  onFeatureUsed,\n}: ModelsTreeProps) {\n  const [filteringError, setFilteringError] = useState<CategoriesTreeFilteringError | undefined>();\n  const visibilityHandlerFactory = useCallback(() => {\n    const visibilityHandler = new CategoriesVisibilityHandler({\n      imodel,\n      viewport: activeView,\n      viewManager: viewManager ?? IModelApp.viewManager,\n      categories,\n      allViewports,\n    });\n    return {\n      getVisibilityStatus: async (node: HierarchyNode) => visibilityHandler.getVisibilityStatus(node),\n      changeVisibility: async (node: HierarchyNode, on: boolean) => visibilityHandler.changeVisibility(node, on),\n      onVisibilityChange: visibilityHandler.onVisibilityChange,\n      dispose: () => visibilityHandler.dispose(),\n    };\n  }, [activeView, allViewports, categories, imodel, viewManager]);\n\n  const { reportUsage } = useFeatureReporting({ onFeatureUsed, treeIdentifier: CategoriesTreeComponent.id });\n\n  const getDefinitionsProvider = useCallback(\n    (props: Parameters<GetHierarchyDefinitionCallback>[0]) => {\n      return new CategoriesTreeDefinition({ ...props, viewType: activeView.view.is2d() ? \"2d\" : \"3d\" });\n    },\n    [activeView],\n  );\n\n  const getSearchFilteredPaths = useMemo<GetFilteredPathsCallback | undefined>(() => {\n    setFilteringError(undefined);\n    if (!filter) {\n      return undefined;\n    }\n    return async ({ imodelAccess }) => {\n      reportUsage?.({ featureId: \"filtering\", reportInteraction: true });\n      try {\n        return await CategoriesTreeDefinition.createInstanceKeyPaths({ imodelAccess, label: filter, viewType: activeView.view.is2d() ? \"2d\" : \"3d\" });\n      } catch (e) {\n        const newError = e instanceof Error && e.message.match(/Filter matches more than \\d+ items/) ? \"tooManyFilterMatches\" : \"unknownFilterError\";\n        setFilteringError(newError);\n        return [];\n      }\n    };\n  }, [filter, activeView, reportUsage]);\n\n  return (\n    <VisibilityTree\n      height={height}\n      width={width}\n      imodel={imodel}\n      treeName={CategoriesTreeComponent.id}\n      getSchemaContext={getSchemaContext}\n      visibilityHandlerFactory={visibilityHandlerFactory}\n      getHierarchyDefinition={getDefinitionsProvider}\n      getFilteredPaths={getSearchFilteredPaths}\n      hierarchyLevelSizeLimit={hierarchyLevelConfig?.sizeLimit}\n      getSublabel={getSublabel}\n      getIcon={getIcon}\n      density={density}\n      noDataMessage={getNoDataMessage(filter, filteringError)}\n      selectionMode={selectionMode ?? \"none\"}\n      onPerformanceMeasured={(action, duration) => {\n        onPerformanceMeasured?.(`${CategoriesTreeComponent.id}-${action}`, duration);\n      }}\n      reportUsage={reportUsage}\n      searchText={filter}\n    />\n  );\n}\n\nfunction getNoDataMessage(filter: string, error?: CategoriesTreeFilteringError) {\n  if (error) {\n    return <Text>{TreeWidget.translate(`categoriesTree.filtering.${error}`)}</Text>;\n  }\n  if (filter) {\n    return <Text>{TreeWidget.translate(\"categoriesTree.filtering.noMatches\", { filter })}</Text>;\n  }\n  return undefined;\n}\n\nfunction getIcon() {\n  return <SvgLayers />;\n}\n\nfunction getSublabel(node: PresentationHierarchyNode) {\n  return node.extendedData?.description;\n}\n"]}

package/lib/{esm/components/trees/category-tree → cjs/components/trees/categories-tree}/CategoriesTreeButtons.d.ts

@@ -1,15 +1,8 @@
 /// <reference types="react" />
+import type { CategoryInfo } from "../common/CategoriesVisibilityUtils";
 import type { TreeHeaderButtonProps } from "../../tree-header/TreeHeader";
 /**
- * Data structure that describes category.
- * @public
- */
-export interface CategoryInfo {
-    categoryId: string;
-    subCategoryIds?: string[];
-}
-/**
- * Props that get passed to [[CategoriesTreeComponent]] header button renderer.
+ * Props that get passed to `CategoriesTreeComponent` header button renderer.
  * @see CategoriesTreeComponentProps.headerButtons
  * @public
  */

package/lib/cjs/components/trees/{category-tree → categories-tree}/CategoriesTreeButtons.js

@@ -9,29 +9,28 @@ const jsx_runtime_1 = require("react/jsx-runtime");
 const itwinui_icons_react_1 = require("@itwin/itwinui-icons-react");
 const itwinui_react_1 = require("@itwin/itwinui-react");
 const TreeWidget_1 = require("../../../TreeWidget");
-const CategoriesTreeComponent_1 = require("./CategoriesTreeComponent");
-const CategoryVisibilityHandler_1 = require("./CategoryVisibilityHandler");
+const CategoriesVisibilityUtils_1 = require("../common/CategoriesVisibilityUtils");
 /** @internal */
 function ShowAllButton(props) {
-    return ((0, jsx_runtime_1.jsx)(itwinui_react_1.IconButton, { size: props.density === "enlarged" ? "large" : "small", styleType: "borderless", title: TreeWidget_1.TreeWidget.translate("showAll"), onClick: () => {
-            props.onFeatureUsed?.(`${CategoriesTreeComponent_1.CategoriesTreeComponent.id}-showall`);
-            void (0, CategoryVisibilityHandler_1.showAllCategories)((props.filteredCategories ?? props.categories).map((category) => category.categoryId), props.viewport);
+    return ((0, jsx_runtime_1.jsx)(itwinui_react_1.IconButton, { size: props.density === "enlarged" ? "large" : "small", styleType: "borderless", title: TreeWidget_1.TreeWidget.translate("categoriesTree.buttons.showAll.tooltip"), onClick: () => {
+            props.onFeatureUsed?.(`categories-tree-showall`);
+            void (0, CategoriesVisibilityUtils_1.showAllCategories)((props.filteredCategories ?? props.categories).map((category) => category.categoryId), props.viewport);
         }, children: (0, jsx_runtime_1.jsx)(itwinui_icons_react_1.SvgVisibilityShow, {}) }));
 }
 exports.ShowAllButton = ShowAllButton;
 /** @internal */
 function HideAllButton(props) {
-    return ((0, jsx_runtime_1.jsx)(itwinui_react_1.IconButton, { size: props.density === "enlarged" ? "large" : "small", styleType: "borderless", title: TreeWidget_1.TreeWidget.translate("hideAll"), onClick: () => {
-            props.onFeatureUsed?.(`${CategoriesTreeComponent_1.CategoriesTreeComponent.id}-hideall`);
-            void (0, CategoryVisibilityHandler_1.hideAllCategories)((props.filteredCategories ?? props.categories).map((category) => category.categoryId), props.viewport);
+    return ((0, jsx_runtime_1.jsx)(itwinui_react_1.IconButton, { size: props.density === "enlarged" ? "large" : "small", styleType: "borderless", title: TreeWidget_1.TreeWidget.translate("categoriesTree.buttons.hideAll.tooltip"), onClick: () => {
+            props.onFeatureUsed?.(`categories-tree-hideall`);
+            void (0, CategoriesVisibilityUtils_1.hideAllCategories)((props.filteredCategories ?? props.categories).map((category) => category.categoryId), props.viewport);
         }, children: (0, jsx_runtime_1.jsx)(itwinui_icons_react_1.SvgVisibilityHide, {}) }));
 }
 exports.HideAllButton = HideAllButton;
 /** @internal */
 function InvertAllButton(props) {
-    return ((0, jsx_runtime_1.jsx)(itwinui_react_1.IconButton, { title: TreeWidget_1.TreeWidget.translate("invert"), size: props.density === "enlarged" ? "large" : "small", styleType: "borderless", onClick: () => {
-            props.onFeatureUsed?.(`${CategoriesTreeComponent_1.CategoriesTreeComponent.id}-invert`);
-            void (0, CategoryVisibilityHandler_1.invertAllCategories)(props.filteredCategories ?? props.categories, props.viewport);
+    return ((0, jsx_runtime_1.jsx)(itwinui_react_1.IconButton, { title: TreeWidget_1.TreeWidget.translate("categoriesTree.buttons.invert.tooltip"), size: props.density === "enlarged" ? "large" : "small", styleType: "borderless", onClick: () => {
+            props.onFeatureUsed?.(`categories-tree-invert`);
+            void (0, CategoriesVisibilityUtils_1.invertAllCategories)(props.filteredCategories ?? props.categories, props.viewport);
         }, children: (0, jsx_runtime_1.jsx)(itwinui_icons_react_1.SvgVisibilityHalf, {}) }));
 }
 exports.InvertAllButton = InvertAllButton;

package/lib/cjs/components/trees/categories-tree/CategoriesTreeButtons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoriesTreeButtons.js","sourceRoot":"","sources":["../../../../../src/components/trees/categories-tree/CategoriesTreeButtons.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,oEAAqG;AACrG,wDAAkD;AAClD,oDAAiD;AACjD,mFAAgH;AAiBhH,gBAAgB;AAChB,SAAgB,aAAa,CAAC,KAAsC;IAClE,OAAO,CACL,uBAAC,0BAAU,IACT,IAAI,EAAE,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EACtD,SAAS,EAAC,YAAY,EACtB,KAAK,EAAE,uBAAU,CAAC,SAAS,CAAC,wCAAwC,CAAC,EACrE,OAAO,EAAE,GAAG,EAAE;YACZ,KAAK,CAAC,aAAa,EAAE,CAAC,yBAAyB,CAAC,CAAC;YACjD,KAAK,IAAA,6CAAiB,EACpB,CAAC,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EACrF,KAAK,CAAC,QAAQ,CACf,CAAC;QACJ,CAAC,YAED,uBAAC,uCAAiB,KAAG,GACV,CACd,CAAC;AACJ,CAAC;AAjBD,sCAiBC;AAED,gBAAgB;AAChB,SAAgB,aAAa,CAAC,KAAsC;IAClE,OAAO,CACL,uBAAC,0BAAU,IACT,IAAI,EAAE,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EACtD,SAAS,EAAC,YAAY,EACtB,KAAK,EAAE,uBAAU,CAAC,SAAS,CAAC,wCAAwC,CAAC,EACrE,OAAO,EAAE,GAAG,EAAE;YACZ,KAAK,CAAC,aAAa,EAAE,CAAC,yBAAyB,CAAC,CAAC;YACjD,KAAK,IAAA,6CAAiB,EACpB,CAAC,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EACrF,KAAK,CAAC,QAAQ,CACf,CAAC;QACJ,CAAC,YAED,uBAAC,uCAAiB,KAAG,GACV,CACd,CAAC;AACJ,CAAC;AAjBD,sCAiBC;AAED,gBAAgB;AAChB,SAAgB,eAAe,CAAC,KAAsC;IACpE,OAAO,CACL,uBAAC,0BAAU,IACT,KAAK,EAAE,uBAAU,CAAC,SAAS,CAAC,uCAAuC,CAAC,EACpE,IAAI,EAAE,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EACtD,SAAS,EAAC,YAAY,EACtB,OAAO,EAAE,GAAG,EAAE;YACZ,KAAK,CAAC,aAAa,EAAE,CAAC,wBAAwB,CAAC,CAAC;YAChD,KAAK,IAAA,+CAAmB,EAAC,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QACzF,CAAC,YAED,uBAAC,uCAAiB,KAAG,GACV,CACd,CAAC;AACJ,CAAC;AAdD,0CAcC","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 { SvgVisibilityHalf, SvgVisibilityHide, SvgVisibilityShow } from \"@itwin/itwinui-icons-react\";\nimport { IconButton } from \"@itwin/itwinui-react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { hideAllCategories, invertAllCategories, showAllCategories } from \"../common/CategoriesVisibilityUtils\";\n\nimport type { CategoryInfo } from \"../common/CategoriesVisibilityUtils\";\nimport type { TreeHeaderButtonProps } from \"../../tree-header/TreeHeader\";\n\n/**\n * Props that get passed to `CategoriesTreeComponent` header button renderer.\n * @see CategoriesTreeComponentProps.headerButtons\n * @public\n */\nexport interface CategoriesTreeHeaderButtonProps extends TreeHeaderButtonProps {\n  /** A list of categories available in the iModel */\n  categories: CategoryInfo[];\n  /** In case the tree is filtered, a list of filtered categories. */\n  filteredCategories?: CategoryInfo[];\n}\n\n/** @internal */\nexport function ShowAllButton(props: CategoriesTreeHeaderButtonProps) {\n  return (\n    <IconButton\n      size={props.density === \"enlarged\" ? \"large\" : \"small\"}\n      styleType=\"borderless\"\n      title={TreeWidget.translate(\"categoriesTree.buttons.showAll.tooltip\")}\n      onClick={() => {\n        props.onFeatureUsed?.(`categories-tree-showall`);\n        void showAllCategories(\n          (props.filteredCategories ?? props.categories).map((category) => category.categoryId),\n          props.viewport,\n        );\n      }}\n    >\n      <SvgVisibilityShow />\n    </IconButton>\n  );\n}\n\n/** @internal */\nexport function HideAllButton(props: CategoriesTreeHeaderButtonProps) {\n  return (\n    <IconButton\n      size={props.density === \"enlarged\" ? \"large\" : \"small\"}\n      styleType=\"borderless\"\n      title={TreeWidget.translate(\"categoriesTree.buttons.hideAll.tooltip\")}\n      onClick={() => {\n        props.onFeatureUsed?.(`categories-tree-hideall`);\n        void hideAllCategories(\n          (props.filteredCategories ?? props.categories).map((category) => category.categoryId),\n          props.viewport,\n        );\n      }}\n    >\n      <SvgVisibilityHide />\n    </IconButton>\n  );\n}\n\n/** @internal */\nexport function InvertAllButton(props: CategoriesTreeHeaderButtonProps) {\n  return (\n    <IconButton\n      title={TreeWidget.translate(\"categoriesTree.buttons.invert.tooltip\")}\n      size={props.density === \"enlarged\" ? \"large\" : \"small\"}\n      styleType=\"borderless\"\n      onClick={() => {\n        props.onFeatureUsed?.(`categories-tree-invert`);\n        void invertAllCategories(props.filteredCategories ?? props.categories, props.viewport);\n      }}\n    >\n      <SvgVisibilityHalf />\n    </IconButton>\n  );\n}\n"]}

package/lib/{esm/components/trees/category-tree → cjs/components/trees/categories-tree}/CategoriesTreeComponent.d.ts

@@ -1,13 +1,11 @@
-/// <reference types="react" />
-import "../VisibilityTreeBase.scss";
+import "../Tree.scss";
+import { CategoriesTree } from "./CategoriesTree";
 import { HideAllButton, InvertAllButton, ShowAllButton } from "./CategoriesTreeButtons";
+import type { ComponentPropsWithoutRef } from "react";
+import type { SelectionStorage } from "@itwin/presentation-hierarchies-react";
 import type { CategoriesTreeHeaderButtonProps } from "./CategoriesTreeButtons";
-import type { CategoryTreeProps } from "./CategoriesTree";
-/**
- * Props for [[CategoriesTreeComponent]].
- * @public
- */
-export interface CategoriesTreeComponentProps extends Omit<CategoryTreeProps, "iModel" | "activeView" | "width" | "height" | "filterInfo" | "onFilterApplied" | "categories" | "categoryVisibilityHandler" | "viewManager"> {
+type CategoriesTreeProps = ComponentPropsWithoutRef<typeof CategoriesTree>;
+interface CategoriesTreeComponentProps extends Pick<CategoriesTreeProps, "getSchemaContext" | "density" | "hierarchyLevelConfig" | "selectionMode" | "onPerformanceMeasured" | "onFeatureUsed"> {
     /**
      * Renderers of header buttons. Defaults to:
      * ```ts
@@ -19,10 +17,10 @@ export interface CategoriesTreeComponentProps extends Omit<CategoryTreeProps, "i
      * ```
      */
     headerButtons?: Array<(props: CategoriesTreeHeaderButtonProps) => React.ReactNode>;
+    selectionStorage: SelectionStorage;
 }
 /**
- * A component that renders [[CategoriesTree]] and a header with filtering capabilities
- * and header buttons.
+ * A component that renders `CategoriesTree` and a header with filtering capabilities and header buttons.
  * @public
  */
 export declare const CategoriesTreeComponent: {
@@ -43,14 +41,15 @@ export declare const CategoriesTreeComponent: {
      */
     InvertAllButton: typeof InvertAllButton;
     /**
-     * Id of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
+     * Id of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
      * @public
      */
     id: string;
     /**
-     * Label of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
+     * Label of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
      * @public
      */
     getLabel(): string;
 };
+export {};
 //# sourceMappingURL=CategoriesTreeComponent.d.ts.map

package/lib/cjs/components/trees/categories-tree/CategoriesTreeComponent.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CategoriesTreeComponent = void 0;
+const jsx_runtime_1 = require("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.
+ *--------------------------------------------------------------------------------------------*/
+require("../Tree.scss");
+const classnames_1 = __importDefault(require("classnames"));
+const react_1 = require("react");
+const appui_react_1 = require("@itwin/appui-react");
+const core_frontend_1 = require("@itwin/core-frontend");
+const presentation_hierarchies_react_1 = require("@itwin/presentation-hierarchies-react");
+const TreeWidget_1 = require("../../../TreeWidget");
+const TreeHeader_1 = require("../../tree-header/TreeHeader");
+const AutoSizer_1 = require("../../utils/AutoSizer");
+const UseFiltering_1 = require("../common/UseFiltering");
+const CategoriesTree_1 = require("./CategoriesTree");
+const CategoriesTreeButtons_1 = require("./CategoriesTreeButtons");
+const UseCategories_1 = require("./UseCategories");
+/**
+ * A component that renders `CategoriesTree` and a header with filtering capabilities and header buttons.
+ * @public
+ */
+const CategoriesTreeComponent = (props) => {
+    const iModel = (0, appui_react_1.useActiveIModelConnection)();
+    const viewport = (0, appui_react_1.useActiveViewport)();
+    if (!iModel || !viewport) {
+        return null;
+    }
+    return (0, jsx_runtime_1.jsx)(CategoriesTreeComponentImpl, { ...props, iModel: iModel, viewport: viewport });
+};
+exports.CategoriesTreeComponent = CategoriesTreeComponent;
+/**
+ * Renders a "Show all" button that enables display of all categories and their subcategories.
+ * @public
+ */
+exports.CategoriesTreeComponent.ShowAllButton = CategoriesTreeButtons_1.ShowAllButton;
+/**
+ * Renders a "Hide all" button that disables display of all categories.
+ * @public
+ */
+exports.CategoriesTreeComponent.HideAllButton = CategoriesTreeButtons_1.HideAllButton;
+/**
+ * Renders an "Invert all" button that inverts display of all categories.
+ * @public
+ */
+exports.CategoriesTreeComponent.InvertAllButton = CategoriesTreeButtons_1.InvertAllButton;
+/**
+ * Id of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
+ * @public
+ */
+exports.CategoriesTreeComponent.id = "categories-tree-v2";
+/**
+ * Label of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
+ * @public
+ */
+exports.CategoriesTreeComponent.getLabel = () => TreeWidget_1.TreeWidget.translate("categoriesTree.label");
+function CategoriesTreeComponentImpl({ iModel, viewport, headerButtons, selectionStorage, ...treeProps }) {
+    const categories = (0, UseCategories_1.useCategories)(core_frontend_1.IModelApp.viewManager, iModel, viewport);
+    const { filter, applyFilter, clearFilter } = (0, UseFiltering_1.useFiltering)();
+    const density = treeProps.density;
+    return ((0, jsx_runtime_1.jsx)("div", { className: (0, classnames_1.default)("tw-tree-with-header", density === "enlarged" && "enlarge"), children: (0, jsx_runtime_1.jsxs)(presentation_hierarchies_react_1.UnifiedSelectionProvider, { storage: selectionStorage, children: [(0, jsx_runtime_1.jsx)(TreeHeader_1.TreeHeader, { onFilterStart: applyFilter, onFilterClear: clearFilter, onSelectedChanged: () => { }, density: density, children: headerButtons
+                        ? headerButtons.map((btn, index) => (0, jsx_runtime_1.jsx)(react_1.Fragment, { children: btn({ viewport, categories, onFeatureUsed: treeProps.onFeatureUsed }) }, index))
+                        : [
+                            (0, jsx_runtime_1.jsx)(CategoriesTreeButtons_1.ShowAllButton, { viewport: viewport, categories: categories, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "show-all-btn"),
+                            (0, jsx_runtime_1.jsx)(CategoriesTreeButtons_1.HideAllButton, { viewport: viewport, categories: categories, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "hide-all-btn"),
+                            (0, jsx_runtime_1.jsx)(CategoriesTreeButtons_1.InvertAllButton, { viewport: viewport, categories: categories, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "invert-all-btn"),
+                        ] }), (0, jsx_runtime_1.jsx)("div", { className: "tw-tree-content", children: (0, jsx_runtime_1.jsx)(AutoSizer_1.AutoSizer, { children: ({ width, height }) => ((0, jsx_runtime_1.jsx)(CategoriesTree_1.CategoriesTree, { ...treeProps, imodel: iModel, categories: categories, activeView: viewport, width: width, height: height, filter: filter })) }) })] }) }));
+}
+//# sourceMappingURL=CategoriesTreeComponent.js.map

package/lib/cjs/components/trees/categories-tree/CategoriesTreeComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoriesTreeComponent.js","sourceRoot":"","sources":["../../../../../src/components/trees/categories-tree/CategoriesTreeComponent.tsx"],"names":[],"mappings":";;;;;;;AAAA;;;gGAGgG;AAEhG,wBAAsB;AACtB,4DAAoC;AACpC,iCAAiC;AACjC,oDAAkF;AAClF,wDAAiD;AACjD,0FAAiF;AACjF,oDAAiD;AACjD,6DAA0D;AAC1D,qDAAkD;AAClD,yDAAsD;AACtD,qDAAkD;AAClD,mEAAwF;AACxF,mDAAgD;AAyBhD;;;GAGG;AACI,MAAM,uBAAuB,GAAG,CAAC,KAAmC,EAAE,EAAE;IAC7E,MAAM,MAAM,GAAG,IAAA,uCAAyB,GAAE,CAAC;IAC3C,MAAM,QAAQ,GAAG,IAAA,+BAAiB,GAAE,CAAC;IAErC,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IAED,OAAO,uBAAC,2BAA2B,OAAK,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAI,CAAC;AACxF,CAAC,CAAC;AATW,QAAA,uBAAuB,2BASlC;AAEF;;;GAGG;AACH,+BAAuB,CAAC,aAAa,GAAG,qCAAa,CAAC;AAEtD;;;GAGG;AACH,+BAAuB,CAAC,aAAa,GAAG,qCAAa,CAAC;AAEtD;;;GAGG;AACH,+BAAuB,CAAC,eAAe,GAAG,uCAAe,CAAC;AAE1D;;;GAGG;AACH,+BAAuB,CAAC,EAAE,GAAG,oBAAoB,CAAC;AAElD;;;GAGG;AACH,+BAAuB,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,uBAAU,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAEtF,SAAS,2BAA2B,CAAC,EACnC,MAAM,EACN,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,GAAG,SAAS,EAC0E;IACtF,MAAM,UAAU,GAAG,IAAA,6BAAa,EAAC,yBAAS,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1E,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,IAAA,2BAAY,GAAE,CAAC;IAC5D,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;IAClC,OAAO,CACL,gCAAK,SAAS,EAAE,IAAA,oBAAU,EAAC,qBAAqB,EAAE,OAAO,KAAK,UAAU,IAAI,SAAS,CAAC,YACpF,wBAAC,yDAAwB,IAAC,OAAO,EAAE,gBAAgB,aACjD,uBAAC,uBAAU,IAAC,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,OAAO,EAAE,OAAO,YAC9G,aAAa;wBACZ,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,uBAAC,gBAAQ,cAAc,GAAG,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,CAAC,IAA7E,KAAK,CAAoF,CAAC;wBAC7I,CAAC,CAAC;4BACE,uBAAC,qCAAa,IAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAqB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAvE,cAAc,CAA6D;4BAC1I,uBAAC,qCAAa,IAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAqB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAvE,cAAc,CAA6D;4BAC1I,uBAAC,uCAAe,IAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAuB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAzE,gBAAgB,CAA6D;yBAC/I,GACM,EACb,gCAAK,SAAS,EAAC,iBAAiB,YAC9B,uBAAC,qBAAS,cACP,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CACtB,uBAAC,+BAAc,OAAK,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAI,CAC9I,GACS,GACR,IACmB,GACvB,CACP,CAAC;AACJ,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 \"../Tree.scss\";\nimport classNames from \"classnames\";\nimport { Fragment } from \"react\";\nimport { useActiveIModelConnection, useActiveViewport } from \"@itwin/appui-react\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { UnifiedSelectionProvider } from \"@itwin/presentation-hierarchies-react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { TreeHeader } from \"../../tree-header/TreeHeader\";\nimport { AutoSizer } from \"../../utils/AutoSizer\";\nimport { useFiltering } from \"../common/UseFiltering\";\nimport { CategoriesTree } from \"./CategoriesTree\";\nimport { HideAllButton, InvertAllButton, ShowAllButton } from \"./CategoriesTreeButtons\";\nimport { useCategories } from \"./UseCategories\";\n\nimport type { ComponentPropsWithoutRef } from \"react\";\nimport type { IModelConnection, ScreenViewport } from \"@itwin/core-frontend\";\nimport type { SelectionStorage } from \"@itwin/presentation-hierarchies-react\";\nimport type { CategoriesTreeHeaderButtonProps } from \"./CategoriesTreeButtons\";\n\ntype CategoriesTreeProps = ComponentPropsWithoutRef<typeof CategoriesTree>;\n\ninterface CategoriesTreeComponentProps\n  extends Pick<CategoriesTreeProps, \"getSchemaContext\" | \"density\" | \"hierarchyLevelConfig\" | \"selectionMode\" | \"onPerformanceMeasured\" | \"onFeatureUsed\"> {\n  /**\n   * Renderers of header buttons. Defaults to:\n   * ```ts\n   * [\n   *   CategoriesTreeComponent.ShowAllButton,\n   *   CategoriesTreeComponent.HideAllButton,\n   *   CategoriesTreeComponent.InvertAllButton,\n   * ]\n   * ```\n   */\n  headerButtons?: Array<(props: CategoriesTreeHeaderButtonProps) => React.ReactNode>;\n  selectionStorage: SelectionStorage;\n}\n\n/**\n * A component that renders `CategoriesTree` and a header with filtering capabilities and header buttons.\n * @public\n */\nexport const CategoriesTreeComponent = (props: CategoriesTreeComponentProps) => {\n  const iModel = useActiveIModelConnection();\n  const viewport = useActiveViewport();\n\n  if (!iModel || !viewport) {\n    return null;\n  }\n\n  return <CategoriesTreeComponentImpl {...props} iModel={iModel} viewport={viewport} />;\n};\n\n/**\n * Renders a \"Show all\" button that enables display of all categories and their subcategories.\n * @public\n */\nCategoriesTreeComponent.ShowAllButton = ShowAllButton;\n\n/**\n * Renders a \"Hide all\" button that disables display of all categories.\n * @public\n */\nCategoriesTreeComponent.HideAllButton = HideAllButton;\n\n/**\n * Renders an \"Invert all\" button that inverts display of all categories.\n * @public\n */\nCategoriesTreeComponent.InvertAllButton = InvertAllButton;\n\n/**\n * Id of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.\n * @public\n */\nCategoriesTreeComponent.id = \"categories-tree-v2\";\n\n/**\n * Label of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.\n * @public\n */\nCategoriesTreeComponent.getLabel = () => TreeWidget.translate(\"categoriesTree.label\");\n\nfunction CategoriesTreeComponentImpl({\n  iModel,\n  viewport,\n  headerButtons,\n  selectionStorage,\n  ...treeProps\n}: CategoriesTreeComponentProps & { iModel: IModelConnection; viewport: ScreenViewport }) {\n  const categories = useCategories(IModelApp.viewManager, iModel, viewport);\n  const { filter, applyFilter, clearFilter } = useFiltering();\n  const density = treeProps.density;\n  return (\n    <div className={classNames(\"tw-tree-with-header\", density === \"enlarged\" && \"enlarge\")}>\n      <UnifiedSelectionProvider storage={selectionStorage}>\n        <TreeHeader onFilterStart={applyFilter} onFilterClear={clearFilter} onSelectedChanged={() => {}} density={density}>\n          {headerButtons\n            ? headerButtons.map((btn, index) => <Fragment key={index}>{btn({ viewport, categories, onFeatureUsed: treeProps.onFeatureUsed })}</Fragment>)\n            : [\n                <ShowAllButton viewport={viewport} categories={categories} key=\"show-all-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                <HideAllButton viewport={viewport} categories={categories} key=\"hide-all-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                <InvertAllButton viewport={viewport} categories={categories} key=\"invert-all-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n              ]}\n        </TreeHeader>\n        <div className=\"tw-tree-content\">\n          <AutoSizer>\n            {({ width, height }) => (\n              <CategoriesTree {...treeProps} imodel={iModel} categories={categories} activeView={viewport} width={width} height={height} filter={filter} />\n            )}\n          </AutoSizer>\n        </div>\n      </UnifiedSelectionProvider>\n    </div>\n  );\n}\n"]}

package/lib/cjs/components/trees/{stateless/categories-tree → categories-tree}/CategoriesTreeDefinition.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CategoriesTreeDefinition = void 0;
 const presentation_hierarchies_1 = require("@itwin/presentation-hierarchies");
 const presentation_shared_1 = require("@itwin/presentation-shared");
+const MAX_FILTERING_INSTANCE_KEY_COUNT = 100;
 class CategoriesTreeDefinition {
     constructor(props) {
         this._impl = (0, presentation_hierarchies_1.createClassBasedHierarchyDefinition)({
@@ -165,9 +166,10 @@ async function createInstanceKeyPathsFromInstanceLabel(props) {
           IIF(c.ChildCount > 1, sc.ECInstanceId, NULL) AS SubcategoryId
         FROM RootCategories c
         JOIN SubCategoriesWithLabels sc ON sc.ParentId = c.ECInstanceId
-        WHERE sc.DisplayLabel LIKE '%' || ? || '%'
+        WHERE sc.DisplayLabel LIKE '%' || ? || '%' ESCAPE '\\'
+        LIMIT ${MAX_FILTERING_INSTANCE_KEY_COUNT + 1}
       `,
-        bindings: [{ type: "string", value: props.label }],
+        bindings: [{ type: "string", value: props.label.replace(/[%_\\]/g, "\\$&") }],
     }, { restartToken: "tree-widget/categories-tree/filter-by-label-query" });
     const paths = new Array();
     for await (const row of reader) {
@@ -175,6 +177,9 @@ async function createInstanceKeyPathsFromInstanceLabel(props) {
         row.SubcategoryId && path.push({ className: row.SubcategoryClass, id: row.SubcategoryId });
         paths.push(path);
     }
+    if (paths.length > MAX_FILTERING_INSTANCE_KEY_COUNT) {
+        throw new Error(`Filter matches more than ${MAX_FILTERING_INSTANCE_KEY_COUNT} items`);
+    }
     return paths;
 }
 //# sourceMappingURL=CategoriesTreeDefinition.js.map

package/lib/cjs/components/trees/categories-tree/CategoriesTreeDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoriesTreeDefinition.js","sourceRoot":"","sources":["../../../../../src/components/trees/categories-tree/CategoriesTreeDefinition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,8EAAqH;AACrH,oEAA8F;AAc9F,MAAM,gCAAgC,GAAG,GAAG,CAAC;AAa7C,MAAa,wBAAwB;IAKnC,YAAmB,KAAoC;QACrD,IAAI,CAAC,KAAK,GAAG,IAAA,8DAAmC,EAAC;YAC/C,uBAAuB,EAAE,KAAK,CAAC,YAAY;YAC3C,SAAS,EAAE;gBACT,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,kCAAkC,CAAC,EAAE,GAAG,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACzH,UAAU,EAAE;oBACV;wBACE,mBAAmB,EAAE,kBAAkB;wBACvC,WAAW,EAAE,KAAK,EAAE,YAAwD,EAAE,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC;qBAC3H;iBACF;aACF;SACF,CAAC,CAAC;QACH,IAAI,CAAC,mBAAmB,GAAG,IAAA,wDAA6B,EAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC;QAC/F,IAAI,CAAC,6BAA6B,GAAG,IAAA,+DAAyC,EAAC,EAAE,uBAAuB,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC;IAClI,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,KAAgC;QAChE,OAAO,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAEO,KAAK,CAAC,kCAAkC,CAAC,KAAgE;QAC/G,MAAM,EAAE,aAAa,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjF,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC;YAC/E,MAAM,EAAE,KAAK,CAAC,cAAc;YAC5B,YAAY,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE;SACzD,CAAC,CAAC;QACH,OAAO;YACL;gBACE,aAAa,EAAE,aAAa;gBAC5B,KAAK,EAAE;oBACL,KAAK,EAAE;;gBAED,MAAM,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;wBAClD,SAAS,EAAE,EAAE,QAAQ,EAAE,2BAAK,CAAC,8BAA8B,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE;wBAClF,YAAY,EAAE,EAAE,QAAQ,EAAE,mBAAmB,EAAE;wBAC/C,SAAS,EAAE;4BACT,QAAQ,EAAE,MAAM,IAAI,CAAC,6BAA6B,CAAC,kBAAkB,CAAC;gCACpE,UAAU,EAAE,MAAM;gCAClB,SAAS,EAAE,aAAa;6BACzB,CAAC;yBACH;wBACD,WAAW,EAAE;4BACX,QAAQ,EAAE;;;;;;;;;;mBAUT;yBACF;wBACD,YAAY,EAAE;4BACZ,WAAW,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE;yBAC9C;wBACD,iBAAiB,EAAE,IAAI;qBACxB,CAAC;mBACG,qBAAqB,CAAC,IAAI;cAC/B,qBAAqB,CAAC,KAAK;;;;;0CAKC,oBAAoB;gBAC9C,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,qBAAqB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE;WAC5E;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,EACnC,qBAAqB,EAAE,UAAU,EACjC,cAAc,GAC6B;QAC3C,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC;YAC/E,MAAM,EAAE,cAAc;YACtB,YAAY,EAAE,EAAE,QAAQ,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE;SACjE,CAAC,CAAC;QACH,OAAO;YACL;gBACE,aAAa,EAAE,qBAAqB;gBACpC,KAAK,EAAE;oBACL,KAAK,EAAE;;gBAED,MAAM,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;wBAClD,SAAS,EAAE,EAAE,QAAQ,EAAE,gBAAgB,EAAE;wBACzC,YAAY,EAAE,EAAE,QAAQ,EAAE,mBAAmB,EAAE;wBAC/C,SAAS,EAAE;4BACT,QAAQ,EAAE,MAAM,IAAI,CAAC,6BAA6B,CAAC,kBAAkB,CAAC;gCACpE,UAAU,EAAE,MAAM;gCAClB,SAAS,EAAE,qBAAqB;6BACjC,CAAC;yBACH;wBACD,YAAY,EAAE;4BACZ,UAAU,EAAE,EAAE,QAAQ,EAAE,gCAAgC,EAAE;yBAC3D;wBACD,iBAAiB,EAAE,KAAK;qBACzB,CAAC;mBACG,qBAAqB,CAAC,IAAI;cAC/B,qBAAqB,CAAC,KAAK;;0DAEiB,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBAC7E,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,qBAAqB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE;WAC5E;oBACD,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;iBAC9D;aACF;SACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,KAA2D;QACpG,MAAM,aAAa,GAAG,IAAA,+DAAyC,EAAC,EAAE,uBAAuB,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC;QACjH,OAAO,uCAAuC,CAAC,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AA3HD,4DA2HC;AAED,SAAS,gBAAgB,CAAC,QAAqB;IAC7C,OAAO,QAAQ,KAAK,IAAI;QACtB,CAAC,CAAC,EAAE,aAAa,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,4BAA4B,EAAE;QAClG,CAAC,CAAC,EAAE,aAAa,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,4BAA4B,EAAE,CAAC;AACvG,CAAC;AAED,KAAK,UAAU,uCAAuC,CACpD,KAAkH;IAElH,MAAM,EAAE,aAAa,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACjF,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,iBAAiB,CACjD;QACE,IAAI,EAAE;YACJ;;;;;iBAKS,aAAa;;;;;;wCAMU,oBAAoB;;UAElD;YACF;;;;;cAKM,MAAM,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC;gBAC7C,UAAU,EAAE,MAAM;gBAClB,SAAS,EAAE,qBAAqB;aACjC,CAAC;;;UAGJ;SACH;QACD,KAAK,EAAE;;;;;;;;;gBASG,gCAAgC,GAAG,CAAC;OAC7C;QACD,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;KAC9E,EACD,EAAE,YAAY,EAAE,mDAAmD,EAAE,CACtE,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,EAAgC,CAAC;IACxD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE;QAC9B,MAAM,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,aAAa,EAAE,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACpE,GAAG,CAAC,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,gBAAgB,EAAE,EAAE,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;QAC3F,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAClB;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,gCAAgC,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,4BAA4B,gCAAgC,QAAQ,CAAC,CAAC;KACvF;IACD,OAAO,KAAK,CAAC;AACf,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 { createClassBasedHierarchyDefinition, createNodesQueryClauseFactory } from \"@itwin/presentation-hierarchies\";\nimport { createBisInstanceLabelSelectClauseFactory, ECSql } from \"@itwin/presentation-shared\";\n\nimport type { ECClassHierarchyInspector, ECSchemaProvider, IInstanceLabelSelectClauseFactory } from \"@itwin/presentation-shared\";\nimport type {\n  DefineHierarchyLevelProps,\n  DefineInstanceNodeChildHierarchyLevelProps,\n  DefineRootHierarchyLevelProps,\n  HierarchyDefinition,\n  HierarchyLevelDefinition,\n  HierarchyNodeIdentifiersPath,\n  LimitingECSqlQueryExecutor,\n  NodesQueryClauseFactory,\n} from \"@itwin/presentation-hierarchies\";\n\nconst MAX_FILTERING_INSTANCE_KEY_COUNT = 100;\n\ninterface CategoriesTreeDefinitionProps {\n  imodelAccess: ECSchemaProvider & ECClassHierarchyInspector;\n  viewType: \"2d\" | \"3d\";\n}\n\ninterface CategoriesTreeInstanceKeyPathsFromInstanceLabelProps {\n  imodelAccess: ECClassHierarchyInspector & LimitingECSqlQueryExecutor;\n  label: string;\n  viewType: \"2d\" | \"3d\";\n}\n\nexport class CategoriesTreeDefinition implements HierarchyDefinition {\n  private _impl: HierarchyDefinition;\n  private _selectQueryFactory: NodesQueryClauseFactory;\n  private _nodeLabelSelectClauseFactory: IInstanceLabelSelectClauseFactory;\n\n  public constructor(props: CategoriesTreeDefinitionProps) {\n    this._impl = createClassBasedHierarchyDefinition({\n      classHierarchyInspector: props.imodelAccess,\n      hierarchy: {\n        rootNodes: async (requestProps) => this.createRootHierarchyLevelDefinition({ ...requestProps, viewType: props.viewType }),\n        childNodes: [\n          {\n            parentNodeClassName: \"BisCore.Category\",\n            definitions: async (requestProps: DefineInstanceNodeChildHierarchyLevelProps) => this.createSubcategoryQuery(requestProps),\n          },\n        ],\n      },\n    });\n    this._selectQueryFactory = createNodesQueryClauseFactory({ imodelAccess: props.imodelAccess });\n    this._nodeLabelSelectClauseFactory = createBisInstanceLabelSelectClauseFactory({ classHierarchyInspector: props.imodelAccess });\n  }\n\n  public async defineHierarchyLevel(props: DefineHierarchyLevelProps) {\n    return this._impl.defineHierarchyLevel(props);\n  }\n\n  private async createRootHierarchyLevelDefinition(props: DefineRootHierarchyLevelProps & { viewType: \"2d\" | \"3d\" }): Promise<HierarchyLevelDefinition> {\n    const { categoryClass, categoryElementClass } = getClassesByView(props.viewType);\n    const instanceFilterClauses = await this._selectQueryFactory.createFilterClauses({\n      filter: props.instanceFilter,\n      contentClass: { fullName: categoryClass, alias: \"this\" },\n    });\n    return [\n      {\n        fullClassName: categoryClass,\n        query: {\n          ecsql: `\n            SELECT\n              ${await this._selectQueryFactory.createSelectClause({\n                ecClassId: { selector: ECSql.createRawPropertyValueSelector(\"this\", \"ECClassId\") },\n                ecInstanceId: { selector: \"this.ECInstanceId\" },\n                nodeLabel: {\n                  selector: await this._nodeLabelSelectClauseFactory.createSelectClause({\n                    classAlias: \"this\",\n                    className: categoryClass,\n                  }),\n                },\n                hasChildren: {\n                  selector: `\n                    IFNULL((\n                      SELECT 1\n                      FROM (\n                        SELECT COUNT(1) AS ChildCount\n                        FROM BisCore.SubCategory sc\n                        WHERE sc.Parent.Id = this.ECInstanceId\n                      )\n                      WHERE ChildCount > 1\n                    ), 0)\n                  `,\n                },\n                extendedData: {\n                  description: { selector: \"this.Description\" },\n                },\n                supportsFiltering: true,\n              })}\n            FROM ${instanceFilterClauses.from} this\n            ${instanceFilterClauses.joins}\n            JOIN BisCore.Model m ON m.ECInstanceId = this.Model.Id\n            WHERE\n              NOT this.IsPrivate\n              AND (NOT m.IsPrivate OR m.ECClassId IS (BisCore.DictionaryModel))\n              AND EXISTS (SELECT 1 FROM ${categoryElementClass} e WHERE e.Category.Id = this.ECInstanceId)\n              ${instanceFilterClauses.where ? `AND ${instanceFilterClauses.where}` : \"\"}\n          `,\n        },\n      },\n    ];\n  }\n\n  private async createSubcategoryQuery({\n    parentNodeInstanceIds: elementIds,\n    instanceFilter,\n  }: DefineInstanceNodeChildHierarchyLevelProps): Promise<HierarchyLevelDefinition> {\n    const instanceFilterClauses = await this._selectQueryFactory.createFilterClauses({\n      filter: instanceFilter,\n      contentClass: { fullName: \"BisCore.SubCategory\", alias: \"this\" },\n    });\n    return [\n      {\n        fullClassName: \"BisCore.SubCategory\",\n        query: {\n          ecsql: `\n            SELECT\n              ${await this._selectQueryFactory.createSelectClause({\n                ecClassId: { selector: \"this.ECClassId\" },\n                ecInstanceId: { selector: \"this.ECInstanceId\" },\n                nodeLabel: {\n                  selector: await this._nodeLabelSelectClauseFactory.createSelectClause({\n                    classAlias: \"this\",\n                    className: \"BisCore.SubCategory\",\n                  }),\n                },\n                extendedData: {\n                  categoryId: { selector: \"printf('0x%x', this.Parent.Id)\" },\n                },\n                supportsFiltering: false,\n              })}\n            FROM ${instanceFilterClauses.from} this\n            ${instanceFilterClauses.joins}\n            WHERE\n              NOT this.IsPrivate AND this.Parent.Id IN (${elementIds.map(() => \"?\").join(\",\")})\n              ${instanceFilterClauses.where ? `AND ${instanceFilterClauses.where}` : \"\"}\n          `,\n          bindings: elementIds.map((id) => ({ type: \"id\", value: id })),\n        },\n      },\n    ];\n  }\n\n  public static async createInstanceKeyPaths(props: CategoriesTreeInstanceKeyPathsFromInstanceLabelProps) {\n    const labelsFactory = createBisInstanceLabelSelectClauseFactory({ classHierarchyInspector: props.imodelAccess });\n    return createInstanceKeyPathsFromInstanceLabel({ ...props, labelsFactory });\n  }\n}\n\nfunction getClassesByView(viewType: \"2d\" | \"3d\") {\n  return viewType === \"2d\"\n    ? { categoryClass: \"BisCore.DrawingCategory\", categoryElementClass: \"BisCore:GeometricElement2d\" }\n    : { categoryClass: \"BisCore.SpatialCategory\", categoryElementClass: \"BisCore:GeometricElement3d\" };\n}\n\nasync function createInstanceKeyPathsFromInstanceLabel(\n  props: CategoriesTreeInstanceKeyPathsFromInstanceLabelProps & { labelsFactory: IInstanceLabelSelectClauseFactory },\n) {\n  const { categoryClass, categoryElementClass } = getClassesByView(props.viewType);\n  const reader = props.imodelAccess.createQueryReader(\n    {\n      ctes: [\n        `RootCategories(ClassName, ECInstanceId, ChildCount) as (\n          SELECT\n            ec_classname(this.ECClassId, 's.c'),\n            this.ECInstanceId,\n            COUNT(sc.ECInstanceId)\n          FROM ${categoryClass} this\n          JOIN BisCore.Model m ON m.ECInstanceId = this.Model.Id\n          JOIN BisCore.SubCategory sc ON sc.Parent.Id = this.ECInstanceId\n          WHERE\n            NOT this.IsPrivate\n            AND (NOT m.IsPrivate OR m.ECClassId IS (BisCore.DictionaryModel))\n            AND EXISTS (SELECT 1 FROM ${categoryElementClass} e WHERE e.Category.Id = this.ECInstanceId)\n          GROUP BY this.ECInstanceId\n        )`,\n        `SubCategoriesWithLabels(ClassName, ECInstanceId, ParentId, DisplayLabel) as (\n          SELECT\n            ec_classname(this.ECClassId, 's.c'),\n            this.ECInstanceId,\n            this.Parent.Id,\n            ${await props.labelsFactory.createSelectClause({\n              classAlias: \"this\",\n              className: \"BisCore.SubCategory\",\n            })}\n          FROM BisCore.SubCategory this\n          WHERE NOT this.IsPrivate\n        )`,\n      ],\n      ecsql: `\n        SELECT\n          c.ClassName AS CategoryClass,\n          c.ECInstanceId AS CategoryId,\n          IIF(c.ChildCount > 1, sc.ClassName, NULL) AS SubcategoryClass,\n          IIF(c.ChildCount > 1, sc.ECInstanceId, NULL) AS SubcategoryId\n        FROM RootCategories c\n        JOIN SubCategoriesWithLabels sc ON sc.ParentId = c.ECInstanceId\n        WHERE sc.DisplayLabel LIKE '%' || ? || '%' ESCAPE '\\\\'\n        LIMIT ${MAX_FILTERING_INSTANCE_KEY_COUNT + 1}\n      `,\n      bindings: [{ type: \"string\", value: props.label.replace(/[%_\\\\]/g, \"\\\\$&\") }],\n    },\n    { restartToken: \"tree-widget/categories-tree/filter-by-label-query\" },\n  );\n  const paths = new Array<HierarchyNodeIdentifiersPath>();\n  for await (const row of reader) {\n    const path = [{ className: row.CategoryClass, id: row.CategoryId }];\n    row.SubcategoryId && path.push({ className: row.SubcategoryClass, id: row.SubcategoryId });\n    paths.push(path);\n  }\n  if (paths.length > MAX_FILTERING_INSTANCE_KEY_COUNT) {\n    throw new Error(`Filter matches more than ${MAX_FILTERING_INSTANCE_KEY_COUNT} items`);\n  }\n  return paths;\n}\n"]}

package/lib/cjs/components/trees/{stateless/categories-tree → categories-tree}/CategoriesVisibilityHandler.d.ts

@@ -1,9 +1,9 @@
 import { BeEvent } from "@itwin/core-bentley";
 import { HierarchyNode } from "@itwin/presentation-hierarchies";
-import type { CategoryInfo } from "../../category-tree/CategoriesTreeButtons";
-import type { VisibilityChangeListener, VisibilityStatus } from "../../VisibilityTreeEventHandler";
+import type { CategoryInfo } from "../common/CategoriesVisibilityUtils";
 import type { IModelConnection, ViewManager, Viewport } from "@itwin/core-frontend";
-interface StatelessCategoriesVisibilityHandlerProps {
+import type { HierarchyVisibilityHandler, VisibilityStatus } from "../common/UseHierarchyVisibility";
+interface CategoriesVisibilityHandlerProps {
     viewManager: ViewManager;
     imodel: IModelConnection;
     categories: CategoryInfo[];
@@ -11,15 +11,15 @@ interface StatelessCategoriesVisibilityHandlerProps {
     allViewports?: boolean;
 }
 /** @internal */
-export declare class StatelessCategoriesVisibilityHandler {
+export declare class CategoriesVisibilityHandler implements HierarchyVisibilityHandler {
     private _viewManager;
     private _imodel;
     private _pendingVisibilityChange;
     private _viewport;
     private _useAllViewports;
-    constructor(props: StatelessCategoriesVisibilityHandlerProps);
+    constructor(props: CategoriesVisibilityHandlerProps);
     dispose(): void;
-    onVisibilityChange: BeEvent<VisibilityChangeListener>;
+    onVisibilityChange: BeEvent<import("@itwin/core-bentley").Listener>;
     /** Returns visibility status of the tree node. */
     getVisibilityStatus(node: HierarchyNode): Promise<VisibilityStatus> | VisibilityStatus;
     changeVisibility(node: HierarchyNode, on: boolean): Promise<void>;

package/lib/cjs/components/trees/{stateless/categories-tree → categories-tree}/CategoriesVisibilityHandler.js

@@ -4,12 +4,12 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatelessCategoriesVisibilityHandler = void 0;
+exports.CategoriesVisibilityHandler = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const presentation_hierarchies_1 = require("@itwin/presentation-hierarchies");
-const CategoriesVisibilityUtils_1 = require("../../CategoriesVisibilityUtils");
+const CategoriesVisibilityUtils_1 = require("../common/CategoriesVisibilityUtils");
 /** @internal */
-class StatelessCategoriesVisibilityHandler {
+class CategoriesVisibilityHandler {
     constructor(props) {
         this.onVisibilityChange = new core_bentley_1.BeEvent();
         // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -46,7 +46,7 @@ class StatelessCategoriesVisibilityHandler {
         }
         // handle subcategory visibility change
         if (node.parentKeys.length) {
-            const childId = StatelessCategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
+            const childId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
             const parentCategoryId = node.extendedData?.categoryId;
             // make sure parent category is enabled
             if (on && parentCategoryId) {
@@ -55,7 +55,7 @@ class StatelessCategoriesVisibilityHandler {
             this.enableSubCategory(childId, on);
             return;
         }
-        const instanceId = StatelessCategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
+        const instanceId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
         await this.enableCategory([instanceId], on, true);
     }
     getSubCategoryVisibility(node) {
@@ -63,12 +63,12 @@ class StatelessCategoriesVisibilityHandler {
         if (!parentCategoryId) {
             return "hidden";
         }
-        const subcategoryId = StatelessCategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
+        const subcategoryId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
         const isVisible = this._viewport.view.viewsCategory(parentCategoryId) && this._viewport.isSubCategoryVisible(subcategoryId);
         return isVisible ? "visible" : "hidden";
     }
     getCategoryVisibility(node) {
-        const instanceId = StatelessCategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
+        const instanceId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);
         return this._viewport.view.viewsCategory(instanceId) ? "visible" : "hidden";
     }
     onVisibilityChangeInternal() {
@@ -84,11 +84,11 @@ class StatelessCategoriesVisibilityHandler {
         return presentation_hierarchies_1.HierarchyNode.isInstancesNode(node) && node.key.instanceKeys.length > 0 ? node.key.instanceKeys[0].id : /* istanbul ignore next */ "";
     }
     async enableCategory(ids, enabled, enableAllSubCategories = true) {
-        await (0, CategoriesVisibilityUtils_1.enableCategory)(this._viewManager, this._imodel, ids, enabled, this._useAllViewports, enableAllSubCategories);
+        await (0, CategoriesVisibilityUtils_1.enableCategoryDisplay)(this._viewManager, this._imodel, ids, enabled, this._useAllViewports, enableAllSubCategories);
     }
     enableSubCategory(key, enabled) {
-        (0, CategoriesVisibilityUtils_1.enableSubCategory)(this._viewManager, key, enabled, this._useAllViewports);
+        (0, CategoriesVisibilityUtils_1.enableSubCategoryDisplay)(this._viewManager, key, enabled, this._useAllViewports);
     }
 }
-exports.StatelessCategoriesVisibilityHandler = StatelessCategoriesVisibilityHandler;
+exports.CategoriesVisibilityHandler = CategoriesVisibilityHandler;
 //# sourceMappingURL=CategoriesVisibilityHandler.js.map

package/lib/cjs/components/trees/categories-tree/CategoriesVisibilityHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoriesVisibilityHandler.js","sourceRoot":"","sources":["../../../../../src/components/trees/categories-tree/CategoriesVisibilityHandler.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAA8C;AAC9C,8EAAgE;AAChE,mFAAsG;AActG,gBAAgB;AAChB,MAAa,2BAA2B;IAOtC,YAAY,KAAuC;QAgB5C,uBAAkB,GAAG,IAAI,sBAAO,EAAE,CAAC;QAiD1C,gEAAgE;QACxD,0BAAqB,GAAG,GAAG,EAAE;YACnC,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACpC,CAAC,CAAC;QAEF,gEAAgE;QACxD,8BAAyB,GAAG,GAAG,EAAE;YACvC,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACpC,CAAC,CAAC;QAxEA,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,uBAAuB;QACvB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC;QACpD,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC7E,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACvF,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,cAAc,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAChF,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,cAAc,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACxF,YAAY,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAC9C,CAAC;IAID,kDAAkD;IAC3C,mBAAmB,CAAC,IAAmB;QAC5C,IAAI,CAAC,wCAAa,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;YACxC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC9C;QACD,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;IACpH,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAmB,EAAE,EAAW;QAC5D,IAAI,CAAC,wCAAa,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;YACxC,OAAO;SACR;QAED,uCAAuC;QACvC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YAC1B,MAAM,OAAO,GAAG,2BAA2B,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;YACjF,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC;YAEvD,uCAAuC;YACvC,IAAI,EAAE,IAAI,gBAAgB,EAAE;gBAC1B,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;aAC5D;YAED,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACpC,OAAO;SACR;QAED,MAAM,UAAU,GAAG,2BAA2B,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QACpF,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAEM,wBAAwB,CAAC,IAAmB;QACjD,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC;QACvD,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO,QAAQ,CAAC;SACjB;QAED,MAAM,aAAa,GAAG,2BAA2B,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QACvF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAC5H,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC1C,CAAC;IAEM,qBAAqB,CAAC,IAAmB;QAC9C,MAAM,UAAU,GAAG,2BAA2B,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC9E,CAAC;IAYO,0BAA0B;QAChC,IAAI,IAAI,CAAC,wBAAwB,EAAE;YACjC,OAAO;SACR;QAED,IAAI,CAAC,wBAAwB,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9C,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;QAC5C,CAAC,EAAE,CAAC,CAAC,CAAC;IACR,CAAC;IAEM,MAAM,CAAC,8BAA8B,CAAC,IAAmB;QAC9D,OAAO,wCAAa,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC;IAC/I,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,GAAa,EAAE,OAAgB,EAAE,sBAAsB,GAAG,IAAI;QACxF,MAAM,IAAA,iDAAqB,EAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;IAC5H,CAAC;IAEM,iBAAiB,CAAC,GAAW,EAAE,OAAgB;QACpD,IAAA,oDAAwB,EAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACnF,CAAC;CACF;AAxGD,kEAwGC","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 { BeEvent } from \"@itwin/core-bentley\";\nimport { HierarchyNode } from \"@itwin/presentation-hierarchies\";\nimport { enableCategoryDisplay, enableSubCategoryDisplay } from \"../common/CategoriesVisibilityUtils\";\n\nimport type { CategoryInfo } from \"../common/CategoriesVisibilityUtils\";\nimport type { IModelConnection, ViewManager, Viewport } from \"@itwin/core-frontend\";\nimport type { HierarchyVisibilityHandler, VisibilityStatus } from \"../common/UseHierarchyVisibility\";\n\ninterface CategoriesVisibilityHandlerProps {\n  viewManager: ViewManager;\n  imodel: IModelConnection;\n  categories: CategoryInfo[];\n  viewport: Viewport;\n  allViewports?: boolean;\n}\n\n/** @internal */\nexport class CategoriesVisibilityHandler implements HierarchyVisibilityHandler {\n  private _viewManager: ViewManager;\n  private _imodel: IModelConnection;\n  private _pendingVisibilityChange: any | undefined;\n  private _viewport: Viewport;\n  private _useAllViewports: boolean;\n\n  constructor(props: CategoriesVisibilityHandlerProps) {\n    this._viewManager = props.viewManager;\n    this._imodel = props.imodel;\n    this._viewport = props.viewport;\n    // istanbul ignore next\n    this._useAllViewports = props.allViewports ?? false;\n    this._viewport.onDisplayStyleChanged.addListener(this.onDisplayStyleChanged);\n    this._viewport.onViewedCategoriesChanged.addListener(this.onViewedCategoriesChanged);\n  }\n\n  public dispose() {\n    this._viewport.onDisplayStyleChanged.removeListener(this.onDisplayStyleChanged);\n    this._viewport.onViewedCategoriesChanged.removeListener(this.onViewedCategoriesChanged);\n    clearTimeout(this._pendingVisibilityChange);\n  }\n\n  public onVisibilityChange = new BeEvent();\n\n  /** Returns visibility status of the tree node. */\n  public getVisibilityStatus(node: HierarchyNode): Promise<VisibilityStatus> | VisibilityStatus {\n    if (!HierarchyNode.isInstancesNode(node)) {\n      return { state: \"hidden\", isDisabled: true };\n    }\n    return { state: node.parentKeys.length ? this.getSubCategoryVisibility(node) : this.getCategoryVisibility(node) };\n  }\n\n  public async changeVisibility(node: HierarchyNode, on: boolean) {\n    if (!HierarchyNode.isInstancesNode(node)) {\n      return;\n    }\n\n    // handle subcategory visibility change\n    if (node.parentKeys.length) {\n      const childId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);\n      const parentCategoryId = node.extendedData?.categoryId;\n\n      // make sure parent category is enabled\n      if (on && parentCategoryId) {\n        await this.enableCategory([parentCategoryId], true, false);\n      }\n\n      this.enableSubCategory(childId, on);\n      return;\n    }\n\n    const instanceId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);\n    await this.enableCategory([instanceId], on, true);\n  }\n\n  public getSubCategoryVisibility(node: HierarchyNode) {\n    const parentCategoryId = node.extendedData?.categoryId;\n    if (!parentCategoryId) {\n      return \"hidden\";\n    }\n\n    const subcategoryId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);\n    const isVisible = this._viewport.view.viewsCategory(parentCategoryId) && this._viewport.isSubCategoryVisible(subcategoryId);\n    return isVisible ? \"visible\" : \"hidden\";\n  }\n\n  public getCategoryVisibility(node: HierarchyNode) {\n    const instanceId = CategoriesVisibilityHandler.getInstanceIdFromHierarchyNode(node);\n    return this._viewport.view.viewsCategory(instanceId) ? \"visible\" : \"hidden\";\n  }\n\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  private onDisplayStyleChanged = () => {\n    this.onVisibilityChangeInternal();\n  };\n\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  private onViewedCategoriesChanged = () => {\n    this.onVisibilityChangeInternal();\n  };\n\n  private onVisibilityChangeInternal() {\n    if (this._pendingVisibilityChange) {\n      return;\n    }\n\n    this._pendingVisibilityChange = setTimeout(() => {\n      this.onVisibilityChange.raiseEvent();\n      this._pendingVisibilityChange = undefined;\n    }, 0);\n  }\n\n  public static getInstanceIdFromHierarchyNode(node: HierarchyNode) {\n    return HierarchyNode.isInstancesNode(node) && node.key.instanceKeys.length > 0 ? node.key.instanceKeys[0].id : /* istanbul ignore next */ \"\";\n  }\n\n  public async enableCategory(ids: string[], enabled: boolean, enableAllSubCategories = true) {\n    await enableCategoryDisplay(this._viewManager, this._imodel, ids, enabled, this._useAllViewports, enableAllSubCategories);\n  }\n\n  public enableSubCategory(key: string, enabled: boolean) {\n    enableSubCategoryDisplay(this._viewManager, key, enabled, this._useAllViewports);\n  }\n}\n"]}

package/lib/cjs/components/trees/categories-tree/UseCategories.d.ts

@@ -0,0 +1,8 @@
+import type { IModelConnection, ViewManager, Viewport } from "@itwin/core-frontend";
+import type { CategoryInfo } from "../common/CategoriesVisibilityUtils";
+/**
+ * Loads categories from viewport or uses provided list of categories.
+ * @internal
+ */
+export declare function useCategories(viewManager: ViewManager, imodel: IModelConnection, view?: Viewport): CategoryInfo[];
+//# sourceMappingURL=UseCategories.d.ts.map

package/lib/cjs/components/trees/categories-tree/UseCategories.js

@@ -0,0 +1,22 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCategories = void 0;
+const react_1 = require("react");
+const components_react_1 = require("@itwin/components-react");
+const CategoriesVisibilityUtils_1 = require("../common/CategoriesVisibilityUtils");
+const EMPTY_CATEGORIES_ARRAY = [];
+/**
+ * Loads categories from viewport or uses provided list of categories.
+ * @internal
+ */
+function useCategories(viewManager, imodel, view) {
+    const currentView = view || viewManager.getFirstOpenView();
+    const categoriesPromise = (0, react_1.useMemo)(async () => (0, CategoriesVisibilityUtils_1.loadCategoriesFromViewport)(imodel, currentView), [imodel, currentView]);
+    return (0, components_react_1.useAsyncValue)(categoriesPromise) ?? EMPTY_CATEGORIES_ARRAY;
+}
+exports.useCategories = useCategories;
+//# sourceMappingURL=UseCategories.js.map

package/lib/cjs/components/trees/categories-tree/UseCategories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseCategories.js","sourceRoot":"","sources":["../../../../../src/components/trees/categories-tree/UseCategories.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,iCAAgC;AAChC,8DAAwD;AACxD,mFAAiF;AAKjF,MAAM,sBAAsB,GAAmB,EAAE,CAAC;AAElD;;;GAGG;AACH,SAAgB,aAAa,CAAC,WAAwB,EAAE,MAAwB,EAAE,IAAe;IAC/F,MAAM,WAAW,GAAG,IAAI,IAAI,WAAW,CAAC,gBAAgB,EAAE,CAAC;IAC3D,MAAM,iBAAiB,GAAG,IAAA,eAAO,EAAC,KAAK,IAAI,EAAE,CAAC,IAAA,sDAA0B,EAAC,MAAM,EAAE,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IACtH,OAAO,IAAA,gCAAa,EAAC,iBAAiB,CAAC,IAAI,sBAAsB,CAAC;AACpE,CAAC;AAJD,sCAIC","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 { useMemo } from \"react\";\nimport { useAsyncValue } from \"@itwin/components-react\";\nimport { loadCategoriesFromViewport } from \"../common/CategoriesVisibilityUtils\";\n\nimport type { IModelConnection, ViewManager, Viewport } from \"@itwin/core-frontend\";\nimport type { CategoryInfo } from \"../common/CategoriesVisibilityUtils\";\n\nconst EMPTY_CATEGORIES_ARRAY: CategoryInfo[] = [];\n\n/**\n * Loads categories from viewport or uses provided list of categories.\n * @internal\n */\nexport function useCategories(viewManager: ViewManager, imodel: IModelConnection, view?: Viewport) {\n  const currentView = view || viewManager.getFirstOpenView();\n  const categoriesPromise = useMemo(async () => loadCategoriesFromViewport(imodel, currentView), [imodel, currentView]);\n  return useAsyncValue(categoriesPromise) ?? EMPTY_CATEGORIES_ARRAY;\n}\n"]}

package/lib/cjs/components/trees/common/CategoriesVisibilityUtils.d.ts

@@ -0,0 +1,46 @@
+import type { IModelConnection, ViewManager, Viewport } from "@itwin/core-frontend";
+/**
+ * Data structure that describes category.
+ */
+export interface CategoryInfo {
+    categoryId: string;
+    subCategoryIds?: string[];
+}
+/**
+ * Toggles visibility of categories to show or hide.
+ * @internal
+ */
+export declare function toggleAllCategories(viewManager: ViewManager, imodel: IModelConnection, display: boolean, viewport?: Viewport, forAllViewports?: boolean): Promise<void>;
+/**
+ * Gets ids of all categories from specified imodel and viewport.
+ * @internal
+ */
+export declare function getCategories(imodel: IModelConnection, viewport?: Viewport): Promise<string[]>;
+/**
+ * Changes category display in the viewport.
+ * @internal
+ */
+export declare function enableCategoryDisplay(viewManager: ViewManager, imodel: IModelConnection, ids: string[], enabled: boolean, forAllViewports: boolean, enableAllSubCategories?: boolean): Promise<void>;
+/**
+ * Changes subcategory display in the viewport
+ * @internal
+ */
+export declare function enableSubCategoryDisplay(viewManager: ViewManager, key: string, enabled: boolean, forAllViewports?: boolean): void;
+/** @internal */
+export declare function loadCategoriesFromViewport(iModel?: IModelConnection, vp?: Viewport): Promise<CategoryInfo[]>;
+/**
+ * Enable display of all given categories.
+ * @public
+ */
+export declare function showAllCategories(categories: string[], viewport: Viewport): Promise<void>;
+/**
+ * Disable display of all given categories.
+ * @public
+ */
+export declare function hideAllCategories(categories: string[], viewport: Viewport): Promise<void>;
+/**
+ * Invert display of all given categories.
+ * @public
+ */
+export declare function invertAllCategories(categories: CategoryInfo[], viewport: Viewport): Promise<void>;
+//# sourceMappingURL=CategoriesVisibilityUtils.d.ts.map