@itwin/saved-views-react 0.8.0 → 0.9.0

package/lib/applySavedView.d.ts

@@ -1,5 +1,6 @@
 import { ViewChangeOptions, ViewPose, ViewState, type IModelConnection, type Viewport } from "@itwin/core-frontend";
 import type { SavedViewData } from "./SavedView.js";
+import { type DefaultExtensionHandlersApplyOverrides } from "./translation/SavedViewsExtensionHandlers.js";
 export interface ApplySavedViewSettings {
     /**
      * How to make use of captured {@link ViewState} data. The default behavior is
@@ -65,5 +66,5 @@ type ApplyStrategy = "apply" | "keep";
  *   applySavedView(iModel, viewport2, savedView, { viewState }),
  * ]);
  */
-export declare function applySavedView(iModel: IModelConnection, viewport: Viewport, savedViewData: SavedViewData, settings?: ApplySavedViewSettings | undefined): Promise<void>;
+export declare function applySavedView(iModel: IModelConnection, viewport: Viewport, savedViewData: SavedViewData, settings?: ApplySavedViewSettings | undefined, overrides?: DefaultExtensionHandlersApplyOverrides): Promise<void>;
 export {};

package/lib/applySavedView.js

@@ -1,10 +1,10 @@
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-import { ViewPose, ViewState } from "@itwin/core-frontend";
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { ViewPose, ViewState, } from "@itwin/core-frontend";
 import { createViewState } from "./createViewState.js";
-import { extensionHandlers } from "./translation/SavedViewsExtensionHandlers.js";
+import { extensionHandlers, } from "./translation/SavedViewsExtensionHandlers.js";
 /**
  * Updates {@linkcode viewport} state to match captured Saved View.
  *
@@ -17,7 +17,7 @@ import { extensionHandlers } from "./translation/SavedViewsExtensionHandlers.js"
  *   applySavedView(iModel, viewport2, savedView, { viewState }),
  * ]);
  */
-export async function applySavedView(iModel, viewport, savedViewData, settings = {}) {
+export async function applySavedView(iModel, viewport, savedViewData, settings = {}, overrides) {
     if (settings.viewState !== "keep") {
         // We use "hidden" as the default value for modelAndCategoryVisibilityFallback
         // because users expect modelSelector.enabled and categorySelector.enabled to
@@ -26,7 +26,9 @@ export async function applySavedView(iModel, viewport, savedViewData, settings =
         const { modelAndCategoryVisibilityFallback = "hidden" } = settings;
         const viewState = settings.viewState instanceof ViewState
             ? settings.viewState
-            : await createViewState(iModel, savedViewData.viewData, { modelAndCategoryVisibilityFallback });
+            : await createViewState(iModel, savedViewData.viewData, {
+                modelAndCategoryVisibilityFallback,
+            });
         if (settings.camera instanceof ViewPose) {
             viewState.applyPose(settings.camera);
         }
@@ -37,19 +39,29 @@ export async function applySavedView(iModel, viewport, savedViewData, settings =
     }
     const extensions = findKnownExtensions(savedViewData.extensions ?? []);
     if (extensions.emphasis) {
+        const override = overrides?.emphasizeElements;
         if (settings.emphasis !== "keep") {
-            extensionHandlers.emphasizeElements.reset(viewport);
+            override?.reset
+                ? override.reset(viewport)
+                : extensionHandlers.emphasizeElements.reset(viewport);
         }
         if (settings.emphasis === "apply") {
-            extensionHandlers.emphasizeElements.apply(extensions.emphasis, viewport);
+            override?.apply
+                ? override.apply(extensions.emphasis, viewport)
+                : extensionHandlers.emphasizeElements.apply(extensions.emphasis, viewport);
         }
     }
     if (extensions.perModelCategoryVisibility) {
+        const override = overrides?.perModelCategoryVisibility;
         if (settings.perModelCategoryVisibility !== "keep") {
-            extensionHandlers.perModelCategoryVisibility.reset(viewport);
+            override?.reset
+                ? override.reset(viewport)
+                : extensionHandlers.perModelCategoryVisibility.reset(viewport);
         }
         if (settings.perModelCategoryVisibility === "apply") {
-            extensionHandlers.perModelCategoryVisibility.apply(extensions.perModelCategoryVisibility, viewport);
+            override?.apply
+                ? override.apply(extensions.perModelCategoryVisibility, viewport)
+                : extensionHandlers.perModelCategoryVisibility.apply(extensions.perModelCategoryVisibility, viewport);
         }
     }
 }
@@ -61,14 +73,16 @@ function findKnownExtensions(extensions) {
     };
     for (const extension of extensions) {
         if (result.emphasis === undefined &&
-            extension.extensionName === extensionHandlers.emphasizeElements.extensionName) {
+            extension.extensionName ===
+                extensionHandlers.emphasizeElements.extensionName) {
             result.emphasis = extension.data;
             if (result.perModelCategoryVisibility) {
                 break;
             }
         }
         if (result.perModelCategoryVisibility === undefined &&
-            extension.extensionName === extensionHandlers.perModelCategoryVisibility.extensionName) {
+            extension.extensionName ===
+                extensionHandlers.perModelCategoryVisibility.extensionName) {
             result.perModelCategoryVisibility = extension.data;
             if (result.emphasis) {
                 break;

package/lib/captureSavedViewData.d.ts

@@ -1,6 +1,7 @@
 import { Id64Array } from "@itwin/core-bentley";
 import type { IModelConnection, Viewport } from "@itwin/core-frontend";
 import type { SavedViewData } from "./SavedView.js";
+import { type DefaultExtensionHandlersCaptureOverrides } from "./translation/SavedViewsExtensionHandlers.js";
 interface CaptureSavedViewDataArgs {
     /** Viewport to capture. */
     viewport: Viewport;
@@ -14,6 +15,10 @@ interface CaptureSavedViewDataArgs {
      * @default false
      */
     omitPerModelCategoryVisibility?: boolean | undefined;
+    /**
+     * Overrides for the capture function of default extension handlers .
+     */
+    overrides?: DefaultExtensionHandlersCaptureOverrides;
 }
 /**
  * Captures current {@link Viewport} state into serializable format. The returned

package/lib/captureSavedViewData.js

@@ -19,10 +19,16 @@ import { extractDisplayStyle2dFromLegacy, extractDisplayStyle3dFromLegacy, } fro
 export async function captureSavedViewData(args) {
     const extensions = [];
     if (!args.omitEmphasis) {
-        extensions.push(extensionHandlers.emphasizeElements);
+        extensions.push({
+            ...extensionHandlers.emphasizeElements,
+            capture: args.overrides?.emphasizeElements?.capture ?? extensionHandlers.emphasizeElements.capture,
+        });
     }
     if (!args.omitPerModelCategoryVisibility) {
-        extensions.push(extensionHandlers.perModelCategoryVisibility);
+        extensions.push({
+            ...extensionHandlers.perModelCategoryVisibility,
+            capture: args.overrides?.perModelCategoryVisibility?.capture ?? extensionHandlers.perModelCategoryVisibility.capture,
+        });
     }
     return {
         viewData: await createSavedViewVariant(args.viewport),

package/lib/translation/SavedViewsExtensionHandlers.d.ts

@@ -5,6 +5,14 @@ export interface ExtensionHandler {
     reset: (viewport: Viewport) => void;
     capture: (viewport: Viewport) => string | undefined;
 }
+export interface DefaultExtensionHandlersApplyOverrides {
+    emphasizeElements?: Partial<Pick<ExtensionHandler, "apply" | "reset">>;
+    perModelCategoryVisibility?: Partial<Pick<ExtensionHandler, "apply" | "reset">>;
+}
+export interface DefaultExtensionHandlersCaptureOverrides {
+    emphasizeElements?: Partial<Pick<ExtensionHandler, "capture">>;
+    perModelCategoryVisibility?: Partial<Pick<ExtensionHandler, "capture">>;
+}
 export declare const extensionHandlers: {
     emphasizeElements: {
         extensionName: string;

package/lib/translation/SavedViewsExtensionHandlers.js

@@ -1,9 +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 { EmphasizeElements, PerModelCategoryVisibility } from "@itwin/core-frontend";
-import { extractEmphasizeElements, extractPerModelCategoryVisibility } from "./extensionExtractor.js";
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { EmphasizeElements, PerModelCategoryVisibility, } from "@itwin/core-frontend";
+import { extractEmphasizeElements, extractPerModelCategoryVisibility, } from "./extensionExtractor.js";
 export const extensionHandlers = {
     emphasizeElements: {
         extensionName: "EmphasizeElements",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/saved-views-react",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "license": "MIT",
   "repository": {
     "type": "git",