@itwin/core-common 5.0.0-dev.99 → 5.1.0-dev.1

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Wed, 02 Apr 2025 19:38:36 GMT and should not be manually modified.
+This log was last generated on Thu, 10 Apr 2025 17:50:15 GMT and should not be manually modified.
+
+## 4.10.13
+Thu, 10 Apr 2025 17:47:21 GMT
+
+_Version update only_
 
 ## 4.10.12
 Wed, 02 Apr 2025 19:35:47 GMT

package/lib/cjs/CatalogIModel.d.ts

@@ -0,0 +1,152 @@
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { Id64String, ITwinError } from "@itwin/core-bentley";
+import { LocalFileName } from "./ChangesetProps";
+import { IModelConnectionProps, SnapshotOpenOptions } from "./IModel";
+/**
+ * Errors produced by the [[CatalogIModel]] API.
+ * @beta
+ */
+export declare namespace CatalogError {
+    const scope = "itwin-Catalog";
+    type Key = "invalid-seed-catalog" | "manifest-missing";
+    /** Determine whether an error object is a CatalogError */
+    function isError(error: unknown, key?: Key): error is ITwinError;
+    /** Instantiate and throw a CatalogError */
+    function throwError<T extends ITwinError>(key: Key, e: Omit<T, "name" | "iTwinErrorId">): never;
+}
+/** A "catalog iModel" is an [[IModel]] containing elements (e.g., component definitions) that are intended to be copied into another iModel by applications.
+ * They can be stored in [BlobContainer]($backend)s managed by a "reference data service" that uses [semantic versioning](https://semver.org/), much like [WorkspaceDb]($backend)s.
+ * @see [CatalogDb]($backend) to interact with catalog iModels on the backend
+ * @see [CatalogConnection]($frontend) to interact with catalog iModels on the frontend.
+ * @beta
+ */
+export declare namespace CatalogIModel {
+    /** Metadata describing a catalog iModel.
+     * @note Only the [[catalogName]] field is required, and users may add additional fields for their own purposes.
+     * @note The manifest is stored inside of the CatalogIModel, so it is versioned along with the rest of the catalog's contents.
+     * @beta
+     */
+    interface Manifest {
+        /** The iTwinId for the Catalog */
+        readonly iTwinId?: Id64String;
+        /**
+         * The name of the Catalog to be shown in user interfaces. Organizations should attempt to make this name informative enough
+         * so that uses may refer to it in conversations. It should also be unique enough that there's no confusion when it appears in
+         * lists of catalogs.
+         * @note it is possible and valid to change the catalogName between versions of a CatalogIModel (e.g. incorporating a date).
+         */
+        readonly catalogName: string;
+        /** A description of the contents of this catalog to help users understand its purpose and appropriate usage. */
+        readonly description?: string;
+        /** The name of the person to contact with questions about this catalog */
+        readonly contactName?: string;
+        /** The name of the person who last modified this catalog. */
+        lastEditedBy?: string;
+    }
+    /** Arguments for creating a new [BlobContainer]($backend) that holds (versions of) a CatalogIModel. */
+    interface CreateNewContainerArgs {
+        /** supplies the iTwinId for the new container */
+        readonly iTwinId: Id64String;
+        /** metadata stored with the new container */
+        readonly metadata: {
+            /** a "name" for the Catalog container. Should be long enough to be unique, but this is not enforced. */
+            label: string;
+            /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */
+            description?: string;
+            /** optional properties for the container */
+            json?: {
+                [key: string]: any;
+            };
+        };
+        /** The manifest to be stored in the catalog */
+        readonly manifest: Manifest;
+        /** The name for the CatalogIModel database within the container. May not contain a version. Default is "catalog-db" */
+        readonly dbName?: string;
+        /** version for the catalog created [[localCatalogFile]]. Defaults to "0.0.0" */
+        readonly version?: string;
+        /** A filename on the local computer of the "seed" CatalogIModel to be uploaded into the new container */
+        readonly localCatalogFile: LocalFileName;
+    }
+    /** Properties of a newly created container created from [[CatalogIModel.CreateNewContainerArgs]]. Most importantly, this holds the ContainerId of the new container. */
+    interface NewContainerProps {
+        /** The ContainerId of the new container (usually a [Guid]($bentley)). Applications should store this value to access the container via the CatalogIModel apis. */
+        readonly containerId: string;
+        /** the uri of the BlobContainer service where the new container resides. */
+        readonly baseUri: string;
+        /** name of the blob storage provider. */
+        readonly provider: "azure" | "google";
+    }
+    /** Properties to identify a specific CatalogIModel within a container. */
+    interface NameAndVersion {
+        /** The name of the catalog database. Defaults to "catalog-db" for CatalogIModels stored in cloud containers. */
+        readonly dbName?: string;
+        /** The range of acceptable versions of the database of the specified [[dbName]].
+         * If not present, defaults to the newest available version.
+         */
+        readonly version?: VersionRange;
+    }
+    /** Arguments to open an existing version of a CatalogIModel. */
+    interface OpenArgs extends NameAndVersion, SnapshotOpenOptions {
+        /** The ContainerId of the cloud container. If not present, dbName is the name of a file on the local computer. */
+        containerId?: string;
+        /** If true, attempt to synchronize the container with any changes in the cloud. Since this automatically happens the first time a
+         * container is accessed within a session, this is usually not necessary except for tests.
+         */
+        syncWithCloud?: boolean;
+        /** Start a prefetch operation on the CatalogIModel as it is opened. */
+        prefetch?: boolean;
+    }
+    /** Arguments to create a new version of a CatalogIModel from (a copy of) an existing version in a cloud container. */
+    interface CreateNewVersionArgs {
+        /** The id of cloud container. */
+        readonly containerId: string;
+        /** the source version of the CatalogIModel, from which the new version will copied. */
+        readonly fromDb: NameAndVersion;
+        /** The type of version increment to apply to the source version. */
+        readonly versionType: "major" | "minor" | "patch" | "premajor" | "preminor" | "prepatch" | "prerelease";
+        /** For prerelease versions, a string that becomes part of the version name. */
+        readonly identifier?: string;
+    }
+    /** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable [[CatalogIModel]]s,
+     * e.g., ">=1.2.7 <1.3.0".
+     */
+    type VersionRange = string;
+    /** The name of the ipc channel for [[IpcMethods]]
+     * @internal
+     */
+    type IpcChannel = "catalogIModel/ipc";
+    /** @internal */
+    interface IpcMethods {
+        /** create a new container from the BlobContainerService for holding a CatalogIModel. Also uploads the seed file */
+        createNewContainer(args: CreateNewContainerArgs): Promise<NewContainerProps>;
+        /** Acquire the write lock for a CatalogIModel container. */
+        acquireWriteLock(args: {
+            containerId: string;
+            username: string;
+        }): Promise<void>;
+        /** Release the write lock for a CatalogIModel container. */
+        releaseWriteLock(args: {
+            containerId: string;
+            abandon?: true;
+        }): Promise<void>;
+        /** create a new version of a CatalogIModel from an existing version. */
+        createNewVersion(args: CreateNewVersionArgs): Promise<{
+            oldDb: NameAndVersion;
+            newDb: NameAndVersion;
+        }>;
+        /** Attempt to open a CatalogIModel readonly*/
+        openReadonly(args: OpenArgs): Promise<IModelConnectionProps>;
+        /** Attempt to open a CatalogIModel for editing */
+        openEditable(args: OpenArgs): Promise<IModelConnectionProps>;
+        /** Get the manifest and version number for an open CatalogConnection. */
+        getInfo(key: string): Promise<{
+            manifest?: CatalogIModel.Manifest;
+            version: string;
+        }>;
+        /** Update the manifest stored in an open EditableCatalog */
+        updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;
+    }
+}
+//# sourceMappingURL=CatalogIModel.d.ts.map

package/lib/cjs/CatalogIModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogIModel.d.ts","sourceRoot":"","sources":["../../src/CatalogIModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEtE;;;GAGG;AACH,yBAAiB,YAAY,CAAC;IACrB,MAAM,KAAK,kBAAkB,CAAC;IAErC,KAAY,GAAG,GACb,sBAAsB,GACtB,kBAAkB,CAAC;IAErB,0DAA0D;IAC1D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;IAED,2CAA2C;IAC3C,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;;;GAKG;AACH,yBAAiB,aAAa,CAAC;IAE7B;;;;OAIG;IACH,UAAiB,QAAQ;QACvB,kCAAkC;QAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;QAE9B;;;;;WAKG;QACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,gHAAgH;QAChH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B,0EAA0E;QAC1E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B,6DAA6D;QAC7D,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED,uGAAuG;IACvG,UAAiB,sBAAsB;QACrC,iDAAiD;QACjD,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;QAC7B,6CAA6C;QAC7C,QAAQ,CAAC,QAAQ,EAAE;YACjB,wGAAwG;YACxG,KAAK,EAAE,MAAM,CAAC;YACd,kKAAkK;YAClK,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,4CAA4C;YAC5C,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAC;SAC/B,CAAA;QAED,+CAA+C;QAC/C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC5B,uHAAuH;QACvH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,gFAAgF;QAChF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAC1B,yGAAyG;QACzG,QAAQ,CAAC,gBAAgB,EAAE,aAAa,CAAC;KAC1C;IAED,wKAAwK;IACxK,UAAiB,iBAAiB;QAChC,kKAAkK;QAClK,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,4EAA4E;QAC5E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,yCAAyC;QACzC,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;KACvC;IAED,0EAA0E;IAC1E,UAAiB,cAAc;QAC7B,gHAAgH;QAChH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;KACjC;IAED,gEAAgE;IAChE,UAAiB,QAAS,SAAQ,cAAc,EAAE,mBAAmB;QACnE,kHAAkH;QAClH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,uEAAuE;QACvE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,sHAAsH;IACtH,UAAiB,oBAAoB;QACnC,iCAAiC;QACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,uFAAuF;QACvF,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC,oEAAoE;QACpE,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;QACxG,+EAA+E;QAC/E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;OAEG;IACH,KAAY,UAAU,GAAG,mBAAmB,CAAC;IAE7C,gBAAgB;IAChB,UAAiB,UAAU;QACzB,mHAAmH;QACnH,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC7E,4DAA4D;QAC5D,gBAAgB,CAAC,IAAI,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACjF,4DAA4D;QAC5D,gBAAgB,CAAC,IAAI,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,IAAI,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/E,wEAAwE;QACxE,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC;YAAE,KAAK,EAAE,cAAc,CAAC;YAAC,KAAK,EAAE,cAAc,CAAA;SAAE,CAAC,CAAC;QACxG,8CAA8C;QAC9C,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC7D,kDAAkD;QAClD,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC7D,yEAAyE;QACzE,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;YAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACtF,4DAA4D;QAC5D,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACrF;CACF"}

