@itwin/appui-react 4.0.0-dev.9 → 4.0.0

package/lib/cjs/appui-react/content/StageContentLayout.js

@@ -1,67 +1,67 @@
-"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 ContentView
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StageContentLayout = void 0;
-const ViewStateHelper_1 = require("./ViewStateHelper");
-/** StageContentLayout class. Used to serialize/deserialize a View Layout with Saved Views.
- * @public
- */
-class StageContentLayout {
-    /** Create props for a View Layout */
-    static viewLayoutToProps(contentLayoutDef, contentGroup, emphasizeElements = false, contentCallback) {
-        const contentLayoutProps = contentLayoutDef.toJSON();
-        // update layout in contentGroup to contain latest values from contentLayoutDef this way we don't need to save both.
-        const contentGroupProps = { ...contentGroup.toJSON(contentCallback), layout: contentLayoutProps };
-        const viewStateProps = new Array();
-        const viewports = contentGroup.getViewports();
-        for (const viewport of viewports) {
-            // istanbul ignore else
-            if (viewport) {
-                const savedViewProps = ViewStateHelper_1.ViewStateHelper.viewStateToProps(viewport.view);
-                if (emphasizeElements)
-                    ViewStateHelper_1.ViewStateHelper.emphasizeElementsToProps(viewport, savedViewProps);
-                viewStateProps.push(savedViewProps);
-            }
-        }
-        const savedViewLayoutProps = {
-            contentGroupProps,
-            viewStateProps,
-        };
-        return savedViewLayoutProps;
-    }
-    /** Create an array of ViewStates from the StageContentLayout */
-    static async viewStatesFromProps(iModelConnection, savedProps) {
-        const viewStates = new Array();
-        if (savedProps.viewStateProps) {
-            for (const savedViewProps of savedProps.viewStateProps) {
-                const viewState = await ViewStateHelper_1.ViewStateHelper.viewStateFromProps(iModelConnection, savedViewProps);
-                viewStates.push(viewState);
-            }
-        }
-        return viewStates;
-    }
-    /** Apply EmphasizeElements from the SavedView */
-    static emphasizeElementsFromProps(contentGroup, savedProps) {
-        const changedList = new Array();
-        const viewports = contentGroup.getViewports();
-        let index = 0;
-        for (const savedViewProps of savedProps.viewStateProps) {
-            const viewport = viewports[index];
-            // istanbul ignore else
-            if (viewport) {
-                const changed = ViewStateHelper_1.ViewStateHelper.emphasizeElementsFromProps(viewport, savedViewProps);
-                changedList.push(changed);
-            }
-            index++;
-        }
-        return changedList.some((changed) => changed);
-    }
-}
-exports.StageContentLayout = StageContentLayout;
+"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 ContentView
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StageContentLayout = void 0;
+const ViewStateHelper_1 = require("./ViewStateHelper");
+/** StageContentLayout class. Used to serialize/deserialize a View Layout with Saved Views.
+ * @public
+ */
+class StageContentLayout {
+    /** Create props for a View Layout */
+    static viewLayoutToProps(contentLayoutDef, contentGroup, emphasizeElements = false, contentCallback) {
+        const contentLayoutProps = contentLayoutDef.toJSON();
+        // update layout in contentGroup to contain latest values from contentLayoutDef this way we don't need to save both.
+        const contentGroupProps = { ...contentGroup.toJSON(contentCallback), layout: contentLayoutProps };
+        const viewStateProps = new Array();
+        const viewports = contentGroup.getViewports();
+        for (const viewport of viewports) {
+            // istanbul ignore else
+            if (viewport) {
+                const savedViewProps = ViewStateHelper_1.ViewStateHelper.viewStateToProps(viewport.view);
+                if (emphasizeElements)
+                    ViewStateHelper_1.ViewStateHelper.emphasizeElementsToProps(viewport, savedViewProps);
+                viewStateProps.push(savedViewProps);
+            }
+        }
+        const savedViewLayoutProps = {
+            contentGroupProps,
+            viewStateProps,
+        };
+        return savedViewLayoutProps;
+    }
+    /** Create an array of ViewStates from the StageContentLayout */
+    static async viewStatesFromProps(iModelConnection, savedProps) {
+        const viewStates = new Array();
+        if (savedProps.viewStateProps) {
+            for (const savedViewProps of savedProps.viewStateProps) {
+                const viewState = await ViewStateHelper_1.ViewStateHelper.viewStateFromProps(iModelConnection, savedViewProps);
+                viewStates.push(viewState);
+            }
+        }
+        return viewStates;
+    }
+    /** Apply EmphasizeElements from the SavedView */
+    static emphasizeElementsFromProps(contentGroup, savedProps) {
+        const changedList = new Array();
+        const viewports = contentGroup.getViewports();
+        let index = 0;
+        for (const savedViewProps of savedProps.viewStateProps) {
+            const viewport = viewports[index];
+            // istanbul ignore else
+            if (viewport) {
+                const changed = ViewStateHelper_1.ViewStateHelper.emphasizeElementsFromProps(viewport, savedViewProps);
+                changedList.push(changed);
+            }
+            index++;
+        }
+        return changedList.some((changed) => changed);
+    }
+}
+exports.StageContentLayout = StageContentLayout;
 //# sourceMappingURL=StageContentLayout.js.map

