@itwin/appui-react 3.0.0-dev.100

package/lib/cjs/appui-react/imodel-components/VisibilityTreeRenderer.js

@@ -0,0 +1,65 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisibilityTreeNoFilteredData = exports.useVisibilityTreeFiltering = exports.visibilityTreeNodeCheckboxRenderer = exports.createVisibilityTreeNodeRenderer = exports.useVisibilityTreeRenderer = void 0;
+const React = require("react");
+const presentation_components_1 = require("@itwin/presentation-components");
+const components_react_1 = require("@itwin/components-react");
+const core_react_1 = require("@itwin/core-react");
+/**
+ * Creates Visibility tree renderer which renders nodes with eye checkbox.
+ * @alpha
+ */
+const useVisibilityTreeRenderer = (iconsEnabled, descriptionsEnabled) => {
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const nodeRenderer = React.useCallback((0, exports.createVisibilityTreeNodeRenderer)(iconsEnabled, descriptionsEnabled), [iconsEnabled, descriptionsEnabled]);
+    return React.useCallback((props) => (React.createElement(components_react_1.TreeRenderer, { ...props, nodeRenderer: nodeRenderer })), [nodeRenderer]);
+};
+exports.useVisibilityTreeRenderer = useVisibilityTreeRenderer;
+const imageLoader = new components_react_1.TreeImageLoader();
+/**
+ * Creates node renderer which renders node with eye checkbox.
+ * @alpha
+ */
+const createVisibilityTreeNodeRenderer = (iconsEnabled, descriptionEnabled) => {
+    return (props) => ( // eslint-disable-line react/display-name
+    React.createElement(components_react_1.TreeNodeRenderer, { ...props, checkboxRenderer: exports.visibilityTreeNodeCheckboxRenderer, descriptionEnabled: descriptionEnabled, imageLoader: iconsEnabled ? imageLoader : undefined, className: "with-checkbox" }));
+};
+exports.createVisibilityTreeNodeRenderer = createVisibilityTreeNodeRenderer;
+/**
+ * Checkbox renderer that renders an eye.
+ * @alpha
+ */
+const visibilityTreeNodeCheckboxRenderer = (props) => (React.createElement(core_react_1.ImageCheckBox, { checked: props.checked, disabled: props.disabled, imageOn: "icon-visibility", imageOff: "icon-visibility-hide-2", onClick: props.onChange, tooltip: props.title }));
+exports.visibilityTreeNodeCheckboxRenderer = visibilityTreeNodeCheckboxRenderer;
+/**
+ * Filters data provider used in supplied node loader and invokes onFilterApplied when filtering is completed.
+ * @alpha
+ */
+const useVisibilityTreeFiltering = (nodeLoader, filterInfo, onFilterApplied) => {
+    const { filter, activeMatchIndex } = filterInfo !== null && filterInfo !== void 0 ? filterInfo : { filter: undefined, activeMatchIndex: undefined };
+    const { filteredNodeLoader, isFiltering, matchesCount, nodeHighlightingProps, } = (0, presentation_components_1.useControlledPresentationTreeFiltering)({ nodeLoader, filter, activeMatchIndex });
+    React.useEffect(() => {
+        if (filter && matchesCount !== undefined && filteredNodeLoader !== nodeLoader)
+            onFilterApplied && onFilterApplied(filteredNodeLoader.dataProvider, matchesCount);
+    }, [filter, matchesCount, nodeLoader, filteredNodeLoader, onFilterApplied]);
+    return { filteredNodeLoader, isFiltering, nodeHighlightingProps };
+};
+exports.useVisibilityTreeFiltering = useVisibilityTreeFiltering;
+/**
+ * Renders message that no nodes was found for filter.
+ * @alpha
+ */
+function VisibilityTreeNoFilteredData(props) {
+    return (React.createElement("div", { className: "components-tree-errormessage" },
+        React.createElement("span", { className: "errormessage-header" }, props.title),
+        React.createElement("span", { className: "errormessage-body" }, props.message)));
+}
+exports.VisibilityTreeNoFilteredData = VisibilityTreeNoFilteredData;
+//# sourceMappingURL=VisibilityTreeRenderer.js.map