package/lib/cjs/CatalogIModel.js

@@ -0,0 +1,30 @@
+"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 NativeApp
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogError = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * Errors produced by the [[CatalogIModel]] API.
+ * @beta
+ */
+var CatalogError;
+(function (CatalogError) {
+    CatalogError.scope = "itwin-Catalog";
+    /** Determine whether an error object is a CatalogError */
+    function isError(error, key) {
+        return core_bentley_1.ITwinError.isError(error, CatalogError.scope, key);
+    }
+    CatalogError.isError = isError;
+    /** Instantiate and throw a CatalogError */
+    function throwError(key, e) {
+        core_bentley_1.ITwinError.throwError({ ...e, iTwinErrorId: { scope: CatalogError.scope, key } });
+    }
+    CatalogError.throwError = throwError;
+})(CatalogError || (exports.CatalogError = CatalogError = {}));
+//# sourceMappingURL=CatalogIModel.js.map

package/lib/cjs/CatalogIModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogIModel.js","sourceRoot":"","sources":["../../src/CatalogIModel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6D;AAI7D;;;GAGG;AACH,IAAiB,YAAY,CAgB5B;AAhBD,WAAiB,YAAY;IACd,kBAAK,GAAG,eAAe,CAAC;IAMrC,0DAA0D;IAC1D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAa,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,oBAAO,UAEtB,CAAA;IAED,2CAA2C;IAC3C,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,yBAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,uBAAU,aAEzB,CAAA;AACH,CAAC,EAhBgB,YAAY,4BAAZ,YAAY,QAgB5B","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/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { Id64String, ITwinError } from \"@itwin/core-bentley\";\nimport { LocalFileName } from \"./ChangesetProps\";\nimport { IModelConnectionProps, SnapshotOpenOptions } from \"./IModel\";\n\n/**\n * Errors produced by the [[CatalogIModel]] API.\n * @beta\n */\nexport namespace CatalogError {\n  export const scope = \"itwin-Catalog\";\n\n  export type Key =\n    \"invalid-seed-catalog\" |\n    \"manifest-missing\";\n\n  /** Determine whether an error object is a CatalogError */\n  export function isError(error: unknown, key?: Key): error is ITwinError {\n    return ITwinError.isError<ITwinError>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CatalogError */\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** A \"catalog iModel\" is an [[IModel]] containing elements (e.g., component definitions) that are intended to be copied into another iModel by applications.\n * They can be stored in [BlobContainer]($backend)s managed by a \"reference data service\" that uses [semantic versioning](https://semver.org/), much like [WorkspaceDb]($backend)s.\n * @see [CatalogDb]($backend) to interact with catalog iModels on the backend\n * @see [CatalogConnection]($frontend) to interact with catalog iModels on the frontend.\n * @beta\n */\nexport namespace CatalogIModel {\n\n  /** Metadata describing a catalog iModel.\n   * @note Only the [[catalogName]] field is required, and users may add additional fields for their own purposes.\n   * @note The manifest is stored inside of the CatalogIModel, so it is versioned along with the rest of the catalog's contents.\n   * @beta\n   */\n  export interface Manifest {\n    /** The iTwinId for the Catalog */\n    readonly iTwinId?: Id64String;\n\n    /**\n     * The name of the Catalog to be shown in user interfaces. Organizations should attempt to make this name informative enough\n     * so that uses may refer to it in conversations. It should also be unique enough that there's no confusion when it appears in\n     * lists of catalogs.\n     * @note it is possible and valid to change the catalogName between versions of a CatalogIModel (e.g. incorporating a date).\n     */\n    readonly catalogName: string;\n    /** A description of the contents of this catalog to help users understand its purpose and appropriate usage. */\n    readonly description?: string;\n    /** The name of the person to contact with questions about this catalog */\n    readonly contactName?: string;\n    /** The name of the person who last modified this catalog. */\n    lastEditedBy?: string;\n  }\n\n  /** Arguments for creating a new [BlobContainer]($backend) that holds (versions of) a CatalogIModel. */\n  export interface CreateNewContainerArgs {\n    /** supplies the iTwinId for the new container */\n    readonly iTwinId: Id64String;\n    /** metadata stored with the new container */\n    readonly metadata: {\n      /** a \"name\" for the Catalog container. Should be long enough to be unique, but this is not enforced. */\n      label: string;\n      /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n      description?: string;\n      /** optional properties for the container */\n      json?: { [key: string]: any };\n    }\n\n    /** The manifest to be stored in the catalog */\n    readonly manifest: Manifest;\n    /** The name for the CatalogIModel database within the container. May not contain a version. Default is \"catalog-db\" */\n    readonly dbName?: string,\n    /** version for the catalog created [[localCatalogFile]]. Defaults to \"0.0.0\" */\n    readonly version?: string;\n    /** A filename on the local computer of the \"seed\" CatalogIModel to be uploaded into the new container */\n    readonly localCatalogFile: LocalFileName;\n  }\n\n  /** Properties of a newly created container created from [[CatalogIModel.CreateNewContainerArgs]]. Most importantly, this holds the ContainerId of the new container. */\n  export interface NewContainerProps {\n    /** The ContainerId of the new container (usually a [Guid]($bentley)). Applications should store this value to access the container via the CatalogIModel apis. */\n    readonly containerId: string;\n    /** the uri of the BlobContainer service where the new container resides. */\n    readonly baseUri: string;\n    /** name of the blob storage provider. */\n    readonly provider: \"azure\" | \"google\";\n  }\n\n  /** Properties to identify a specific CatalogIModel within a container. */\n  export interface NameAndVersion {\n    /** The name of the catalog database. Defaults to \"catalog-db\" for CatalogIModels stored in cloud containers. */\n    readonly dbName?: string;\n    /** The range of acceptable versions of the database of the specified [[dbName]].\n     * If not present, defaults to the newest available version.\n     */\n    readonly version?: VersionRange;\n  }\n\n  /** Arguments to open an existing version of a CatalogIModel. */\n  export interface OpenArgs extends NameAndVersion, SnapshotOpenOptions {\n    /** The ContainerId of the cloud container. If not present, dbName is the name of a file on the local computer. */\n    containerId?: string;\n    /** If true, attempt to synchronize the container with any changes in the cloud. Since this automatically happens the first time a\n     * container is accessed within a session, this is usually not necessary except for tests.\n     */\n    syncWithCloud?: boolean;\n    /** Start a prefetch operation on the CatalogIModel as it is opened. */\n    prefetch?: boolean;\n  }\n\n  /** Arguments to create a new version of a CatalogIModel from (a copy of) an existing version in a cloud container. */\n  export interface CreateNewVersionArgs {\n    /** The id of cloud container. */\n    readonly containerId: string;\n    /** the source version of the CatalogIModel, from which the new version will copied. */\n    readonly fromDb: NameAndVersion;\n    /** The type of version increment to apply to the source version. */\n    readonly versionType: \"major\" | \"minor\" | \"patch\" | \"premajor\" | \"preminor\" | \"prepatch\" | \"prerelease\";\n    /** For prerelease versions, a string that becomes part of the version name. */\n    readonly identifier?: string;\n  }\n\n  /** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable [[CatalogIModel]]s,\n   * e.g., \">=1.2.7 <1.3.0\".\n   */\n  export type VersionRange = string;\n\n  /** The name of the ipc channel for [[IpcMethods]]\n   * @internal\n   */\n  export type IpcChannel = \"catalogIModel/ipc\";\n\n  /** @internal */\n  export interface IpcMethods {\n    /** create a new container from the BlobContainerService for holding a CatalogIModel. Also uploads the seed file */\n    createNewContainer(args: CreateNewContainerArgs): Promise<NewContainerProps>;\n    /** Acquire the write lock for a CatalogIModel container. */\n    acquireWriteLock(args: { containerId: string, username: string }): Promise<void>;\n    /** Release the write lock for a CatalogIModel container. */\n    releaseWriteLock(args: { containerId: string, abandon?: true }): Promise<void>;\n    /** create a new version of a CatalogIModel from an existing version. */\n    createNewVersion(args: CreateNewVersionArgs): Promise<{ oldDb: NameAndVersion, newDb: NameAndVersion }>;\n    /** Attempt to open a CatalogIModel readonly*/\n    openReadonly(args: OpenArgs): Promise<IModelConnectionProps>;\n    /** Attempt to open a CatalogIModel for editing */\n    openEditable(args: OpenArgs): Promise<IModelConnectionProps>;\n    /** Get the manifest and version number for an open CatalogConnection. */\n    getInfo(key: string): Promise<{ manifest?: CatalogIModel.Manifest, version: string }>;\n    /** Update the manifest stored in an open EditableCatalog */\n    updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;\n  }\n}\n"]}

package/lib/cjs/CesiumIonAssets.d.ts

@@ -0,0 +1,23 @@
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
+ * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
+ * You may alternatively use the Id of any ion asset to which you have access.
+ * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.
+ * @public
+ */
+export declare enum CesiumTerrainAssetId {
+    /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */
+    Default = "1",
+    /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */
+    Bathymetry = "2426648"
+}
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].
+ * @beta
+ */
+export declare enum CesiumIonAssetId {
+    /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */
+    OSMBuildings = "96188"
+}
+//# sourceMappingURL=CesiumIonAssets.d.ts.map

package/lib/cjs/CesiumIonAssets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CesiumIonAssets.d.ts","sourceRoot":"","sources":["../../src/CesiumIonAssets.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,yGAAyG;IACzG,OAAO,MAAM;IACb,gJAAgJ;IAChJ,UAAU,YAAY;CACvB;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,oGAAoG;IACpG,YAAY,UAAU;CACvB"}

package/lib/cjs/CesiumIonAssets.js