package/lib/cjs/appui-react/content/ViewStateHelper.d.ts

@@ -1,26 +1,26 @@
-/** @packageDocumentation
- * @module ContentView
- */
-import { EmphasizeElementsProps, ViewStateProps } from "@itwin/core-common";
-import { IModelConnection, ScreenViewport, ViewState } from "@itwin/core-frontend";
-/** SavedViewProps interface for sharing ViewState and EmphasizeElements information.
- * @public
- */
-export interface ViewStateHelperProps extends ViewStateProps {
-    bisBaseClass: string;
-    emphasizeElementsProps?: EmphasizeElementsProps;
-}
-/** SavedView class. Used to serialize/deserialize a ViewState.
- * @public
- */
-export declare class ViewStateHelper {
-    /** Create a ViewState from the SavedView */
-    static viewStateFromProps(iModelConnection: IModelConnection, savedViewProps: ViewStateHelperProps): Promise<ViewState | undefined>;
-    /** Apply EmphasizeElements from the SavedView */
-    static emphasizeElementsFromProps(vp: ScreenViewport, savedViewProps: ViewStateHelperProps): boolean;
-    /** Create props for a ViewState */
-    static viewStateToProps(viewState: ViewState): ViewStateHelperProps;
-    /** Create props for an EmphasizeElements and store in SavedViewProps */
-    static emphasizeElementsToProps(vp: ScreenViewport, savedViewProps: ViewStateHelperProps): void;
-}
+/** @packageDocumentation
+ * @module ContentView
+ */
+import { EmphasizeElementsProps, ViewStateProps } from "@itwin/core-common";
+import { IModelConnection, ScreenViewport, ViewState } from "@itwin/core-frontend";
+/** SavedViewProps interface for sharing ViewState and EmphasizeElements information.
+ * @public
+ */
+export interface ViewStateHelperProps extends ViewStateProps {
+    bisBaseClass: string;
+    emphasizeElementsProps?: EmphasizeElementsProps;
+}
+/** SavedView class. Used to serialize/deserialize a ViewState.
+ * @public
+ */
+export declare class ViewStateHelper {
+    /** Create a ViewState from the SavedView */
+    static viewStateFromProps(iModelConnection: IModelConnection, savedViewProps: ViewStateHelperProps): Promise<ViewState | undefined>;
+    /** Apply EmphasizeElements from the SavedView */
+    static emphasizeElementsFromProps(vp: ScreenViewport, savedViewProps: ViewStateHelperProps): boolean;
+    /** Create props for a ViewState */
+    static viewStateToProps(viewState: ViewState): ViewStateHelperProps;
+    /** Create props for an EmphasizeElements and store in SavedViewProps */
+    static emphasizeElementsToProps(vp: ScreenViewport, savedViewProps: ViewStateHelperProps): void;
+}
 //# sourceMappingURL=ViewStateHelper.d.ts.map

package/lib/cjs/appui-react/content/ViewStateHelper.js