package/lib/cjs/appui-react/imodel-components/VisibilityTreeRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VisibilityTreeRenderer.js","sourceRoot":"","sources":["../../../../src/appui-react/imodel-components/VisibilityTreeRenderer.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,4EAAuH;AACvH,8DAEiC;AACjC,kDAA2E;AAG3E;;;GAGG;AACI,MAAM,yBAAyB,GAAG,CAAC,YAAqB,EAAE,mBAA4B,EAAE,EAAE;IAC/F,uDAAuD;IACvD,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC,IAAA,wCAAgC,EAAC,YAAY,EAAE,mBAAmB,CAAC,EAAE,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACjJ,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,KAAwB,EAAE,EAAE,CAAC,CACrD,oBAAC,+BAAY,OACP,KAAK,EACT,YAAY,EAAE,YAAY,GAC1B,CACH,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;AACrB,CAAC,CAAC;AATW,QAAA,yBAAyB,6BASpC;AAEF,MAAM,WAAW,GAAG,IAAI,kCAAe,EAAE,CAAC;AAC1C;;;GAGG;AACI,MAAM,gCAAgC,GAAG,CAAC,YAAqB,EAAE,kBAA2B,EAAE,EAAE;IACrG,OAAO,CAAC,KAA4B,EAAE,EAAE,CAAC,EAAE,yCAAyC;IAClF,oBAAC,mCAAgB,OACX,KAAK,EACT,gBAAgB,EAAE,0CAAkC,EACpD,kBAAkB,EAAE,kBAAkB,EACtC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,EACnD,SAAS,EAAC,eAAe,GACzB,CACH,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,gCAAgC,oCAU3C;AAEF;;;GAGG;AACI,MAAM,kCAAkC,GAAG,CAAC,KAA8B,EAAE,EAAE,CAAC,CACpF,oBAAC,0BAAa,IACZ,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,OAAO,EAAC,iBAAiB,EACzB,QAAQ,EAAC,wBAAwB,EACjC,OAAO,EAAE,KAAK,CAAC,QAAQ,EACvB,OAAO,EAAE,KAAK,CAAC,KAAK,GACpB,CACH,CAAC;AATW,QAAA,kCAAkC,sCAS7C;AAEF;;;GAGG;AACI,MAAM,0BAA0B,GAAG,CACxC,UAA6E,EAC7E,UAAqC,EACrC,eAAqG,EACrG,EAAE;IACF,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC;IACtG,MAAM,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,qBAAqB,GACtB,GAAG,IAAA,gEAAsC,EAAC,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAErF,KAAK,CAAC,SAAS,CACb,GAAG,EAAE;QACH,IAAI,MAAM,IAAI,YAAY,KAAK,SAAS,IAAI,kBAAkB,KAAK,UAAU;YAC3E,eAAe,IAAI,eAAe,CAAC,kBAAkB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC,EACD,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,CAAC,CACxE,CAAC;IAEF,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,qBAAqB,EAAE,CAAC;AACpE,CAAC,CAAC;AAtBW,QAAA,0BAA0B,8BAsBrC;AAWF;;;GAGG;AACH,SAAgB,4BAA4B,CAAC,KAAwC;IACnF,OAAO,CACL,6BAAK,SAAS,EAAC,8BAA8B;QAC3C,8BAAM,SAAS,EAAC,qBAAqB,IAAE,KAAK,CAAC,KAAK,CAAQ;QAC1D,8BAAM,SAAS,EAAC,mBAAmB,IAAE,KAAK,CAAC,OAAO,CAAQ,CACtD,CACP,CAAC;AACJ,CAAC;AAPD,oEAOC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModelComponents\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { IPresentationTreeDataProvider, useControlledPresentationTreeFiltering } from \"@itwin/presentation-components\";\r\nimport {\r\n  AbstractTreeNodeLoaderWithProvider, TreeImageLoader, TreeNodeRenderer, TreeNodeRendererProps, TreeRenderer, TreeRendererProps,\r\n} from \"@itwin/components-react\";\r\nimport { ImageCheckBox, NodeCheckboxRenderProps } from \"@itwin/core-react\";\r\nimport { VisibilityTreeFilterInfo } from \"./Common\";\r\n\r\n/**\r\n * Creates Visibility tree renderer which renders nodes with eye checkbox.\r\n * @alpha\r\n */\r\nexport const useVisibilityTreeRenderer = (iconsEnabled: boolean, descriptionsEnabled: boolean) => {\r\n  // eslint-disable-next-line react-hooks/exhaustive-deps\r\n  const nodeRenderer = React.useCallback(createVisibilityTreeNodeRenderer(iconsEnabled, descriptionsEnabled), [iconsEnabled, descriptionsEnabled]);\r\n  return React.useCallback((props: TreeRendererProps) => (\r\n    <TreeRenderer\r\n      {...props}\r\n      nodeRenderer={nodeRenderer}\r\n    />\r\n  ), [nodeRenderer]);\r\n};\r\n\r\nconst imageLoader = new TreeImageLoader();\r\n/**\r\n * Creates node renderer which renders node with eye checkbox.\r\n * @alpha\r\n */\r\nexport const createVisibilityTreeNodeRenderer = (iconsEnabled: boolean, descriptionEnabled: boolean) => {\r\n  return (props: TreeNodeRendererProps) => ( // eslint-disable-line react/display-name\r\n    <TreeNodeRenderer\r\n      {...props}\r\n      checkboxRenderer={visibilityTreeNodeCheckboxRenderer}\r\n      descriptionEnabled={descriptionEnabled}\r\n      imageLoader={iconsEnabled ? imageLoader : undefined}\r\n      className=\"with-checkbox\"\r\n    />\r\n  );\r\n};\r\n\r\n/**\r\n * Checkbox renderer that renders an eye.\r\n * @alpha\r\n */\r\nexport const visibilityTreeNodeCheckboxRenderer = (props: NodeCheckboxRenderProps) => (\r\n  <ImageCheckBox\r\n    checked={props.checked}\r\n    disabled={props.disabled}\r\n    imageOn=\"icon-visibility\"\r\n    imageOff=\"icon-visibility-hide-2\"\r\n    onClick={props.onChange}\r\n    tooltip={props.title}\r\n  />\r\n);\r\n\r\n/**\r\n * Filters data provider used in supplied node loader and invokes onFilterApplied when filtering is completed.\r\n * @alpha\r\n */\r\nexport const useVisibilityTreeFiltering = (\r\n  nodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>,\r\n  filterInfo?: VisibilityTreeFilterInfo,\r\n  onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void,\r\n) => {\r\n  const { filter, activeMatchIndex } = filterInfo ?? { filter: undefined, activeMatchIndex: undefined };\r\n  const {\r\n    filteredNodeLoader,\r\n    isFiltering,\r\n    matchesCount,\r\n    nodeHighlightingProps,\r\n  } = useControlledPresentationTreeFiltering({ nodeLoader, filter, activeMatchIndex });\r\n\r\n  React.useEffect(\r\n    () => {\r\n      if (filter && matchesCount !== undefined && filteredNodeLoader !== nodeLoader)\r\n        onFilterApplied && onFilterApplied(filteredNodeLoader.dataProvider, matchesCount);\r\n    },\r\n    [filter, matchesCount, nodeLoader, filteredNodeLoader, onFilterApplied],\r\n  );\r\n\r\n  return { filteredNodeLoader, isFiltering, nodeHighlightingProps };\r\n};\r\n\r\n/**\r\n * Properties for [[VisibilityTreeNoFilteredData]] component.\r\n * @alpha\r\n */\r\nexport interface VisibilityTreeNoFilteredDataProps {\r\n  title: string;\r\n  message: string;\r\n}\r\n\r\n/**\r\n * Renders message that no nodes was found for filter.\r\n * @alpha\r\n */\r\nexport function VisibilityTreeNoFilteredData(props: VisibilityTreeNoFilteredDataProps) {\r\n  return (\r\n    <div className=\"components-tree-errormessage\">\r\n      <span className=\"errormessage-header\">{props.title}</span>\r\n      <span className=\"errormessage-body\">{props.message}</span>\r\n    </div>\r\n  );\r\n}\r\n"]}