@@ -0,0 +1,32 @@
+"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 DisplayStyles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CesiumIonAssetId = exports.CesiumTerrainAssetId = void 0;
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
+ * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
+ * You may alternatively use the Id of any ion asset to which you have access.
+ * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.
+ * @public
+ */
+var CesiumTerrainAssetId;
+(function (CesiumTerrainAssetId) {
+    /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */
+    CesiumTerrainAssetId["Default"] = "1";
+    /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */
+    CesiumTerrainAssetId["Bathymetry"] = "2426648";
+})(CesiumTerrainAssetId || (exports.CesiumTerrainAssetId = CesiumTerrainAssetId = {}));
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].
+ * @beta
+ */
+var CesiumIonAssetId;
+(function (CesiumIonAssetId) {
+    /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */
+    CesiumIonAssetId["OSMBuildings"] = "96188";
+})(CesiumIonAssetId || (exports.CesiumIonAssetId = CesiumIonAssetId = {}));
+//# sourceMappingURL=CesiumIonAssets.js.map

package/lib/cjs/CesiumIonAssets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CesiumIonAssets.js","sourceRoot":"","sources":["../../src/CesiumIonAssets.ts"],"names":[],"mappings":";AACA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;;GAKG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,yGAAyG;IACzG,qCAAa,CAAA;IACb,gJAAgJ;IAChJ,8CAAsB,CAAA;AACxB,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAED;;GAEG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,oGAAoG;IACpG,0CAAsB,CAAA;AACxB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\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/** @packageDocumentation\n * @module DisplayStyles\n */\n\n/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.\n * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to \"CesiumWorldTerrain\".\n * You may alternatively use the Id of any ion asset to which you have access.\n * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.\n * @public\n */\nexport enum CesiumTerrainAssetId {\n  /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */\n  Default = \"1\",\n  /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */\n  Bathymetry = \"2426648\",\n}\n\n/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].\n * @beta\n */\nexport enum CesiumIonAssetId {\n  /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */\n  OSMBuildings = \"96188\",\n}\n"]}

package/lib/cjs/ContourDisplay.d.ts