@@ -1,51 +1,51 @@
-"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 ContentView
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewStateHelper = void 0;
-const core_frontend_1 = require("@itwin/core-frontend");
-const ViewUtilities_1 = require("../utils/ViewUtilities");
-/** SavedView class. Used to serialize/deserialize a ViewState.
- * @public
- */
-class ViewStateHelper {
-    /** Create a ViewState from the SavedView */
-    static async viewStateFromProps(iModelConnection, savedViewProps) {
-        const className = savedViewProps.viewDefinitionProps.classFullName;
-        const ctor = await iModelConnection.findClassFor(className, undefined);
-        // istanbul ignore next
-        if (undefined === ctor)
-            throw new Error(`Invalid ViewState class name of [${className}]`);
-        const viewState = ctor.createFromProps(savedViewProps, iModelConnection);
-        await viewState.load(); // loads models for ModelSelector
-        return viewState;
-    }
-    /** Apply EmphasizeElements from the SavedView */
-    static emphasizeElementsFromProps(vp, savedViewProps) {
-        let changed = false;
-        if (savedViewProps.emphasizeElementsProps) {
-            const emphasizeElements = new core_frontend_1.EmphasizeElements();
-            changed = emphasizeElements.fromJSON(savedViewProps.emphasizeElementsProps, vp);
-        }
-        return changed;
-    }
-    /** Create props for a ViewState */
-    static viewStateToProps(viewState) {
-        const savedViewProps = viewState.toProps();
-        savedViewProps.bisBaseClass = ViewUtilities_1.ViewUtilities.getBisBaseClass(viewState.classFullName);
-        return savedViewProps;
-    }
-    /** Create props for an EmphasizeElements and store in SavedViewProps */
-    static emphasizeElementsToProps(vp, savedViewProps) {
-        const ee = core_frontend_1.EmphasizeElements.get(vp);
-        const emphasizeElementsProps = ee ? ee.toJSON(vp) : undefined;
-        savedViewProps.emphasizeElementsProps = emphasizeElementsProps;
-    }
-}
-exports.ViewStateHelper = ViewStateHelper;
+"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 ContentView
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewStateHelper = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const ViewUtilities_1 = require("../utils/ViewUtilities");
+/** SavedView class. Used to serialize/deserialize a ViewState.
+ * @public
+ */
+class ViewStateHelper {
+    /** Create a ViewState from the SavedView */
+    static async viewStateFromProps(iModelConnection, savedViewProps) {
+        const className = savedViewProps.viewDefinitionProps.classFullName;
+        const ctor = await iModelConnection.findClassFor(className, undefined);
+        // istanbul ignore next
+        if (undefined === ctor)
+            throw new Error(`Invalid ViewState class name of [${className}]`);
+        const viewState = ctor.createFromProps(savedViewProps, iModelConnection);
+        await viewState.load(); // loads models for ModelSelector
+        return viewState;
+    }
+    /** Apply EmphasizeElements from the SavedView */
+    static emphasizeElementsFromProps(vp, savedViewProps) {
+        let changed = false;
+        if (savedViewProps.emphasizeElementsProps) {
+            const emphasizeElements = new core_frontend_1.EmphasizeElements();
+            changed = emphasizeElements.fromJSON(savedViewProps.emphasizeElementsProps, vp);
+        }
+        return changed;
+    }
+    /** Create props for a ViewState */
+    static viewStateToProps(viewState) {
+        const savedViewProps = viewState.toProps();
+        savedViewProps.bisBaseClass = ViewUtilities_1.ViewUtilities.getBisBaseClass(viewState.classFullName);
+        return savedViewProps;
+    }
+    /** Create props for an EmphasizeElements and store in SavedViewProps */
+    static emphasizeElementsToProps(vp, savedViewProps) {
+        const ee = core_frontend_1.EmphasizeElements.get(vp);
+        const emphasizeElementsProps = ee ? ee.toJSON(vp) : undefined;
+        savedViewProps.emphasizeElementsProps = emphasizeElementsProps;
+    }
+}
+exports.ViewStateHelper = ViewStateHelper;
 //# sourceMappingURL=ViewStateHelper.js.map

package/lib/cjs/appui-react/content/ViewportContentControl.d.ts