package/lib/cjs/appui-react/imodel-components/category-tree/Categories.json

@@ -0,0 +1,102 @@
+{
+  "$schema": "../../../../node_modules/@itwin/presentation-common/Ruleset.schema.json",
+  "id": "ui-framework/CategoriesTree",
+  "rules": [
+    {
+      "ruleType": "RootNodes",
+      "subConditions": [
+        {
+          "condition": "GetVariableStringValue(\"ViewType\") = \"3d\"",
+          "specifications": [
+            {
+              "specType": "InstanceNodesOfSpecificClasses",
+              "classes": [
+                {
+                  "schemaName": "BisCore",
+                  "classNames": [
+                    "SpatialCategory"
+                  ]
+                }
+              ],
+              "arePolymorphic": true,
+              "relatedInstances": [
+                {
+                  "relationshipPath": {
+                    "relationship": {
+                      "schemaName": "BisCore",
+                      "className": "ModelContainsElements"
+                    },
+                    "direction": "Backward"
+                  },
+                  "isRequired": true,
+                  "alias": "model"
+                }
+              ],
+              "instanceFilter": "(NOT model.IsPrivate OR model.IsOfClass(\"DictionaryModel\", \"BisCore\")) AND this.HasRelatedInstance(\"BisCore:GeometricElement3dIsInCategory\", \"Backward\", \"BisCore:Element\")",
+              "groupByClass": false,
+              "groupByLabel": false
+            }
+          ]
+        },
+        {
+          "condition": "GetVariableStringValue(\"ViewType\") = \"2d\"",
+          "specifications": [
+            {
+              "specType": "InstanceNodesOfSpecificClasses",
+              "classes": [
+                {
+                  "schemaName": "BisCore",
+                  "classNames": [
+                    "DrawingCategory"
+                  ]
+                }
+              ],
+              "arePolymorphic": true,
+              "relatedInstances": [
+                {
+                  "relationshipPath": {
+                    "relationship": {
+                      "schemaName": "BisCore",
+                      "className": "ModelContainsElements"
+                    },
+                    "direction": "Backward"
+                  },
+                  "isRequired": true,
+                  "alias": "model"
+                }
+              ],
+              "instanceFilter": "(NOT model.IsPrivate OR model.IsOfClass(\"DictionaryModel\", \"BisCore\")) AND this.HasRelatedInstance(\"BisCore:GeometricElement2dIsInCategory\", \"Backward\", \"BisCore:Element\")",
+              "groupByClass": false,
+              "groupByLabel": false
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"Category\", \"BisCore\") ANDALSO ParentNode.ECInstance.GetRelatedInstancesCount(\"BisCore:CategoryOwnsSubCategories\", \"Forward\", \"BisCore:SubCategory\") > 1",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            {
+              "relationship": {
+                "schemaName": "BisCore",
+                "className": "CategoryOwnsSubCategories"
+              },
+              "direction": "Forward"
+            }
+          ],
+          "groupByClass": false,
+          "groupByLabel": false
+        }
+      ]
+    },
+    {
+      "ruleType": "LabelOverride",
+      "condition": "this.IsOfClass(\"Category\", \"BisCore\")",
+      "description": "this.Description"
+    }
+  ]
+}

package/lib/cjs/appui-react/imodel-components/category-tree/CategoriesTree.d.ts

@@ -0,0 +1,68 @@
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+/// <reference types="react" />
+import "./CategoriesTree.scss";
+import { IModelConnection, ViewManager, Viewport } from "@itwin/core-frontend";
+import { Ruleset } from "@itwin/presentation-common";
+import { IPresentationTreeDataProvider } from "@itwin/presentation-components";
+import { VisibilityTreeFilterInfo } from "../Common";
+import { CategoryVisibilityHandler } from "./CategoryVisibilityHandler";
+/**
+ * Presentation rules used by ControlledCategoriesTree
+ * @internal
+ */
+export declare const RULESET_CATEGORIES: Ruleset;
+/**
+ * Properties for the [[CategoryTree]] component
+ * @public
+ */
+export interface CategoryTreeProps {
+    /** Flag for accommodating all viewports */
+    allViewports?: boolean;
+    /** Active viewport */
+    activeView?: Viewport;
+    /**
+     * An IModel to pull data from
+     */
+    iModel: IModelConnection;
+    /** Width of the component */
+    width: number;
+    /** Height of the component */
+    height: number;
+    /**
+     * Information for tree filtering.
+     * @alpha
+     */
+    filterInfo?: VisibilityTreeFilterInfo;
+    /**
+     * Callback invoked when tree is filtered.
+     */
+    onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void;
+    /**
+     * Custom category visibility handler to use for testing
+     * @internal
+     */
+    categoryVisibilityHandler?: CategoryVisibilityHandler;
+    /**
+     * Custom view manager to use for testing
+     * @internal
+     */
+    viewManager?: ViewManager;
+}
+/**
+ * Tree which displays and manages categories contained in an iModel.
+ * @public
+ */
+export declare function CategoryTree(props: CategoryTreeProps): JSX.Element;
+/**
+ * Toggles visibility of categories to show or hide.
+ * @alpha
+ */
+export declare function toggleAllCategories(viewManager: ViewManager, imodel: IModelConnection, display: boolean, viewport?: Viewport, forAllViewports?: boolean, filteredProvider?: IPresentationTreeDataProvider): Promise<void>;
+/**
+ * Gets ids of all categories or categories from filtered data provider.
+ * @alpha
+ */
+export declare function getCategories(imodel: IModelConnection, viewport?: Viewport, filteredProvider?: IPresentationTreeDataProvider): Promise<string[]>;
+//# sourceMappingURL=CategoriesTree.d.ts.map

package/lib/cjs/appui-react/imodel-components/category-tree/CategoriesTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoriesTree.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/imodel-components/category-tree/CategoriesTree.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,uBAAuB,CAAC;AAE/B,OAAO,EAAa,gBAAgB,EAAoB,WAAW,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5G,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,6BAA6B,EAAiC,MAAM,gCAAgC,CAAC;AAK9G,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAGrD,OAAO,EAAY,yBAAyB,EAA6C,MAAM,6BAA6B,CAAC;AAI7H;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAsC,CAAC;AAExE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,2CAA2C;IAC3C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,sBAAsB;IACtB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IACzB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACtC;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,oBAAoB,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IACtG;;;OAGG;IACH,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IACtD;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,eAsDpD;AAoBD;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,gBAAgB,CAAC,EAAE,6BAA6B,iBAS/M;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,EAAE,6BAA6B,qBAQlI"}

package/lib/cjs/appui-react/imodel-components/category-tree/CategoriesTree.js

@@ -0,0 +1,105 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCategories = exports.toggleAllCategories = exports.CategoryTree = exports.RULESET_CATEGORIES = void 0;
+require("./CategoriesTree.scss");
+const React = require("react");
+const core_frontend_1 = require("@itwin/core-frontend");
+const presentation_components_1 = require("@itwin/presentation-components");
+const presentation_frontend_1 = require("@itwin/presentation-frontend");
+const components_react_1 = require("@itwin/components-react");
+const core_react_1 = require("@itwin/core-react");
+const UiFramework_1 = require("../../UiFramework");
+const VisibilityTreeEventHandler_1 = require("../VisibilityTreeEventHandler");
+const VisibilityTreeRenderer_1 = require("../VisibilityTreeRenderer");
+const CategoryVisibilityHandler_1 = require("./CategoryVisibilityHandler");
+const PAGING_SIZE = 20;
+/**
+ * Presentation rules used by ControlledCategoriesTree
+ * @internal
+ */
+exports.RULESET_CATEGORIES = require("./Categories.json"); // eslint-disable-line @typescript-eslint/no-var-requires
+/**
+ * Tree which displays and manages categories contained in an iModel.
+ * @public
+ */
+function CategoryTree(props) {
+    var _a;
+    const { nodeLoader } = (0, presentation_components_1.usePresentationTreeNodeLoader)({
+        imodel: props.iModel,
+        ruleset: exports.RULESET_CATEGORIES,
+        pagingSize: PAGING_SIZE,
+    });
+    const { filteredNodeLoader, isFiltering, nodeHighlightingProps } = (0, VisibilityTreeRenderer_1.useVisibilityTreeFiltering)(nodeLoader, props.filterInfo, props.onFilterApplied);
+    // istanbul ignore next
+    const viewManager = (_a = props.viewManager) !== null && _a !== void 0 ? _a : core_frontend_1.IModelApp.viewManager;
+    const { activeView, allViewports, categoryVisibilityHandler } = props;
+    const currentActiveView = activeView !== null && activeView !== void 0 ? activeView : viewManager.getFirstOpenView();
+    const categories = (0, CategoryVisibilityHandler_1.useCategories)(viewManager, props.iModel, currentActiveView);
+    const visibilityHandler = useCategoryVisibilityHandler(viewManager, props.iModel, categories, currentActiveView, allViewports, categoryVisibilityHandler);
+    React.useEffect(() => {
+        setViewType(currentActiveView); // eslint-disable-line @typescript-eslint/no-floating-promises
+    }, [currentActiveView]);
+    const eventHandler = (0, core_react_1.useDisposable)(React.useCallback(() => new VisibilityTreeEventHandler_1.VisibilityTreeEventHandler({
+        nodeLoader: filteredNodeLoader,
+        visibilityHandler,
+        collapsedChildrenDisposalEnabled: true,
+    }), [filteredNodeLoader, visibilityHandler]));
+    const treeModel = (0, components_react_1.useTreeModel)(filteredNodeLoader.modelSource);
+    const treeRenderer = (0, VisibilityTreeRenderer_1.useVisibilityTreeRenderer)(false, true);
+    const overlay = isFiltering ? React.createElement("div", { className: "filteredTreeOverlay" }) : undefined;
+    const filterApplied = filteredNodeLoader !== nodeLoader;
+    const noFilteredDataRenderer = React.useCallback(() => {
+        return React.createElement(VisibilityTreeRenderer_1.VisibilityTreeNoFilteredData, { title: UiFramework_1.UiFramework.localization.getLocalizedString("UiFramework:categoriesTree.noCategoryFound"), message: UiFramework_1.UiFramework.localization.getLocalizedString("UiFramework:categoriesTree.noMatchingCategoryNames") });
+    }, []);
+    return (React.createElement("div", { className: "ui-fw-categories-tree" },
+        React.createElement(components_react_1.ControlledTree, { nodeLoader: filteredNodeLoader, model: treeModel, selectionMode: components_react_1.SelectionMode.None, eventsHandler: eventHandler, treeRenderer: treeRenderer, descriptionsEnabled: true, nodeHighlightingProps: nodeHighlightingProps, noDataRenderer: filterApplied ? noFilteredDataRenderer : undefined, width: props.width, height: props.height }),
+        overlay));
+}
+exports.CategoryTree = CategoryTree;
+function useCategoryVisibilityHandler(viewManager, imodel, categories, activeView, allViewports, visibilityHandler) {
+    return (0, core_react_1.useDisposable)(React.useCallback(() => 
+    // istanbul ignore next
+    visibilityHandler !== null && visibilityHandler !== void 0 ? visibilityHandler : new CategoryVisibilityHandler_1.CategoryVisibilityHandler({ viewManager, imodel, categories, activeView, allViewports }), [viewManager, imodel, categories, activeView, allViewports, visibilityHandler]));
+}
+async function setViewType(activeView) {
+    if (!activeView)
+        return;
+    const view = activeView.view;
+    const viewType = view.is3d() ? "3d" : "2d";
+    await presentation_frontend_1.Presentation.presentation.vars(exports.RULESET_CATEGORIES.id).setString("ViewType", viewType);
+}
+/**
+ * Toggles visibility of categories to show or hide.
+ * @alpha
+ */
+async function toggleAllCategories(viewManager, imodel, display, viewport, forAllViewports, filteredProvider) {
+    // istanbul ignore next
+    const activeView = viewport !== null && viewport !== void 0 ? viewport : viewManager.getFirstOpenView();
+    const ids = await getCategories(imodel, activeView, filteredProvider);
+    // istanbul ignore else
+    if (ids.length > 0) {
+        CategoryVisibilityHandler_1.CategoryVisibilityHandler.enableCategory(viewManager, imodel, ids, display, forAllViewports !== null && forAllViewports !== void 0 ? forAllViewports : false);
+    }
+}
+exports.toggleAllCategories = toggleAllCategories;
+/**
+ * Gets ids of all categories or categories from filtered data provider.
+ * @alpha
+ */
+async function getCategories(imodel, viewport, filteredProvider) {
+    if (filteredProvider) {
+        const nodes = await filteredProvider.getNodes();
+        return nodes.map((node) => CategoryVisibilityHandler_1.CategoryVisibilityHandler.getInstanceIdFromTreeNodeKey(filteredProvider.getNodeKey(node)));
+    }
+    const categories = await (0, CategoryVisibilityHandler_1.loadCategoriesFromViewport)(imodel, viewport);
+    return categories.map((category) => category.key);
+}
+exports.getCategories = getCategories;
+//# sourceMappingURL=CategoriesTree.js.map

package/lib/cjs/appui-react/imodel-components/category-tree/CategoriesTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoriesTree.js","sourceRoot":"","sources":["../../../../../src/appui-react/imodel-components/category-tree/CategoriesTree.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iCAA+B;AAC/B,+BAA+B;AAC/B,wDAA4G;AAE5G,4EAA8G;AAC9G,wEAA4D;AAC5D,8DAAsF;AACtF,kDAAkD;AAClD,mDAAgD;AAEhD,8EAA2E;AAC3E,sEAAgI;AAChI,2EAA6H;AAE7H,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB;;;GAGG;AACU,QAAA,kBAAkB,GAAY,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,yDAAyD;AAwClI;;;GAGG;AACH,SAAgB,YAAY,CAAC,KAAwB;;IACnD,MAAM,EAAE,UAAU,EAAE,GAAG,IAAA,uDAA6B,EAAC;QACnD,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,0BAAkB;QAC3B,UAAU,EAAE,WAAW;KACxB,CAAC,CAAC;IAEH,MAAM,EAAE,kBAAkB,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAA,mDAA0B,EAAC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACnJ,uBAAuB;IACvB,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,WAAW,mCAAI,yBAAS,CAAC,WAAW,CAAC;IAC/D,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;IACtE,MAAM,iBAAiB,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,WAAW,CAAC,gBAAgB,EAAE,CAAC;IACvE,MAAM,UAAU,GAAG,IAAA,yCAAa,EAAC,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC/E,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,YAAY,EAAE,yBAAyB,CAAC,CAAC;IAE1J,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,8DAA8D;IAChG,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAExB,MAAM,YAAY,GAAG,IAAA,0BAAa,EAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,uDAA0B,CAAC;QACxF,UAAU,EAAE,kBAAkB;QAC9B,iBAAiB;QACjB,gCAAgC,EAAE,IAAI;KACvC,CAAC,EAAE,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAE9C,MAAM,SAAS,GAAG,IAAA,+BAAY,EAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,IAAA,kDAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,6BAAK,SAAS,EAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAClF,MAAM,aAAa,GAAG,kBAAkB,KAAK,UAAU,CAAC;IAExD,MAAM,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACpD,OAAO,oBAAC,qDAA4B,IAClC,KAAK,EAAE,yBAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,4CAA4C,CAAC,EAChG,OAAO,EAAE,yBAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,oDAAoD,CAAC,GAC1G,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL,6BAAK,SAAS,EAAC,uBAAuB;QACpC,oBAAC,iCAAc,IACb,UAAU,EAAE,kBAAkB,EAC9B,KAAK,EAAE,SAAS,EAChB,aAAa,EAAE,gCAAa,CAAC,IAAI,EACjC,aAAa,EAAE,YAAY,EAC3B,YAAY,EAAE,YAAY,EAC1B,mBAAmB,EAAE,IAAI,EACzB,qBAAqB,EAAE,qBAAqB,EAC5C,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,EAClE,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GACpB;QACD,OAAO,CACJ,CACP,CAAC;AACJ,CAAC;AAtDD,oCAsDC;AAED,SAAS,4BAA4B,CAAC,WAAwB,EAAE,MAAwB,EAAE,UAAsB,EAAE,UAAqB,EAAE,YAAsB,EAAE,iBAA6C;IAC5M,OAAO,IAAA,0BAAa,EAAC,KAAK,CAAC,WAAW,CACpC,GAAG,EAAE;IACH,uBAAuB;IACvB,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,IAAI,qDAAyB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,EACnH,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAChF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,UAAqB;IAC9C,IAAI,CAAC,UAAU;QACb,OAAO;IAET,MAAM,IAAI,GAAG,UAAU,CAAC,IAAwB,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3C,MAAM,oCAAY,CAAC,YAAY,CAAC,IAAI,CAAC,0BAAkB,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAC9F,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,mBAAmB,CAAC,WAAwB,EAAE,MAAwB,EAAE,OAAgB,EAAE,QAAmB,EAAE,eAAyB,EAAE,gBAAgD;IAC9M,uBAAuB;IACvB,MAAM,UAAU,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,WAAW,CAAC,gBAAgB,EAAE,CAAC;IAC9D,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IAEtE,uBAAuB;IACvB,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;QAClB,qDAAyB,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,KAAK,CAAC,CAAC;KACvG;AACH,CAAC;AATD,kDASC;AAED;;;GAGG;AACI,KAAK,UAAU,aAAa,CAAC,MAAwB,EAAE,QAAmB,EAAE,gBAAgD;IACjI,IAAI,gBAAgB,EAAE;QACpB,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qDAAyB,CAAC,4BAA4B,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACvH;IAED,MAAM,UAAU,GAAG,MAAM,IAAA,sDAA0B,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtE,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACpD,CAAC;AARD,sCAQC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModelComponents\r\n */\r\n\r\nimport \"./CategoriesTree.scss\";\r\nimport * as React from \"react\";\r\nimport { IModelApp, IModelConnection, SpatialViewState, ViewManager, Viewport } from \"@itwin/core-frontend\";\r\nimport { Ruleset } from \"@itwin/presentation-common\";\r\nimport { IPresentationTreeDataProvider, usePresentationTreeNodeLoader } from \"@itwin/presentation-components\";\r\nimport { Presentation } from \"@itwin/presentation-frontend\";\r\nimport { ControlledTree, SelectionMode, useTreeModel } from \"@itwin/components-react\";\r\nimport { useDisposable } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../../UiFramework\";\r\nimport { VisibilityTreeFilterInfo } from \"../Common\";\r\nimport { VisibilityTreeEventHandler } from \"../VisibilityTreeEventHandler\";\r\nimport { useVisibilityTreeFiltering, useVisibilityTreeRenderer, VisibilityTreeNoFilteredData } from \"../VisibilityTreeRenderer\";\r\nimport { Category, CategoryVisibilityHandler, loadCategoriesFromViewport, useCategories } from \"./CategoryVisibilityHandler\";\r\n\r\nconst PAGING_SIZE = 20;\r\n\r\n/**\r\n * Presentation rules used by ControlledCategoriesTree\r\n * @internal\r\n */\r\nexport const RULESET_CATEGORIES: Ruleset = require(\"./Categories.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n\r\n/**\r\n * Properties for the [[CategoryTree]] component\r\n * @public\r\n */\r\nexport interface CategoryTreeProps {\r\n  /** Flag for accommodating all viewports */\r\n  allViewports?: boolean;\r\n  /** Active viewport */\r\n  activeView?: Viewport;\r\n  /**\r\n   * An IModel to pull data from\r\n   */\r\n  iModel: IModelConnection;\r\n  /** Width of the component */\r\n  width: number;\r\n  /** Height of the component */\r\n  height: number;\r\n  /**\r\n   * Information for tree filtering.\r\n   * @alpha\r\n   */\r\n  filterInfo?: VisibilityTreeFilterInfo;\r\n  /**\r\n   * Callback invoked when tree is filtered.\r\n   */\r\n  onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void;\r\n  /**\r\n   * Custom category visibility handler to use for testing\r\n   * @internal\r\n   */\r\n  categoryVisibilityHandler?: CategoryVisibilityHandler;\r\n  /**\r\n   * Custom view manager to use for testing\r\n   * @internal\r\n   */\r\n  viewManager?: ViewManager;\r\n}\r\n\r\n/**\r\n * Tree which displays and manages categories contained in an iModel.\r\n * @public\r\n */\r\nexport function CategoryTree(props: CategoryTreeProps) {\r\n  const { nodeLoader } = usePresentationTreeNodeLoader({\r\n    imodel: props.iModel,\r\n    ruleset: RULESET_CATEGORIES,\r\n    pagingSize: PAGING_SIZE,\r\n  });\r\n\r\n  const { filteredNodeLoader, isFiltering, nodeHighlightingProps } = useVisibilityTreeFiltering(nodeLoader, props.filterInfo, props.onFilterApplied);\r\n  // istanbul ignore next\r\n  const viewManager = props.viewManager ?? IModelApp.viewManager;\r\n  const { activeView, allViewports, categoryVisibilityHandler } = props;\r\n  const currentActiveView = activeView ?? viewManager.getFirstOpenView();\r\n  const categories = useCategories(viewManager, props.iModel, currentActiveView);\r\n  const visibilityHandler = useCategoryVisibilityHandler(viewManager, props.iModel, categories, currentActiveView, allViewports, categoryVisibilityHandler);\r\n\r\n  React.useEffect(() => {\r\n    setViewType(currentActiveView); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n  }, [currentActiveView]);\r\n\r\n  const eventHandler = useDisposable(React.useCallback(() => new VisibilityTreeEventHandler({\r\n    nodeLoader: filteredNodeLoader,\r\n    visibilityHandler,\r\n    collapsedChildrenDisposalEnabled: true,\r\n  }), [filteredNodeLoader, visibilityHandler]));\r\n\r\n  const treeModel = useTreeModel(filteredNodeLoader.modelSource);\r\n  const treeRenderer = useVisibilityTreeRenderer(false, true);\r\n  const overlay = isFiltering ? <div className=\"filteredTreeOverlay\" /> : undefined;\r\n  const filterApplied = filteredNodeLoader !== nodeLoader;\r\n\r\n  const noFilteredDataRenderer = React.useCallback(() => {\r\n    return <VisibilityTreeNoFilteredData\r\n      title={UiFramework.localization.getLocalizedString(\"UiFramework:categoriesTree.noCategoryFound\")}\r\n      message={UiFramework.localization.getLocalizedString(\"UiFramework:categoriesTree.noMatchingCategoryNames\")}\r\n    />;\r\n  }, []);\r\n\r\n  return (\r\n    <div className=\"ui-fw-categories-tree\">\r\n      <ControlledTree\r\n        nodeLoader={filteredNodeLoader}\r\n        model={treeModel}\r\n        selectionMode={SelectionMode.None}\r\n        eventsHandler={eventHandler}\r\n        treeRenderer={treeRenderer}\r\n        descriptionsEnabled={true}\r\n        nodeHighlightingProps={nodeHighlightingProps}\r\n        noDataRenderer={filterApplied ? noFilteredDataRenderer : undefined}\r\n        width={props.width}\r\n        height={props.height}\r\n      />\r\n      {overlay}\r\n    </div>\r\n  );\r\n}\r\n\r\nfunction useCategoryVisibilityHandler(viewManager: ViewManager, imodel: IModelConnection, categories: Category[], activeView?: Viewport, allViewports?: boolean, visibilityHandler?: CategoryVisibilityHandler) {\r\n  return useDisposable(React.useCallback(\r\n    () =>\r\n      // istanbul ignore next\r\n      visibilityHandler ?? new CategoryVisibilityHandler({ viewManager, imodel, categories, activeView, allViewports }),\r\n    [viewManager, imodel, categories, activeView, allViewports, visibilityHandler]),\r\n  );\r\n}\r\n\r\nasync function setViewType(activeView?: Viewport) {\r\n  if (!activeView)\r\n    return;\r\n\r\n  const view = activeView.view as SpatialViewState;\r\n  const viewType = view.is3d() ? \"3d\" : \"2d\";\r\n  await Presentation.presentation.vars(RULESET_CATEGORIES.id).setString(\"ViewType\", viewType);\r\n}\r\n\r\n/**\r\n * Toggles visibility of categories to show or hide.\r\n * @alpha\r\n */\r\nexport async function toggleAllCategories(viewManager: ViewManager, imodel: IModelConnection, display: boolean, viewport?: Viewport, forAllViewports?: boolean, filteredProvider?: IPresentationTreeDataProvider) {\r\n  // istanbul ignore next\r\n  const activeView = viewport ?? viewManager.getFirstOpenView();\r\n  const ids = await getCategories(imodel, activeView, filteredProvider);\r\n\r\n  // istanbul ignore else\r\n  if (ids.length > 0) {\r\n    CategoryVisibilityHandler.enableCategory(viewManager, imodel, ids, display, forAllViewports ?? false);\r\n  }\r\n}\r\n\r\n/**\r\n * Gets ids of all categories or categories from filtered data provider.\r\n * @alpha\r\n */\r\nexport async function getCategories(imodel: IModelConnection, viewport?: Viewport, filteredProvider?: IPresentationTreeDataProvider) {\r\n  if (filteredProvider) {\r\n    const nodes = await filteredProvider.getNodes();\r\n    return nodes.map((node) => CategoryVisibilityHandler.getInstanceIdFromTreeNodeKey(filteredProvider.getNodeKey(node)));\r\n  }\r\n\r\n  const categories = await loadCategoriesFromViewport(imodel, viewport);\r\n  return categories.map((category) => category.key);\r\n}\r\n"]}