@@ -37,6 +37,8 @@ export declare class ContourStyle {
     readonly pattern: LinePixels;
     /** Returns true if `this` and `other` are logically equivalent. */
     equals(other: ContourStyle): boolean;
+    /** Perform ordered comparison between this and another contour style. */
+    compare(other: ContourStyle): number;
     /** Performs ordered comparison of two contour styles.
      * @param lhs First contour style to compare
      * @param rhs Second contour style to compare
@@ -96,7 +98,10 @@ export declare class Contour {
     /** If true, show underlying geometry along with the associated contours. If false, only show the contours, not the underlying geometry. Defaults to true. */
     readonly showGeometry: boolean;
     static readonly defaults: Contour;
+    /** Returns true if `this` is logically equivalent to `other`. */
     equals(other: Contour): boolean;
+    /** Performs ordered comparison between this and another contour. */
+    compare(other: Contour): number;
     /** Performs ordered comparison of two contours.
        * @param lhs First contour to compare
        * @param rhs Second contour to compare
@@ -154,6 +159,8 @@ export declare class ContourGroup {
     get isDefaultGroup(): boolean;
     /** Returns true if `this` and `other` contain the exact same set of subcategories. */
     subCategoriesEqual(other: ContourGroup): boolean;
+    /** Perform ordered comparison between this and another contour group. */
+    compare(other: ContourGroup): number;
     /** Returns true if `this` and `other` are logically equivalent, having the same styling, name, and set of subcategories. */
     equals(other: ContourGroup | undefined): boolean;
     private constructor();
@@ -199,6 +206,8 @@ export declare class ContourDisplay {
      * for display purposes.
      */
     static readonly maxContourGroups = 5;
+    /** Perform ordered comparison between this and another `ContourDisplay`. */
+    compare(other: ContourDisplay): number;
     /** Returns true if `this` and `other` are logically equivalent, having the same groups and styling. */
     equals(other: ContourDisplay): boolean;
     private constructor();

package/lib/cjs/ContourDisplay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContourDisplay.d.ts","sourceRoot":"","sources":["../../src/ContourDisplay.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAmC,iBAAiB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvI,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,kCAAkC;IAClC,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;AAE3E;;;;GAIG;AACH,qBAAa,YAAY;IACvB,oEAAoE;IACpE,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,uFAAuF;IACvF,SAAgB,OAAO,EAAE,UAAU,CAAC;IAEpC,mEAAmE;IAC5D,MAAM,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IAO3C;;;;;OAKG;WACW,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,GAAG,MAAM;IAYnE,OAAO;WAMO,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB;IAWzC,MAAM,IAAI,iBAAiB;IAelC,sHAAsH;WACxG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;IAI3E;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;CAM3E;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kCAAkC;IAClC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,6BAA6B;IAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0CAA0C;IAC1C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mCAAmC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAEjE;;;;;;;;;GASG;AACH,qBAAa,OAAO;IAClB,iLAAiL;IACjL,SAAgB,UAAU,EAAE,YAAY,CAAC;IACzC,qJAAqJ;IACrJ,SAAgB,UAAU,EAAE,YAAY,CAAC;IACzC,mLAAmL;IACnL,SAAgB,aAAa,EAAE,MAAM,CAAC;IACtC,6UAA6U;IAC7U,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAC3C,6JAA6J;IAC7J,SAAgB,YAAY,EAAE,OAAO,CAAC;IAEtC,gBAAuB,QAAQ,UAAmB;IAE3C,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAOtC;;;;SAIK;WACS,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,MAAM;IAQzD,OAAO;WAQO,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY;IAapC,MAAM,IAAI,YAAY;IAqB7B,iHAAiH;WACnG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO;IAIjE;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO;CAMjE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,0CAA0C;IAC1C,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;AAE3E;;;;;;GAMG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,cAAc,CAAoB;IAE1C,mGAAmG;IACnG,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAW,aAAa,IAAI,mBAAmB,CAE9C;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,sFAAsF;IAC/E,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IAIvD,4HAA4H;IACrH,MAAM,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO;IAcvD,OAAO;WAMO,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB;IAWzC,MAAM,IAAI,iBAAiB;IAalC,sHAAsH;WACxG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;IAI3E;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;CAM3E;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC7B,8CAA8C;IAC9C,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,uBAAuB,CAAC,cAAc,CAAC,CAAC;AAE/E;;;;GAIG;AACH,qBAAa,cAAc;IACzB;;;OAGG;IACH,SAAgB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvC;;OAEG;IACH,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC;;OAEG;IACH,gBAAuB,gBAAgB,KAAK;IAE5C,uGAAuG;IAChG,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;IAa7C,OAAO;WAKO,QAAQ,CAAC,KAAK,CAAC,EAAE,mBAAmB;IAiB3C,MAAM,IAAI,mBAAmB;IAYpC,wHAAwH;WAC1G,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,cAAc;IAI/E,yFAAyF;IAClF,mBAAmB,CAAC,eAAe,EAAE,OAAO,GAAG,cAAc;IAIpE;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,cAAc;CAM/E"}
+{"version":3,"file":"ContourDisplay.d.ts","sourceRoot":"","sources":["../../src/ContourDisplay.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkE,iBAAiB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACtK,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,kCAAkC;IAClC,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;AAE3E;;;;GAIG;AACH,qBAAa,YAAY;IACvB,oEAAoE;IACpE,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,uFAAuF;IACvF,SAAgB,OAAO,EAAE,UAAU,CAAC;IAEpC,mEAAmE;IAC5D,MAAM,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IAO3C,yEAAyE;IAClE,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM;IAI3C;;;;;OAKG;WACW,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,GAAG,MAAM;IAYnE,OAAO;WAMO,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB;IAWzC,MAAM,IAAI,iBAAiB;IAelC,sHAAsH;WACxG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;IAI3E;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;CAM3E;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kCAAkC;IAClC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,6BAA6B;IAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0CAA0C;IAC1C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mCAAmC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAEjE;;;;;;;;;GASG;AACH,qBAAa,OAAO;IAClB,iLAAiL;IACjL,SAAgB,UAAU,EAAE,YAAY,CAAC;IACzC,qJAAqJ;IACrJ,SAAgB,UAAU,EAAE,YAAY,CAAC;IACzC,mLAAmL;IACnL,SAAgB,aAAa,EAAE,MAAM,CAAC;IACtC,6UAA6U;IAC7U,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAC3C,6JAA6J;IAC7J,SAAgB,YAAY,EAAE,OAAO,CAAC;IAEtC,gBAAuB,QAAQ,UAAmB;IAElD,iEAAiE;IAC1D,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAItC,oEAAoE;IAC7D,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAItC;;;;SAIK;WACS,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,MAAM;IAQzD,OAAO;WAQO,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY;IAapC,MAAM,IAAI,YAAY;IAqB7B,iHAAiH;WACnG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO;IAIjE;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO;CAMjE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,0CAA0C;IAC1C,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;AAE3E;;;;;;GAMG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,cAAc,CAAoB;IAE1C,mGAAmG;IACnG,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAW,aAAa,IAAI,mBAAmB,CAE9C;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,sFAAsF;IAC/E,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IAIvD,yEAAyE;IAClE,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM;IAI3C,4HAA4H;IACrH,MAAM,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO;IAIvD,OAAO;WAMO,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB;IAWzC,MAAM,IAAI,iBAAiB;IAalC,sHAAsH;WACxG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;IAI3E;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,YAAY;CAM3E;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC7B,8CAA8C;IAC9C,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,uBAAuB,CAAC,cAAc,CAAC,CAAC;AAE/E;;;;GAIG;AACH,qBAAa,cAAc;IACzB;;;OAGG;IACH,SAAgB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvC;;OAEG;IACH,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC;;OAEG;IACH,gBAAuB,gBAAgB,KAAK;IAE5C,4EAA4E;IACrE,OAAO,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM;IAI7C,uGAAuG;IAChG,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;IAa7C,OAAO;WAKO,QAAQ,CAAC,KAAK,CAAC,EAAE,mBAAmB;IAiB3C,MAAM,IAAI,mBAAmB;IAYpC,wHAAwH;WAC1G,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,cAAc;IAI/E,yFAAyF;IAClF,mBAAmB,CAAC,eAAe,EAAE,OAAO,GAAG,cAAc;IAIpE;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,cAAc;CAM/E"}

package/lib/cjs/ContourDisplay.js

@@ -33,6 +33,10 @@ class ContourStyle {
         }
         return true;
     }
+    /** Perform ordered comparison between this and another contour style. */
+    compare(other) {
+        return ContourStyle.compare(this, other);
+    }
     /** Performs ordered comparison of two contour styles.
      * @param lhs First contour style to compare
      * @param rhs Second contour style to compare
@@ -109,11 +113,13 @@ class Contour {
     /** If true, show underlying geometry along with the associated contours. If false, only show the contours, not the underlying geometry. Defaults to true. */
     showGeometry;
     static defaults = new Contour({});
+    /** Returns true if `this` is logically equivalent to `other`. */
     equals(other) {
-        if (!this.majorStyle.equals(other.majorStyle) || !this.minorStyle.equals(other.minorStyle) || this.minorInterval !== other.minorInterval || this.majorIntervalCount !== other.majorIntervalCount || this.showGeometry !== other.showGeometry) {
-            return false;
-        }
-        return true;
+        return this.compare(other) === 0;
+    }
+    /** Performs ordered comparison between this and another contour. */
+    compare(other) {
+        return Contour.compare(this, other);
     }
     /** Performs ordered comparison of two contours.
        * @param lhs First contour to compare
@@ -204,19 +210,13 @@ class ContourGroup {
     subCategoriesEqual(other) {
         return this._subCategories === other._subCategories;
     }
+    /** Perform ordered comparison between this and another contour group. */
+    compare(other) {
+        return (0, core_bentley_1.compareStrings)(this.name, other.name) || (0, core_bentley_1.compareStrings)(this._subCategories, other._subCategories) || this.contourDef.compare(other.contourDef);
+    }
     /** Returns true if `this` and `other` are logically equivalent, having the same styling, name, and set of subcategories. */
     equals(other) {
-        if (this === undefined && other === undefined)
-            return true;
-        if (this === undefined || other === undefined)
-            return false;
-        if (!this.contourDef.equals(other.contourDef))
-            return false;
-        if (this._subCategories !== other._subCategories)
-            return false;
-        if (this.name !== other.name)
-            return false;
-        return true;
+        return undefined !== other && this.compare(other) === 0;
     }
     constructor(props) {
         this.contourDef = props?.contourDef ?? Contour.fromJSON();
@@ -274,6 +274,10 @@ class ContourDisplay {
      * for display purposes.
      */
     static maxContourGroups = 5;
+    /** Perform ordered comparison between this and another `ContourDisplay`. */
+    compare(other) {
+        return (0, core_bentley_1.compareBooleans)(this.displayContours, other.displayContours) || (0, core_bentley_1.compareArrays)(this.groups, other.groups, (lhs, rhs) => lhs.compare(rhs));
+    }
     /** Returns true if `this` and `other` are logically equivalent, having the same groups and styling. */
     equals(other) {
         if (this.displayContours !== other.displayContours)

package/lib/cjs/ContourDisplay.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContourDisplay.js","sourceRoot":"","sources":["../../src/ContourDisplay.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuI;AACvI,6CAA0C;AAC1C,yCAAqD;AAoBrD;;;;GAIG;AACH,MAAa,YAAY;IACvB,oEAAoE;IACpD,KAAK,CAAW;IAChC;;;OAGG;IACa,UAAU,CAAS;IACnC,uFAAuF;IACvE,OAAO,CAAa;IAEpC,mEAAmE;IAC5D,MAAM,CAAC,KAAmB;QAC/B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YAC9G,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,GAAiB,EAAE,GAAiB;QACxD,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC;YAC/D,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC;YACzD,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAoB,KAAuC;QACzD,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,mBAAQ,CAAC,QAAQ,CAAC,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC;QACnE,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,uBAAU,CAAC,KAAK,CAAC;IACpD,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAyB;QAC9C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,YAAY,EAAE,CAAC;QAE5B,OAAO,IAAI,IAAI,CAAC;YACd,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;YAChE,UAAU,EAAE,KAAK,EAAE,UAAU;YAC7B,OAAO,EAAE,KAAK,EAAE,OAAO;SACxB,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,mBAAQ,CAAC,QAAQ,CAAC,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC;YAC3D,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sHAAsH;IAC/G,MAAM,CAAC,MAAM,CAAC,KAAuC;QAC1D,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA8C;QACzD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,YAAY,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAnFD,oCAmFC;AAwBD;;;;;;;;;GASG;AACH,MAAa,OAAO;IAClB,iLAAiL;IACjK,UAAU,CAAe;IACzC,qJAAqJ;IACrI,UAAU,CAAe;IACzC,mLAAmL;IACnK,aAAa,CAAS;IACtC,6UAA6U;IAC7T,kBAAkB,CAAS;IAC3C,6JAA6J;IAC7I,YAAY,CAAU;IAE/B,MAAM,CAAU,QAAQ,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC,CAAC;IAE3C,MAAM,CAAC,KAAc;QAC1B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAK,IAAI,CAAC,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,EAAE,CAAC;YAC9O,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;SAIK;IACE,MAAM,CAAC,OAAO,CAAC,GAAY,EAAE,GAAY;QAC9C,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;eACtD,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;eACpD,IAAA,6BAAc,EAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,aAAa,CAAC;eACpD,IAAA,6BAAc,EAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,kBAAkB,CAAC;eAC9D,IAAA,8BAAe,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED,YAAoB,KAAkC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC/D,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,kBAAkB,GAAG,KAAK,EAAE,kBAAkB,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,IAAI,CAAC;IAClD,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAoB;QACzC,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,OAAO,EAAE,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;YACnF,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;YACnF,aAAa,EAAE,KAAK,EAAE,aAAa;YACnC,kBAAkB,EAAE,KAAK,EAAE,kBAAkB;YAC7C,YAAY,EAAE,KAAK,EAAE,YAAY;SAClC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAiB,EAAE,CAAC;QAE/B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;YACnE,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YAClD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,IAAI,CAAC,KAAK,IAAI,CAAC,aAAa;YAC1B,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAE3C,IAAI,CAAC,KAAK,IAAI,CAAC,kBAAkB;YAC/B,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAErD,IAAI,IAAI,KAAK,IAAI,CAAC,YAAY;YAC5B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,iHAAiH;IAC1G,MAAM,CAAC,MAAM,CAAC,KAAkC;QACrD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAyC;QACpD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IACtD,CAAC;;AAzFH,0BA0FC;AAoBD;;;;;;GAMG;AACH,MAAa,YAAY;IACf,cAAc,CAAoB;IAE1C,mGAAmG;IACnF,UAAU,CAAU;IACpC;;OAEG;IACa,IAAI,CAAS;IAE7B;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,gCAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,kCAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC7D,CAAC;IAED,sFAAsF;IAC/E,kBAAkB,CAAC,KAAmB;QAC3C,OAAO,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,CAAC;IACtD,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,KAA+B;QAC3C,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;YAC3C,OAAO,IAAI,CAAC;QACd,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;YAC3C,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;YAC3C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;YAC9C,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC1B,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAoB,KAAuC;QACzD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC1D,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzG,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,EAAE,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAyB;QAC9C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,YAAY,EAAE,CAAC;QAE5B,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;YAC9E,IAAI,EAAE,KAAK,EAAE,IAAI;YACjB,aAAa,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;SAClG,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC3C,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,IAAI,IAAI,CAAC,IAAI;YACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAEzB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sHAAsH;IAC/G,MAAM,CAAC,MAAM,CAAC,KAAuC;QAC1D,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA8C;QACzD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,YAAY,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAxFD,oCAwFC;AAkBD;;;;GAIG;AACH,MAAa,cAAc;IACzB;;;OAGG;IACa,MAAM,CAAiB;IACvC;;OAEG;IACa,eAAe,CAAU;IACzC;;OAEG;IACI,MAAM,CAAU,gBAAgB,GAAG,CAAC,CAAC;IAE5C,uGAAuG;IAChG,MAAM,CAAC,KAAqB;QACjC,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;YAChD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CAAC,MAAM;YAC5C,OAAO,KAAK,CAAC;QACf,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,cAAc,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,CAAC;YAC9G,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,IAAI,CAAC,KAAK;gBACR,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAoB,KAAyC;QAC3D,IAAI,CAAC,eAAe,GAAG,KAAK,EAAE,eAAe,IAAI,KAAK,CAAC;QACvD,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC;IACpC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA2B;QAChD,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,cAAc,EAAE,CAAC;QAE9B,MAAM,MAAM,GAAmB,EAAE,CAAC;QAClC,IAAI,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7C,MAAM,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,IAAI,CAAC;YACd,eAAe,EAAE,KAAK,EAAE,eAAe;YACvC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC5C,CAAC;QAED,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wHAAwH;IACjH,MAAM,CAAC,MAAM,CAAC,KAAyC;QAC5D,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC;IACxD,CAAC;IAED,yFAAyF;IAClF,mBAAmB,CAAC,eAAwB;QACjD,OAAO,eAAe,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IAC/G,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAgD;QAC3D,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,cAAc,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC7D,CAAC;;AAjFH,wCAkFC","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/** @packageDocumentation\n * @module Symbology\n */\n\nimport { compareBooleans, compareNumbers, CompressedId64Set, NonFunctionPropertiesOf, OrderedId64Iterable } from \"@itwin/core-bentley\";\nimport { LinePixels } from \"./LinePixels\";\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\n\n/** JSON representation of a [[ContourStyle]].\n * @public\n */\nexport interface ContourStyleProps {\n  /** See [[ContourStyle.color]]. */\n  color?: RgbColorProps;\n  /** See [[ContourStyle.pixelWidth]]. */\n  pixelWidth?: number;\n  /** See [[ContourStyle.pattern]]. */\n  pattern?: LinePixels;\n}\n\n/** A type containing all of the properties of [[ContourStyle]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[ContourStyle.create]] and [[ContourStyle.clone]].\n * @public\n */\nexport type ContourStyleProperties = NonFunctionPropertiesOf<ContourStyle>;\n\n/** The style settings used by either a minor or major contour.\n * @see [[Contour.majorStyle]]\n * @see [[Contour.minorStyle]]\n * @public\n */\nexport class ContourStyle {\n  /** The color in which to draw the contour lines. Default: black. */\n  public readonly color: RgbColor;\n  /** The width in screen pixels of the contour lines.\n   * Useful values range between 1 and 8.5, in increments of 0.5. Other values will be rounded to meet these criteria.\n   * Default: 1.0.\n   */\n  public readonly pixelWidth: number;\n  /** The pattern for a major or minor contour line. Defaults to [[LinePixels.Solid]]. */\n  public readonly pattern: LinePixels;\n\n  /** Returns true if `this` and `other` are logically equivalent. */\n  public equals(other: ContourStyle): boolean {\n    if (!this.color.equals(other.color) || this.pixelWidth !== other.pixelWidth || this.pattern !== other.pattern) {\n      return false;\n    }\n    return true;\n  }\n\n  /** Performs ordered comparison of two contour styles.\n   * @param lhs First contour style to compare\n   * @param rhs Second contour style to compare\n   * @returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.\n   * @public\n   */\n  public static compare(lhs: ContourStyle, rhs: ContourStyle): number {\n    let diff = 0;\n    if ((diff = lhs.color.compareTo(rhs.color)) !== 0)\n      return diff;\n    if ((diff = compareNumbers(lhs.pixelWidth, rhs.pixelWidth)) !== 0)\n      return diff;\n    if ((diff = compareNumbers(lhs.pattern, rhs.pattern)) !== 0)\n      return diff;\n\n    return diff;\n  }\n\n  private constructor(props?: Partial<ContourStyleProperties>) {\n    this.color = props?.color ?? RgbColor.fromJSON({r: 0, g: 0, b: 0});\n    this.pixelWidth = props?.pixelWidth ?? 1;\n    this.pattern = props?.pattern ?? LinePixels.Solid;\n  }\n\n  public static fromJSON(props?: ContourStyleProps) {\n    if (!props)\n      return new ContourStyle();\n\n    return new this({\n      color: props?.color ? RgbColor.fromJSON(props.color) : undefined,\n      pixelWidth: props?.pixelWidth,\n      pattern: props?.pattern,\n    });\n  }\n\n  public toJSON(): ContourStyleProps {\n    const props: ContourStyleProps = {};\n\n    if (!this.color.equals(RgbColor.fromJSON({r: 0, g: 0, b: 0})))\n      props.color = this.color.toJSON();\n\n    if (1 !== this.pixelWidth)\n      props.pixelWidth = this.pixelWidth;\n\n    if (0 !== this.pattern)\n      props.pattern = this.pattern;\n\n    return props;\n  }\n\n  /** Create a new ContourStyle. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourStyleProperties>): ContourStyle {\n    return props ? new this(props) : new ContourStyle();\n  }\n\n  /** Create a copy of this ContourStyle, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourStyleProperties>): ContourStyle {\n    if (!changedProps)\n      return this;\n\n    return ContourStyle.create({ ...this, ...changedProps });\n  }\n}\n\n/** JSON representation of a [[Contour]].\n * @public\n */\nexport interface ContourProps {\n  /** See [[Contour.majorStyle]]. */\n  majorStyle?: ContourStyleProps;\n  /** See [[Contour.minor]]. */\n  minorStyle?: ContourStyleProps;\n  /** See [[Contour.minorInterval]]. */\n  minorInterval?: number;\n  /** See [[Contour.majorIntervalCount]]. */\n  majorIntervalCount?: number;\n  /** See [[Contour.showGeometry]] */\n  showGeometry?: boolean;\n}\n\n/** A type containing all of the properties of [[Contour]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[Contour.create]] and [[Contour.clone]].\n * @public\n */\nexport type ContourProperties = NonFunctionPropertiesOf<Contour>;\n\n/** Describes how to generate and style contour lines for geometry within a single [[ContourGroup]].\n * Contours provide a way to visualize elevation within a 3d scene by drawing lines at fixed intervals along the z-axis.\n * There are actually 2 kinds of contour lines: major and minor. Each kind can be styled independently.\n * A contour line is generated every [[minorInterval]] meters. Every `nth` line will be a *major* contour, where `n` = [[majorIntervalCount]]; the intervening lines will\n * all be *minor* contours.\n * For example, with a [[majorIntervalCount]] of `1`, every contour will be major; of `2`, every other contour will be major; and of `3`, there will be two minor contours in between\n * each major contour.\n *\n * @public\n */\nexport class Contour {\n  /** Settings that describe how a major contour is styled. Defaults to an instantation of [[ContourStyle]] using `pixelWidth` of 2 and default values for the other properties. */\n  public readonly majorStyle: ContourStyle;\n  /** Settings that describe how a minor contour is styled. Defaults to an instantation of [[ContourStyle]] using default values for the properties. */\n  public readonly minorStyle: ContourStyle;\n  /** The interval for the minor contour occurrence in meters; these can be specified as fractional. Defaults to 1. If a value <= 0 is specified, this will be treated as 1 meter. */\n  public readonly minorInterval: number;\n  /** The count of minor contour intervals that define a major interval (integer > 0). A value of 1 means no minor contours will be shown, only major contours. Defaults to 5. If a value < 1 is specified, this will be treated as 1. If a non-integer value is specified, it will be treated as if it were rounded to the nearest integer. */\n  public readonly majorIntervalCount: number;\n  /** If true, show underlying geometry along with the associated contours. If false, only show the contours, not the underlying geometry. Defaults to true. */\n  public readonly showGeometry: boolean;\n\n  public static readonly defaults = new Contour({});\n\n  public equals(other: Contour): boolean {\n    if (!this.majorStyle.equals(other.majorStyle) || !this.minorStyle.equals(other.minorStyle) || this.minorInterval !== other.minorInterval  || this.majorIntervalCount !== other.majorIntervalCount || this.showGeometry !== other.showGeometry) {\n      return false;\n    }\n    return true;\n  }\n\n  /** Performs ordered comparison of two contours.\n     * @param lhs First contour to compare\n     * @param rhs Second contour to compare\n     * @returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.\n     */\n  public static compare(lhs: Contour, rhs: Contour): number {\n    return ContourStyle.compare(lhs.majorStyle, rhs.majorStyle)\n      || ContourStyle.compare(lhs.minorStyle, rhs.minorStyle)\n      || compareNumbers(lhs.minorInterval, rhs.minorInterval)\n      || compareNumbers(lhs.majorIntervalCount, rhs.majorIntervalCount)\n      || compareBooleans(lhs.showGeometry, rhs.showGeometry);\n  }\n\n  private constructor(props?: Partial<ContourProperties>) {\n    this.majorStyle = props?.majorStyle ?? ContourStyle.fromJSON({ pixelWidth: 2 });\n    this.minorStyle = props?.minorStyle ?? ContourStyle.fromJSON();\n    this.minorInterval = props?.minorInterval ?? 1;\n    this.majorIntervalCount = props?.majorIntervalCount ?? 5;\n    this.showGeometry = props?.showGeometry ?? true;\n  }\n\n  public static fromJSON(props?: ContourProps) {\n    if (!props)\n      return new Contour();\n\n    return new this({\n      majorStyle: props?.majorStyle ? ContourStyle.fromJSON(props.majorStyle) : undefined,\n      minorStyle: props?.minorStyle ? ContourStyle.fromJSON(props.minorStyle) : undefined,\n      minorInterval: props?.minorInterval,\n      majorIntervalCount: props?.majorIntervalCount,\n      showGeometry: props?.showGeometry,\n    });\n  }\n\n  public toJSON(): ContourProps {\n    const props: ContourProps = {};\n\n    if (!this.majorStyle.equals(ContourStyle.fromJSON({ pixelWidth: 2 })))\n      props.majorStyle = this.majorStyle.toJSON();\n\n    if (!this.minorStyle.equals(ContourStyle.fromJSON()))\n      props.minorStyle = this.minorStyle.toJSON();\n\n    if (1 !== this.minorInterval)\n      props.minorInterval = this.minorInterval;\n\n    if (5 !== this.majorIntervalCount)\n      props.majorIntervalCount = this.majorIntervalCount;\n\n    if (true !== this.showGeometry)\n      props.showGeometry = this.showGeometry;\n\n    return props;\n  }\n\n  /** Create a new Contour. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourProperties>): Contour {\n    return props ? new this(props) : new Contour();\n  }\n\n  /** Create a copy of this Contour, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourProperties>): Contour {\n    if (!changedProps)\n      return this;\n\n    return Contour.create({ ...this, ...changedProps });\n  }\n}\n\n/** JSON representation of a [[ContourGroup]].\n * @public\n */\nexport interface ContourGroupProps {\n  /** See [[ContourGroup.contourDef]]. */\n  contourDef?: ContourProps;\n  /** See [[ContourGroup.subCategories]]. */\n  subCategories?: CompressedId64Set;\n  /** See [[ContourGroup.name]]. */\n  name?: string;\n}\n\n/** A type containing all of the properties of [[ContourGroup]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[ContourGroup.create]] and [[ContourGroup.clone]].\n * @public\n */\nexport type ContourGroupProperties = NonFunctionPropertiesOf<ContourGroup>;\n\n/** Defines a group of objects to which to apply [[Contour]] lines in a particular style.\n * The [[ContourDisplay]] settings can contain multiple groups.\n * Each group is described by a set of [SubCategory]($backend)'s; all geometry belonging to any of those subcategories belongs to the group.\n * An empty set of subcategories indicates that this is a default group, implicitly containing all subcategories that are not explicitly included in another group.\n * Each group has an optional, non-user-facing name that applications can use to assign semantics to particular groups.\n * @public\n */\nexport class ContourGroup {\n  private _subCategories: CompressedId64Set;\n\n  /** Describes the appearance of all of the contours applied to geometry belonging to this group. */\n  public readonly contourDef: Contour;\n  /** An optional, non-user-facing name that applications can use to assign semantics to particular groups.\n   * Default: an empty string.\n   */\n  public readonly name: string;\n\n  /** The set of subcategories belonging to this group, or an empty set if this is a default group. If more than one empty set exists in the [[ContourDisplay]] object's `groups` array, the last entry in that array is used for rendering the default styling.\n   * @see [[isDefaultGroup]] to test if this is a default group.\n   */\n  public get subCategories(): OrderedId64Iterable {\n    return CompressedId64Set.iterable(this._subCategories);\n  }\n\n  /** Returns true if [[subCategories]] is an empty set, indicating that any subcategory not included in any other [[ContourGroup]] is implicitly\n   * included in this group.\n   */\n  public get isDefaultGroup(): boolean {\n    return OrderedId64Iterable.isEmptySet(this._subCategories);\n  }\n\n  /** Returns true if `this` and `other` contain the exact same set of subcategories. */\n  public subCategoriesEqual(other: ContourGroup): boolean {\n    return this._subCategories === other._subCategories;\n  }\n\n  /** Returns true if `this` and `other` are logically equivalent, having the same styling, name, and set of subcategories. */\n  public equals(other: ContourGroup | undefined): boolean {\n    if (this === undefined && other === undefined)\n      return true;\n    if (this === undefined || other === undefined)\n      return false;\n    if (!this.contourDef.equals(other.contourDef))\n      return false;\n    if (this._subCategories !== other._subCategories)\n      return false;\n    if (this.name !== other.name)\n      return false;\n    return true;\n  }\n\n  private constructor(props?: Partial<ContourGroupProperties>) {\n    this.contourDef = props?.contourDef ?? Contour.fromJSON();\n    this._subCategories = props?.subCategories ? CompressedId64Set.sortAndCompress(props.subCategories) : \"\";\n    this.name = props?.name ?? \"\";\n  }\n\n  public static fromJSON(props?: ContourGroupProps) {\n    if (!props)\n      return new ContourGroup();\n\n    return new this({\n      contourDef: props?.contourDef ? Contour.fromJSON(props.contourDef) : undefined,\n      name: props?.name,\n      subCategories: props?.subCategories ? CompressedId64Set.iterable(props.subCategories) : undefined,\n    });\n  }\n\n  public toJSON(): ContourGroupProps {\n    const props: ContourGroupProps = {};\n\n    if (!this.contourDef.equals(Contour.defaults))\n      props.contourDef = this.contourDef.toJSON();\n\n    if (this.name)\n      props.name = this.name;\n\n    props.subCategories = this._subCategories;\n    return props;\n  }\n\n  /** Create a new ContourGroup. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourGroupProperties>): ContourGroup {\n    return props ? new this(props) : new ContourGroup();\n  }\n\n  /** Create a copy of this ContourGroup, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourGroupProperties>): ContourGroup {\n    if (!changedProps)\n      return this;\n\n    return ContourGroup.create({ ...this, ...changedProps });\n  }\n}\n\n/** JSON representation of [[ContourDisplay]] settings.\n * @public\n */\nexport interface ContourDisplayProps {\n  /** See [[ContourDisplay.groups]]. */\n  groups?: ContourGroupProps[];\n  /** See [[ContourDisplay.displayContours]]. */\n  displayContours?: boolean;\n}\n\n/** A type containing all of the properties of [[ContourDisplay]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[ContourDisplay.create]] and [[ContourDisplay.clone]].\n * @public\n */\nexport type ContourDisplayProperties = NonFunctionPropertiesOf<ContourDisplay>;\n\n/** Settings that specify how to apply [contour lines]($docs/learning/display/ContourDisplay.md) to groups of geometry\n * within a 3d scene.\n * @see [[DisplayStyle3dSettings.contours]] to associate contour settings with a display style.\n * @public\n */\nexport class ContourDisplay {\n  /** A list of the groups, each describing their own specific contour display settings. Defaults to an empty array.\n   * @note The display system supports no more than [[ContourDisplay.maxContourGroups]]. Entries in this array exceeding that maximum will\n   * have no effect on the display of contour lines.\n   */\n  public readonly groups: ContourGroup[];\n  /** Whether to display the contour lines described by these settings. Default: false.\n   * @see [[withDisplayContours]] to change this flag.\n   */\n  public readonly displayContours: boolean;\n  /** The maximum number of contour groups that the system will allow. Any contour groups added to the [[groups]] array beyond this number will be ignored\n   * for display purposes.\n   */\n  public static readonly maxContourGroups = 5;\n\n  /** Returns true if `this` and `other` are logically equivalent, having the same groups and styling. */\n  public equals(other: ContourDisplay): boolean {\n    if (this.displayContours !== other.displayContours)\n      return false;\n    if (this.groups.length !== other.groups.length)\n      return false;\n    for (let index = 0, len = this.groups.length; index < len && index < ContourDisplay.maxContourGroups; ++index) {\n      const match = this.groups[index].equals(other.groups[index]);\n      if (!match)\n        return false;\n    }\n    return true;\n  }\n\n  private constructor(props?: Partial<ContourDisplayProperties>) {\n    this.displayContours = props?.displayContours ?? false;\n    this.groups = props?.groups ?? [];\n  }\n\n  public static fromJSON(props?: ContourDisplayProps) {\n    if (!props)\n      return new ContourDisplay();\n\n    const groups: ContourGroup[] = [];\n    if (undefined !== props && undefined !== props.groups) {\n      for (let n = 0; n < props.groups.length; n++) {\n        groups[n] = ContourGroup.fromJSON(props.groups[n]);\n      }\n    }\n\n    return new this({\n      displayContours: props?.displayContours,\n      groups: props.groups ? groups : undefined,\n    });\n  }\n\n  public toJSON(): ContourDisplayProps {\n    const props: ContourDisplayProps = {};\n\n    props.groups = [];\n    for (let n = 0; n < this.groups.length; n++) {\n      props.groups[n] = this.groups[n].toJSON();\n    }\n\n    props.displayContours = this.displayContours;\n    return props;\n  }\n\n  /** Create a new ContourDisplay. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourDisplayProperties>): ContourDisplay {\n    return props ? new this(props) : new ContourDisplay();\n  }\n\n  /** Create a copy of these settings, changing the `displayContours` flag as specified. */\n  public withDisplayContours(displayContours: boolean): ContourDisplay {\n    return displayContours === this.displayContours ? this : ContourDisplay.create({ ...this, displayContours });\n  }\n\n  /** Create a copy of this ContourDisplay, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourDisplayProperties>): ContourDisplay {\n    if (!changedProps)\n      return this;\n\n    return ContourDisplay.create({ ...this, ...changedProps });\n  }\n}\n"]}
+{"version":3,"file":"ContourDisplay.js","sourceRoot":"","sources":["../../src/ContourDisplay.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAsK;AACtK,6CAA0C;AAC1C,yCAAqD;AAoBrD;;;;GAIG;AACH,MAAa,YAAY;IACvB,oEAAoE;IACpD,KAAK,CAAW;IAChC;;;OAGG;IACa,UAAU,CAAS;IACnC,uFAAuF;IACvE,OAAO,CAAa;IAEpC,mEAAmE;IAC5D,MAAM,CAAC,KAAmB;QAC/B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YAC9G,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,yEAAyE;IAClE,OAAO,CAAC,KAAmB;QAChC,OAAO,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,GAAiB,EAAE,GAAiB;QACxD,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC;YAC/D,OAAO,IAAI,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC;YACzD,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAoB,KAAuC;QACzD,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,mBAAQ,CAAC,QAAQ,CAAC,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC;QACnE,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,uBAAU,CAAC,KAAK,CAAC;IACpD,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAyB;QAC9C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,YAAY,EAAE,CAAC;QAE5B,OAAO,IAAI,IAAI,CAAC;YACd,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;YAChE,UAAU,EAAE,KAAK,EAAE,UAAU;YAC7B,OAAO,EAAE,KAAK,EAAE,OAAO;SACxB,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,mBAAQ,CAAC,QAAQ,CAAC,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC;YAC3D,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sHAAsH;IAC/G,MAAM,CAAC,MAAM,CAAC,KAAuC;QAC1D,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA8C;QACzD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,YAAY,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAxFD,oCAwFC;AAwBD;;;;;;;;;GASG;AACH,MAAa,OAAO;IAClB,iLAAiL;IACjK,UAAU,CAAe;IACzC,qJAAqJ;IACrI,UAAU,CAAe;IACzC,mLAAmL;IACnK,aAAa,CAAS;IACtC,6UAA6U;IAC7T,kBAAkB,CAAS;IAC3C,6JAA6J;IAC7I,YAAY,CAAU;IAE/B,MAAM,CAAU,QAAQ,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC,CAAC;IAElD,iEAAiE;IAC1D,MAAM,CAAC,KAAc;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,oEAAoE;IAC7D,OAAO,CAAC,KAAc;QAC3B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;SAIK;IACE,MAAM,CAAC,OAAO,CAAC,GAAY,EAAE,GAAY;QAC9C,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;eACtD,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;eACpD,IAAA,6BAAc,EAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,aAAa,CAAC;eACpD,IAAA,6BAAc,EAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,kBAAkB,CAAC;eAC9D,IAAA,8BAAe,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED,YAAoB,KAAkC;QACpD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC/D,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,kBAAkB,GAAG,KAAK,EAAE,kBAAkB,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,IAAI,CAAC;IAClD,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAoB;QACzC,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,OAAO,EAAE,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;YACnF,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;YACnF,aAAa,EAAE,KAAK,EAAE,aAAa;YACnC,kBAAkB,EAAE,KAAK,EAAE,kBAAkB;YAC7C,YAAY,EAAE,KAAK,EAAE,YAAY;SAClC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAiB,EAAE,CAAC;QAE/B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;YACnE,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YAClD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,IAAI,CAAC,KAAK,IAAI,CAAC,aAAa;YAC1B,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAE3C,IAAI,CAAC,KAAK,IAAI,CAAC,kBAAkB;YAC/B,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAErD,IAAI,IAAI,KAAK,IAAI,CAAC,YAAY;YAC5B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,iHAAiH;IAC1G,MAAM,CAAC,MAAM,CAAC,KAAkC;QACrD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAyC;QACpD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IACtD,CAAC;;AA5FH,0BA6FC;AAoBD;;;;;;GAMG;AACH,MAAa,YAAY;IACf,cAAc,CAAoB;IAE1C,mGAAmG;IACnF,UAAU,CAAU;IACpC;;OAEG;IACa,IAAI,CAAS;IAE7B;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,gCAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,kCAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC7D,CAAC;IAED,sFAAsF;IAC/E,kBAAkB,CAAC,KAAmB;QAC3C,OAAO,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,CAAC;IACtD,CAAC;IAED,yEAAyE;IAClE,OAAO,CAAC,KAAmB;QAChC,OAAO,IAAA,6BAAc,EAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,6BAAc,EAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACzJ,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,KAA+B;QAC3C,OAAO,SAAS,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,YAAoB,KAAuC;QACzD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC1D,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzG,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,EAAE,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAyB;QAC9C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,YAAY,EAAE,CAAC;QAE5B,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;YAC9E,IAAI,EAAE,KAAK,EAAE,IAAI;YACjB,aAAa,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;SAClG,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC3C,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,IAAI,IAAI,CAAC,IAAI;YACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAEzB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sHAAsH;IAC/G,MAAM,CAAC,MAAM,CAAC,KAAuC;QAC1D,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA8C;QACzD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,YAAY,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAnFD,oCAmFC;AAkBD;;;;GAIG;AACH,MAAa,cAAc;IACzB;;;OAGG;IACa,MAAM,CAAiB;IACvC;;OAEG;IACa,eAAe,CAAU;IACzC;;OAEG;IACI,MAAM,CAAU,gBAAgB,GAAG,CAAC,CAAC;IAE5C,4EAA4E;IACrE,OAAO,CAAC,KAAqB;QAClC,OAAO,IAAA,8BAAe,EAAC,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,IAAA,4BAAa,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAClJ,CAAC;IAED,uGAAuG;IAChG,MAAM,CAAC,KAAqB;QACjC,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;YAChD,OAAO,KAAK,CAAC;QACf,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CAAC,MAAM;YAC5C,OAAO,KAAK,CAAC;QACf,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,cAAc,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,CAAC;YAC9G,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,IAAI,CAAC,KAAK;gBACR,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAoB,KAAyC;QAC3D,IAAI,CAAC,eAAe,GAAG,KAAK,EAAE,eAAe,IAAI,KAAK,CAAC;QACvD,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC;IACpC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA2B;QAChD,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,cAAc,EAAE,CAAC;QAE9B,MAAM,MAAM,GAAmB,EAAE,CAAC;QAClC,IAAI,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7C,MAAM,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,IAAI,CAAC;YACd,eAAe,EAAE,KAAK,EAAE,eAAe;YACvC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC5C,CAAC;QAED,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wHAAwH;IACjH,MAAM,CAAC,MAAM,CAAC,KAAyC;QAC5D,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC;IACxD,CAAC;IAED,yFAAyF;IAClF,mBAAmB,CAAC,eAAwB;QACjD,OAAO,eAAe,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IAC/G,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAgD;QAC3D,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,cAAc,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC7D,CAAC;;AAtFH,wCAuFC","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/** @packageDocumentation\n * @module Symbology\n */\n\nimport { compareArrays, compareBooleans, compareNumbers, compareStrings, CompressedId64Set, NonFunctionPropertiesOf, OrderedId64Iterable } from \"@itwin/core-bentley\";\nimport { LinePixels } from \"./LinePixels\";\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\n\n/** JSON representation of a [[ContourStyle]].\n * @public\n */\nexport interface ContourStyleProps {\n  /** See [[ContourStyle.color]]. */\n  color?: RgbColorProps;\n  /** See [[ContourStyle.pixelWidth]]. */\n  pixelWidth?: number;\n  /** See [[ContourStyle.pattern]]. */\n  pattern?: LinePixels;\n}\n\n/** A type containing all of the properties of [[ContourStyle]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[ContourStyle.create]] and [[ContourStyle.clone]].\n * @public\n */\nexport type ContourStyleProperties = NonFunctionPropertiesOf<ContourStyle>;\n\n/** The style settings used by either a minor or major contour.\n * @see [[Contour.majorStyle]]\n * @see [[Contour.minorStyle]]\n * @public\n */\nexport class ContourStyle {\n  /** The color in which to draw the contour lines. Default: black. */\n  public readonly color: RgbColor;\n  /** The width in screen pixels of the contour lines.\n   * Useful values range between 1 and 8.5, in increments of 0.5. Other values will be rounded to meet these criteria.\n   * Default: 1.0.\n   */\n  public readonly pixelWidth: number;\n  /** The pattern for a major or minor contour line. Defaults to [[LinePixels.Solid]]. */\n  public readonly pattern: LinePixels;\n\n  /** Returns true if `this` and `other` are logically equivalent. */\n  public equals(other: ContourStyle): boolean {\n    if (!this.color.equals(other.color) || this.pixelWidth !== other.pixelWidth || this.pattern !== other.pattern) {\n      return false;\n    }\n    return true;\n  }\n\n  /** Perform ordered comparison between this and another contour style. */\n  public compare(other: ContourStyle): number {\n    return ContourStyle.compare(this, other);\n  }\n\n  /** Performs ordered comparison of two contour styles.\n   * @param lhs First contour style to compare\n   * @param rhs Second contour style to compare\n   * @returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.\n   * @public\n   */\n  public static compare(lhs: ContourStyle, rhs: ContourStyle): number {\n    let diff = 0;\n    if ((diff = lhs.color.compareTo(rhs.color)) !== 0)\n      return diff;\n    if ((diff = compareNumbers(lhs.pixelWidth, rhs.pixelWidth)) !== 0)\n      return diff;\n    if ((diff = compareNumbers(lhs.pattern, rhs.pattern)) !== 0)\n      return diff;\n\n    return diff;\n  }\n\n  private constructor(props?: Partial<ContourStyleProperties>) {\n    this.color = props?.color ?? RgbColor.fromJSON({r: 0, g: 0, b: 0});\n    this.pixelWidth = props?.pixelWidth ?? 1;\n    this.pattern = props?.pattern ?? LinePixels.Solid;\n  }\n\n  public static fromJSON(props?: ContourStyleProps) {\n    if (!props)\n      return new ContourStyle();\n\n    return new this({\n      color: props?.color ? RgbColor.fromJSON(props.color) : undefined,\n      pixelWidth: props?.pixelWidth,\n      pattern: props?.pattern,\n    });\n  }\n\n  public toJSON(): ContourStyleProps {\n    const props: ContourStyleProps = {};\n\n    if (!this.color.equals(RgbColor.fromJSON({r: 0, g: 0, b: 0})))\n      props.color = this.color.toJSON();\n\n    if (1 !== this.pixelWidth)\n      props.pixelWidth = this.pixelWidth;\n\n    if (0 !== this.pattern)\n      props.pattern = this.pattern;\n\n    return props;\n  }\n\n  /** Create a new ContourStyle. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourStyleProperties>): ContourStyle {\n    return props ? new this(props) : new ContourStyle();\n  }\n\n  /** Create a copy of this ContourStyle, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourStyleProperties>): ContourStyle {\n    if (!changedProps)\n      return this;\n\n    return ContourStyle.create({ ...this, ...changedProps });\n  }\n}\n\n/** JSON representation of a [[Contour]].\n * @public\n */\nexport interface ContourProps {\n  /** See [[Contour.majorStyle]]. */\n  majorStyle?: ContourStyleProps;\n  /** See [[Contour.minor]]. */\n  minorStyle?: ContourStyleProps;\n  /** See [[Contour.minorInterval]]. */\n  minorInterval?: number;\n  /** See [[Contour.majorIntervalCount]]. */\n  majorIntervalCount?: number;\n  /** See [[Contour.showGeometry]] */\n  showGeometry?: boolean;\n}\n\n/** A type containing all of the properties of [[Contour]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[Contour.create]] and [[Contour.clone]].\n * @public\n */\nexport type ContourProperties = NonFunctionPropertiesOf<Contour>;\n\n/** Describes how to generate and style contour lines for geometry within a single [[ContourGroup]].\n * Contours provide a way to visualize elevation within a 3d scene by drawing lines at fixed intervals along the z-axis.\n * There are actually 2 kinds of contour lines: major and minor. Each kind can be styled independently.\n * A contour line is generated every [[minorInterval]] meters. Every `nth` line will be a *major* contour, where `n` = [[majorIntervalCount]]; the intervening lines will\n * all be *minor* contours.\n * For example, with a [[majorIntervalCount]] of `1`, every contour will be major; of `2`, every other contour will be major; and of `3`, there will be two minor contours in between\n * each major contour.\n *\n * @public\n */\nexport class Contour {\n  /** Settings that describe how a major contour is styled. Defaults to an instantation of [[ContourStyle]] using `pixelWidth` of 2 and default values for the other properties. */\n  public readonly majorStyle: ContourStyle;\n  /** Settings that describe how a minor contour is styled. Defaults to an instantation of [[ContourStyle]] using default values for the properties. */\n  public readonly minorStyle: ContourStyle;\n  /** The interval for the minor contour occurrence in meters; these can be specified as fractional. Defaults to 1. If a value <= 0 is specified, this will be treated as 1 meter. */\n  public readonly minorInterval: number;\n  /** The count of minor contour intervals that define a major interval (integer > 0). A value of 1 means no minor contours will be shown, only major contours. Defaults to 5. If a value < 1 is specified, this will be treated as 1. If a non-integer value is specified, it will be treated as if it were rounded to the nearest integer. */\n  public readonly majorIntervalCount: number;\n  /** If true, show underlying geometry along with the associated contours. If false, only show the contours, not the underlying geometry. Defaults to true. */\n  public readonly showGeometry: boolean;\n\n  public static readonly defaults = new Contour({});\n\n  /** Returns true if `this` is logically equivalent to `other`. */\n  public equals(other: Contour): boolean {\n    return this.compare(other) === 0;\n  }\n\n  /** Performs ordered comparison between this and another contour. */\n  public compare(other: Contour): number {\n    return Contour.compare(this, other);\n  }\n\n  /** Performs ordered comparison of two contours.\n     * @param lhs First contour to compare\n     * @param rhs Second contour to compare\n     * @returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.\n     */\n  public static compare(lhs: Contour, rhs: Contour): number {\n    return ContourStyle.compare(lhs.majorStyle, rhs.majorStyle)\n      || ContourStyle.compare(lhs.minorStyle, rhs.minorStyle)\n      || compareNumbers(lhs.minorInterval, rhs.minorInterval)\n      || compareNumbers(lhs.majorIntervalCount, rhs.majorIntervalCount)\n      || compareBooleans(lhs.showGeometry, rhs.showGeometry);\n  }\n\n  private constructor(props?: Partial<ContourProperties>) {\n    this.majorStyle = props?.majorStyle ?? ContourStyle.fromJSON({ pixelWidth: 2 });\n    this.minorStyle = props?.minorStyle ?? ContourStyle.fromJSON();\n    this.minorInterval = props?.minorInterval ?? 1;\n    this.majorIntervalCount = props?.majorIntervalCount ?? 5;\n    this.showGeometry = props?.showGeometry ?? true;\n  }\n\n  public static fromJSON(props?: ContourProps) {\n    if (!props)\n      return new Contour();\n\n    return new this({\n      majorStyle: props?.majorStyle ? ContourStyle.fromJSON(props.majorStyle) : undefined,\n      minorStyle: props?.minorStyle ? ContourStyle.fromJSON(props.minorStyle) : undefined,\n      minorInterval: props?.minorInterval,\n      majorIntervalCount: props?.majorIntervalCount,\n      showGeometry: props?.showGeometry,\n    });\n  }\n\n  public toJSON(): ContourProps {\n    const props: ContourProps = {};\n\n    if (!this.majorStyle.equals(ContourStyle.fromJSON({ pixelWidth: 2 })))\n      props.majorStyle = this.majorStyle.toJSON();\n\n    if (!this.minorStyle.equals(ContourStyle.fromJSON()))\n      props.minorStyle = this.minorStyle.toJSON();\n\n    if (1 !== this.minorInterval)\n      props.minorInterval = this.minorInterval;\n\n    if (5 !== this.majorIntervalCount)\n      props.majorIntervalCount = this.majorIntervalCount;\n\n    if (true !== this.showGeometry)\n      props.showGeometry = this.showGeometry;\n\n    return props;\n  }\n\n  /** Create a new Contour. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourProperties>): Contour {\n    return props ? new this(props) : new Contour();\n  }\n\n  /** Create a copy of this Contour, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourProperties>): Contour {\n    if (!changedProps)\n      return this;\n\n    return Contour.create({ ...this, ...changedProps });\n  }\n}\n\n/** JSON representation of a [[ContourGroup]].\n * @public\n */\nexport interface ContourGroupProps {\n  /** See [[ContourGroup.contourDef]]. */\n  contourDef?: ContourProps;\n  /** See [[ContourGroup.subCategories]]. */\n  subCategories?: CompressedId64Set;\n  /** See [[ContourGroup.name]]. */\n  name?: string;\n}\n\n/** A type containing all of the properties of [[ContourGroup]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[ContourGroup.create]] and [[ContourGroup.clone]].\n * @public\n */\nexport type ContourGroupProperties = NonFunctionPropertiesOf<ContourGroup>;\n\n/** Defines a group of objects to which to apply [[Contour]] lines in a particular style.\n * The [[ContourDisplay]] settings can contain multiple groups.\n * Each group is described by a set of [SubCategory]($backend)'s; all geometry belonging to any of those subcategories belongs to the group.\n * An empty set of subcategories indicates that this is a default group, implicitly containing all subcategories that are not explicitly included in another group.\n * Each group has an optional, non-user-facing name that applications can use to assign semantics to particular groups.\n * @public\n */\nexport class ContourGroup {\n  private _subCategories: CompressedId64Set;\n\n  /** Describes the appearance of all of the contours applied to geometry belonging to this group. */\n  public readonly contourDef: Contour;\n  /** An optional, non-user-facing name that applications can use to assign semantics to particular groups.\n   * Default: an empty string.\n   */\n  public readonly name: string;\n\n  /** The set of subcategories belonging to this group, or an empty set if this is a default group. If more than one empty set exists in the [[ContourDisplay]] object's `groups` array, the last entry in that array is used for rendering the default styling.\n   * @see [[isDefaultGroup]] to test if this is a default group.\n   */\n  public get subCategories(): OrderedId64Iterable {\n    return CompressedId64Set.iterable(this._subCategories);\n  }\n\n  /** Returns true if [[subCategories]] is an empty set, indicating that any subcategory not included in any other [[ContourGroup]] is implicitly\n   * included in this group.\n   */\n  public get isDefaultGroup(): boolean {\n    return OrderedId64Iterable.isEmptySet(this._subCategories);\n  }\n\n  /** Returns true if `this` and `other` contain the exact same set of subcategories. */\n  public subCategoriesEqual(other: ContourGroup): boolean {\n    return this._subCategories === other._subCategories;\n  }\n\n  /** Perform ordered comparison between this and another contour group. */\n  public compare(other: ContourGroup): number {\n    return compareStrings(this.name, other.name) || compareStrings(this._subCategories, other._subCategories) || this.contourDef.compare(other.contourDef);\n  }\n\n  /** Returns true if `this` and `other` are logically equivalent, having the same styling, name, and set of subcategories. */\n  public equals(other: ContourGroup | undefined): boolean {\n    return undefined !== other && this.compare(other) === 0;\n  }\n\n  private constructor(props?: Partial<ContourGroupProperties>) {\n    this.contourDef = props?.contourDef ?? Contour.fromJSON();\n    this._subCategories = props?.subCategories ? CompressedId64Set.sortAndCompress(props.subCategories) : \"\";\n    this.name = props?.name ?? \"\";\n  }\n\n  public static fromJSON(props?: ContourGroupProps) {\n    if (!props)\n      return new ContourGroup();\n\n    return new this({\n      contourDef: props?.contourDef ? Contour.fromJSON(props.contourDef) : undefined,\n      name: props?.name,\n      subCategories: props?.subCategories ? CompressedId64Set.iterable(props.subCategories) : undefined,\n    });\n  }\n\n  public toJSON(): ContourGroupProps {\n    const props: ContourGroupProps = {};\n\n    if (!this.contourDef.equals(Contour.defaults))\n      props.contourDef = this.contourDef.toJSON();\n\n    if (this.name)\n      props.name = this.name;\n\n    props.subCategories = this._subCategories;\n    return props;\n  }\n\n  /** Create a new ContourGroup. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourGroupProperties>): ContourGroup {\n    return props ? new this(props) : new ContourGroup();\n  }\n\n  /** Create a copy of this ContourGroup, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourGroupProperties>): ContourGroup {\n    if (!changedProps)\n      return this;\n\n    return ContourGroup.create({ ...this, ...changedProps });\n  }\n}\n\n/** JSON representation of [[ContourDisplay]] settings.\n * @public\n */\nexport interface ContourDisplayProps {\n  /** See [[ContourDisplay.groups]]. */\n  groups?: ContourGroupProps[];\n  /** See [[ContourDisplay.displayContours]]. */\n  displayContours?: boolean;\n}\n\n/** A type containing all of the properties of [[ContourDisplay]] with none of the methods and with the `readonly` modifiers removed.\n * Used by [[ContourDisplay.create]] and [[ContourDisplay.clone]].\n * @public\n */\nexport type ContourDisplayProperties = NonFunctionPropertiesOf<ContourDisplay>;\n\n/** Settings that specify how to apply [contour lines]($docs/learning/display/ContourDisplay.md) to groups of geometry\n * within a 3d scene.\n * @see [[DisplayStyle3dSettings.contours]] to associate contour settings with a display style.\n * @public\n */\nexport class ContourDisplay {\n  /** A list of the groups, each describing their own specific contour display settings. Defaults to an empty array.\n   * @note The display system supports no more than [[ContourDisplay.maxContourGroups]]. Entries in this array exceeding that maximum will\n   * have no effect on the display of contour lines.\n   */\n  public readonly groups: ContourGroup[];\n  /** Whether to display the contour lines described by these settings. Default: false.\n   * @see [[withDisplayContours]] to change this flag.\n   */\n  public readonly displayContours: boolean;\n  /** The maximum number of contour groups that the system will allow. Any contour groups added to the [[groups]] array beyond this number will be ignored\n   * for display purposes.\n   */\n  public static readonly maxContourGroups = 5;\n\n  /** Perform ordered comparison between this and another `ContourDisplay`. */\n  public compare(other: ContourDisplay): number {\n    return compareBooleans(this.displayContours, other.displayContours) || compareArrays(this.groups, other.groups, (lhs, rhs) => lhs.compare(rhs));\n  }\n\n  /** Returns true if `this` and `other` are logically equivalent, having the same groups and styling. */\n  public equals(other: ContourDisplay): boolean {\n    if (this.displayContours !== other.displayContours)\n      return false;\n    if (this.groups.length !== other.groups.length)\n      return false;\n    for (let index = 0, len = this.groups.length; index < len && index < ContourDisplay.maxContourGroups; ++index) {\n      const match = this.groups[index].equals(other.groups[index]);\n      if (!match)\n        return false;\n    }\n    return true;\n  }\n\n  private constructor(props?: Partial<ContourDisplayProperties>) {\n    this.displayContours = props?.displayContours ?? false;\n    this.groups = props?.groups ?? [];\n  }\n\n  public static fromJSON(props?: ContourDisplayProps) {\n    if (!props)\n      return new ContourDisplay();\n\n    const groups: ContourGroup[] = [];\n    if (undefined !== props && undefined !== props.groups) {\n      for (let n = 0; n < props.groups.length; n++) {\n        groups[n] = ContourGroup.fromJSON(props.groups[n]);\n      }\n    }\n\n    return new this({\n      displayContours: props?.displayContours,\n      groups: props.groups ? groups : undefined,\n    });\n  }\n\n  public toJSON(): ContourDisplayProps {\n    const props: ContourDisplayProps = {};\n\n    props.groups = [];\n    for (let n = 0; n < this.groups.length; n++) {\n      props.groups[n] = this.groups[n].toJSON();\n    }\n\n    props.displayContours = this.displayContours;\n    return props;\n  }\n\n  /** Create a new ContourDisplay. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<ContourDisplayProperties>): ContourDisplay {\n    return props ? new this(props) : new ContourDisplay();\n  }\n\n  /** Create a copy of these settings, changing the `displayContours` flag as specified. */\n  public withDisplayContours(displayContours: boolean): ContourDisplay {\n    return displayContours === this.displayContours ? this : ContourDisplay.create({ ...this, displayContours });\n  }\n\n  /** Create a copy of this ContourDisplay, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<ContourDisplayProperties>): ContourDisplay {\n    if (!changedProps)\n      return this;\n\n    return ContourDisplay.create({ ...this, ...changedProps });\n  }\n}\n"]}