@@ -1,62 +1,62 @@
-/** @packageDocumentation
- * @module ContentView
- */
-/// <reference types="react" />
-import { Id64String } from "@itwin/core-bentley";
-import { IModelConnection, ScreenViewport, ViewState } from "@itwin/core-frontend";
-import { ConfigurableCreateInfo, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
-import { ContentControl, SupportsViewSelectorChange } from "./ContentControl";
-/**
- * The base class for frontstage Viewport content controls that connects to a `ScreenViewport`
- * that is managed by the `ViewManager`.
- * @public
- */
-export declare class ViewportContentControl extends ContentControl implements SupportsViewSelectorChange {
-    private _viewport;
-    private _isReady;
-    private _viewportReadyCallback?;
-    /** Creates an instance of ViewportContentControl.
-     * @param info         An object that the subclass must pass to this base class.
-     * @param options      Options provided via the applicationData in a [[ContentProps]].
-     */
-    constructor(info: ConfigurableCreateInfo, options: any);
-    /** Gets the type of ConfigurableUiControl, which is 'Viewport' in this case */
-    getType(): ConfigurableUiControlType;
-    /** Returns true if this control is a Viewport control. */
-    get isViewport(): boolean;
-    /** The underlying ScreenViewport */
-    get viewport(): ScreenViewport | undefined;
-    set viewport(v: ScreenViewport | undefined);
-    /** Returns a promise that resolves when the control is ready for usage.
-     */
-    setIsReady(): void;
-    /** Returns a promise that resolves when the control is ready for usage.
-     */
-    get isReady(): Promise<void>;
-    /** Called when this ContentControl is activated */
-    onActivated(): void;
-    /** Get the NavigationAidControl associated with this ContentControl */
-    get navigationAidControl(): string;
-    /**
-     * Fetches appropriate NavigationAid based on the class of the current viewport.
-     * @param classFullName The full name of the current viewport class.
-     * @returns The ID of the navigation aid to be displayed.
-     */
-    private _getNavigationAid;
-    /** Returns true if this control supports processing ViewSelector changes. */
-    get supportsViewSelectorChange(): boolean;
-    /** Process a ViewSelector change. */
-    processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void>;
-    /** Get the React.Element for a ViewSelector change. */
-    getReactElementForViewSelectorChange(_iModel: IModelConnection, _viewDefinitionId: Id64String, _viewState: ViewState, _name: string): React.ReactNode;
-}
-/**
- * @beta
- */
-export declare class FloatingViewportContentControl extends ViewportContentControl {
-    constructor(uniqueId: string, name: string, node: React.ReactNode);
-    /** The React node associated with this control. */
-    get reactNode(): React.ReactNode;
-    set reactNode(r: React.ReactNode);
-}
+/** @packageDocumentation
+ * @module ContentView
+ */
+/// <reference types="react" />
+import { Id64String } from "@itwin/core-bentley";
+import { IModelConnection, ScreenViewport, ViewState } from "@itwin/core-frontend";
+import { ConfigurableCreateInfo, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { ContentControl, SupportsViewSelectorChange } from "./ContentControl";
+/**
+ * The base class for frontstage Viewport content controls that connects to a `ScreenViewport`
+ * that is managed by the `ViewManager`.
+ * @public
+ */
+export declare class ViewportContentControl extends ContentControl implements SupportsViewSelectorChange {
+    private _viewport;
+    private _isReady;
+    private _viewportReadyCallback?;
+    /** Creates an instance of ViewportContentControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided via the applicationData in a [[ContentProps]].
+     */
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** Gets the type of ConfigurableUiControl, which is 'Viewport' in this case */
+    getType(): ConfigurableUiControlType;
+    /** Returns true if this control is a Viewport control. */
+    get isViewport(): boolean;
+    /** The underlying ScreenViewport */
+    get viewport(): ScreenViewport | undefined;
+    set viewport(v: ScreenViewport | undefined);
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    setIsReady(): void;
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    get isReady(): Promise<void>;
+    /** Called when this ContentControl is activated */
+    onActivated(): void;
+    /** Get the NavigationAidControl associated with this ContentControl */
+    get navigationAidControl(): string;
+    /**
+     * Fetches appropriate NavigationAid based on the class of the current viewport.
+     * @param classFullName The full name of the current viewport class.
+     * @returns The ID of the navigation aid to be displayed.
+     */
+    private _getNavigationAid;
+    /** Returns true if this control supports processing ViewSelector changes. */
+    get supportsViewSelectorChange(): boolean;
+    /** Process a ViewSelector change. */
+    processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void>;
+    /** Get the React.Element for a ViewSelector change. */
+    getReactElementForViewSelectorChange(_iModel: IModelConnection, _viewDefinitionId: Id64String, _viewState: ViewState, _name: string): React.ReactNode;
+}
+/**
+ * @beta
+ */
+export declare class FloatingViewportContentControl extends ViewportContentControl {
+    constructor(uniqueId: string, name: string, node: React.ReactNode);
+    /** The React node associated with this control. */
+    get reactNode(): React.ReactNode;
+    set reactNode(r: React.ReactNode);
+}
 //# sourceMappingURL=ViewportContentControl.d.ts.map