package/lib/cjs/appui-react/imodel-components/category-tree/CategoriesTree.scss

@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+@import "../VisibilityTreeBase";
+
+.ui-fw-categories-tree {
+  @include ui-fw-visibility-tree-base;
+}

package/lib/cjs/appui-react/imodel-components/category-tree/CategoryVisibilityHandler.d.ts

@@ -0,0 +1,57 @@
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { IModelConnection, ViewManager, Viewport } from "@itwin/core-frontend";
+import { NodeKey } from "@itwin/presentation-common";
+import { TreeNodeItem } from "@itwin/components-react";
+import { IVisibilityHandler, VisibilityChangeListener, VisibilityStatus } from "../VisibilityTreeEventHandler";
+/**
+ * Loads categories from viewport or uses provided list of categories.
+ * @internal
+ */
+export declare function useCategories(viewManager: ViewManager, imodel: IModelConnection, view?: Viewport): Category[];
+/** @internal */
+export declare function loadCategoriesFromViewport(iModel?: IModelConnection, vp?: Viewport): Promise<Category[]>;
+/**
+ * Data structure that describes category.
+ * @internal
+ */
+export interface Category {
+    key: string;
+    children?: string[];
+}
+/** @internal */
+export interface CategoryVisibilityHandlerParams {
+    viewManager: ViewManager;
+    imodel: IModelConnection;
+    categories: Category[];
+    activeView?: Viewport;
+    allViewports?: boolean;
+}
+/** @internal */
+export declare class CategoryVisibilityHandler implements IVisibilityHandler {
+    private _viewManager;
+    private _imodel;
+    private _pendingVisibilityChange;
+    private _activeView?;
+    private _useAllViewports;
+    private _categories;
+    constructor(params: CategoryVisibilityHandlerParams);
+    dispose(): void;
+    onVisibilityChange: BeEvent<VisibilityChangeListener>;
+    getVisibilityStatus(node: TreeNodeItem, nodeKey: NodeKey): VisibilityStatus;
+    changeVisibility(node: TreeNodeItem, nodeKey: NodeKey, shouldDisplay: boolean): Promise<void>;
+    getSubCategoryVisibility(id: string): "hidden" | "visible";
+    getCategoryVisibility(id: string): "hidden" | "visible";
+    getParent(key: string): Category | undefined;
+    private onDisplayStyleChanged;
+    private onViewedCategoriesChanged;
+    private onVisibilityChangeInternal;
+    static getInstanceIdFromTreeNodeKey(nodeKey: NodeKey): string;
+    /** Changes category display in the viewport */
+    static enableCategory(viewManager: ViewManager, imodel: IModelConnection, ids: string[], enabled: boolean, forAllViewports: boolean, enableAllSubCategories?: boolean): void;
+    /** Changes subcategory display in the viewport */
+    static enableSubCategory(viewManager: ViewManager, key: string, enabled: boolean, forAllViewports?: boolean): void;
+}
+//# sourceMappingURL=CategoryVisibilityHandler.d.ts.map

package/lib/cjs/appui-react/imodel-components/category-tree/CategoryVisibilityHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoryVisibilityHandler.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/imodel-components/category-tree/CategoryVisibilityHandler.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAA8B,WAAW,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC3G,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,YAAY,EAAiB,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAI/G;;;GAGG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,QAAQ,cAIhG;AAED,gBAAgB;AAChB,wBAAsB,0BAA0B,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,EAAE,CAAC,EAAE,QAAQ,uBAuBxF;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,gBAAgB;AAChB,MAAM,WAAW,+BAA+B;IAC9C,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,gBAAgB,CAAC;IACzB,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,gBAAgB;AAChB,qBAAa,yBAA0B,YAAW,kBAAkB;IAClE,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,wBAAwB,CAAkB;IAClD,OAAO,CAAC,WAAW,CAAC,CAAW;IAC/B,OAAO,CAAC,gBAAgB,CAAU;IAClC,OAAO,CAAC,WAAW,CAAa;gBAEpB,MAAM,EAAE,+BAA+B;IAa5C,OAAO;IAQP,kBAAkB,oCAA2C;IAE7D,mBAAmB,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB;IAKrE,gBAAgB,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBnG,wBAAwB,CAAC,EAAE,EAAE,MAAM;IASnC,qBAAqB,CAAC,EAAE,EAAE,MAAM;IAMhC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAanD,OAAO,CAAC,qBAAqB,CAE3B;IAGF,OAAO,CAAC,yBAAyB,CAE/B;IAEF,OAAO,CAAC,0BAA0B;WAUpB,4BAA4B,CAAC,OAAO,EAAE,OAAO;IAI3D,+CAA+C;WACjC,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,sBAAsB,UAAO;IA0CzK,kDAAkD;WACpC,iBAAiB,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,CAAC,EAAE,OAAO;CAqBnH"}