@itwin/core-common 3.5.0-dev.11 → 3.5.0-dev.13

package/lib/cjs/BackgroundMapProvider.js

@@ -1,69 +1,69 @@
-"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.BackgroundMapProvider = exports.BackgroundMapType = void 0;
-/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
- * @public
- * @extensions
- */
-var BackgroundMapType;
-(function (BackgroundMapType) {
-    BackgroundMapType[BackgroundMapType["Street"] = 1] = "Street";
-    BackgroundMapType[BackgroundMapType["Aerial"] = 2] = "Aerial";
-    BackgroundMapType[BackgroundMapType["Hybrid"] = 3] = "Hybrid";
-})(BackgroundMapType = exports.BackgroundMapType || (exports.BackgroundMapType = {}));
-/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
- * @public
- */
-class BackgroundMapProvider {
-    constructor(name, type) {
-        this.name = name;
-        this.type = type;
-    }
-    /** Create a provider from its JSON representation. */
-    static fromJSON(props) {
-        const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
-        let type;
-        switch (props.type) {
-            case BackgroundMapType.Street:
-            case BackgroundMapType.Aerial:
-                type = props.type;
-                break;
-            default:
-                type = BackgroundMapType.Hybrid;
-                break;
-        }
-        return new BackgroundMapProvider(name, type);
-    }
-    /** Convert this provider to its JSON representation. */
-    toJSON() {
-        return { name: this.name, type: this.type };
-    }
-    /** @internal */
-    static fromBackgroundMapProps(props) {
-        var _a;
-        // eslint-disable-next-line deprecation/deprecation
-        return this.fromJSON({ name: props.providerName, type: (_a = props.providerData) === null || _a === void 0 ? void 0 : _a.mapType });
-    }
-    /** Return true if this provider is equivalent to `other`. */
-    equals(other) {
-        return this.name === other.name && this.type === other.type;
-    }
-    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
-     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
-     */
-    clone(changedProps) {
-        return BackgroundMapProvider.fromJSON({
-            ...this.toJSON(),
-            ...changedProps,
-        });
-    }
-}
-exports.BackgroundMapProvider = BackgroundMapProvider;
+"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.BackgroundMapProvider = exports.BackgroundMapType = void 0;
+/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
+ * @public
+ * @extensions
+ */
+var BackgroundMapType;
+(function (BackgroundMapType) {
+    BackgroundMapType[BackgroundMapType["Street"] = 1] = "Street";
+    BackgroundMapType[BackgroundMapType["Aerial"] = 2] = "Aerial";
+    BackgroundMapType[BackgroundMapType["Hybrid"] = 3] = "Hybrid";
+})(BackgroundMapType = exports.BackgroundMapType || (exports.BackgroundMapType = {}));
+/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
+ * @public
+ */
+class BackgroundMapProvider {
+    constructor(name, type) {
+        this.name = name;
+        this.type = type;
+    }
+    /** Create a provider from its JSON representation. */
+    static fromJSON(props) {
+        const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
+        let type;
+        switch (props.type) {
+            case BackgroundMapType.Street:
+            case BackgroundMapType.Aerial:
+                type = props.type;
+                break;
+            default:
+                type = BackgroundMapType.Hybrid;
+                break;
+        }
+        return new BackgroundMapProvider(name, type);
+    }
+    /** Convert this provider to its JSON representation. */
+    toJSON() {
+        return { name: this.name, type: this.type };
+    }
+    /** @internal */
+    static fromBackgroundMapProps(props) {
+        var _a;
+        // eslint-disable-next-line deprecation/deprecation
+        return this.fromJSON({ name: props.providerName, type: (_a = props.providerData) === null || _a === void 0 ? void 0 : _a.mapType });
+    }
+    /** Return true if this provider is equivalent to `other`. */
+    equals(other) {
+        return this.name === other.name && this.type === other.type;
+    }
+    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
+     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
+     */
+    clone(changedProps) {
+        return BackgroundMapProvider.fromJSON({
+            ...this.toJSON(),
+            ...changedProps,
+        });
+    }
+}
+exports.BackgroundMapProvider = BackgroundMapProvider;
 //# sourceMappingURL=BackgroundMapProvider.js.map

package/lib/cjs/BackgroundMapProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,MAAA,KAAK,CAAC,YAAY,0CAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AArDD,sDAqDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BackgroundMapType {\r\n  Street = 1,\r\n  Aerial = 2,\r\n  Hybrid = 3,\r\n}\r\n\r\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\r\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @public\r\n */\r\nexport interface BackgroundMapProviderProps {\r\n  /** The name of the provider. Default: \"BingProvider\" */\r\n  name?: BackgroundMapProviderName;\r\n  /** The type of imagery to display. Default: Hybrid. */\r\n  type?: BackgroundMapType;\r\n}\r\n\r\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport class BackgroundMapProvider {\r\n  /** The name of the provider. */\r\n  public readonly name: BackgroundMapProviderName;\r\n  /** The type of map imagery provided. */\r\n  public readonly type: BackgroundMapType;\r\n\r\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\r\n    this.name = name;\r\n    this.type = type;\r\n  }\r\n\r\n  /** Create a provider from its JSON representation. */\r\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\r\n    let type;\r\n    switch (props.type) {\r\n      case BackgroundMapType.Street:\r\n      case BackgroundMapType.Aerial:\r\n        type = props.type;\r\n        break;\r\n      default:\r\n        type = BackgroundMapType.Hybrid;\r\n        break;\r\n    }\r\n\r\n    return new BackgroundMapProvider(name, type);\r\n  }\r\n\r\n  /** Convert this provider to its JSON representation. */\r\n  public toJSON(): BackgroundMapProviderProps {\r\n    return { name: this.name, type: this.type };\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\r\n  }\r\n\r\n  /** Return true if this provider is equivalent to `other`. */\r\n  public equals(other: BackgroundMapProvider): boolean {\r\n    return this.name === other.name && this.type === other.type;\r\n  }\r\n\r\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\r\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    return BackgroundMapProvider.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,MAAA,KAAK,CAAC,YAAY,0CAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AArDD,sDAqDC","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 DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\n"]}

package/lib/cjs/BackgroundMapSettings.d.ts

@@ -1,137 +1,137 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { BackgroundMapType } from "./BackgroundMapProvider";
-import { PlanarClipMaskProps, PlanarClipMaskSettings } from "./PlanarClipMask";
-import { TerrainProps, TerrainSettings } from "./TerrainSettings";
-/** Describes the projection of the background map
- * @see [[BackgroundMapProps]]
- * @see [[DisplayStyleSettingsProps]]
- * @public
- * @extensions
- */
-export declare enum GlobeMode {
-    /** Display Earth as 3d ellipsoid */
-    Ellipsoid = 0,
-    /** Display Earth as plane. */
-    Plane = 1
-}
-/** In-memory JSON representation of a [[BackgroundMapSettings]].
- * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.
- * @public
- * @extensions
- */
-export interface BackgroundMapProps {
-    /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */
-    groundBias?: number;
-    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.
-     * Default value: false.
-     */
-    transparency?: number | false;
-    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
-    useDepthBuffer?: boolean;
-    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
-    applyTerrain?: boolean;
-    /** Properties associated with terrain display. */
-    terrainSettings?: TerrainProps;
-    /** Globe Mode. Default value: GlobeMode.Ellipsoid */
-    globeMode?: GlobeMode;
-    /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
-     * allows the user to select elements that are behind the map.
-     */
-    nonLocatable?: boolean;
-    /** A planar mask applied to the map geometry
-     * @beta
-     */
-    planarClipMask?: PlanarClipMaskProps;
-    /** See [[DeprecatedBackgroundMapProps.providerName]]. */
-    providerName?: never;
-    /** See [[DeprecatedBackgroundMapProps.providerData]]. */
-    providerData?: never;
-}
-/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.
- * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in
- * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.
- * @public
- * @extensions
- */
-export interface DeprecatedBackgroundMapProps {
-    /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
-     * Default value: "BingProvider"
-     * @deprecated use MapImageryProps.backgroundBase.
-     */
-    providerName?: string;
-    /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.
-     * @deprecated use MapImageryProps.backgroundBase
-     */
-    providerData?: {
-        /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */
-        mapType?: BackgroundMapType;
-    };
-}
-/** Persistent JSON representation of a [[BackgroundMapSettings]].
- * @public
- * @extensions
- */
-export declare type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;
-/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.
- * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.
- * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.
- * @public
- */
-export declare class BackgroundMapSettings {
-    /** Retained strictly for persistence. */
-    private readonly _provider;
-    /** Elevation in meters, relative to WGS84 Ellipsoid.. */
-    readonly groundBias: number;
-    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */
-    readonly transparency: number | false;
-    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
-    readonly useDepthBuffer: boolean;
-    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
-    readonly applyTerrain: boolean;
-    /** Settings associated with terrain display. */
-    readonly terrainSettings: TerrainSettings;
-    /** Globe display mode. */
-    readonly globeMode: GlobeMode;
-    /** Planar Mask - used to mask the background map to avoid overlapping with other geometry
-     * @beta
-     */
-    readonly planarClipMask: PlanarClipMaskSettings;
-    private readonly _locatable;
-    /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
-     * allows the user to select elements that are behind the map.
-     */
-    get locatable(): boolean;
-    /** If transparency is overridden, the transparency to apply; otherwise, undefined. */
-    get transparencyOverride(): number | undefined;
-    private constructor();
-    /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from
-     * the iModel - otherwise, prefer [[fromJSON]].
-     */
-    static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings;
-    /** Construct from JSON, performing validation and applying default values for undefined fields.
-     * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
-     */
-    static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings;
-    /** Convert these settings to their in-memory JSON representation.
-     * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.
-     */
-    toJSON(): BackgroundMapProps;
-    /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to
-     * the iModel - otherwise, prefer [[toJSON]].
-     */
-    toPersistentJSON(): PersistentBackgroundMapProps;
-    /** Returns true if these settings are equivalent to the supplied JSON settings. */
-    equalsJSON(json?: BackgroundMapProps): boolean;
-    /** Returns true if the persistent representation of these settings is equivalent to `json`. */
-    equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean;
-    /** Returns true if these settings are equivalent to `other`. */
-    equals(other: BackgroundMapSettings): boolean;
-    /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps?: BackgroundMapProps): BackgroundMapSettings;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { BackgroundMapType } from "./BackgroundMapProvider";
+import { PlanarClipMaskProps, PlanarClipMaskSettings } from "./PlanarClipMask";
+import { TerrainProps, TerrainSettings } from "./TerrainSettings";
+/** Describes the projection of the background map
+ * @see [[BackgroundMapProps]]
+ * @see [[DisplayStyleSettingsProps]]
+ * @public
+ * @extensions
+ */
+export declare enum GlobeMode {
+    /** Display Earth as 3d ellipsoid */
+    Ellipsoid = 0,
+    /** Display Earth as plane. */
+    Plane = 1
+}
+/** In-memory JSON representation of a [[BackgroundMapSettings]].
+ * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.
+ * @public
+ * @extensions
+ */
+export interface BackgroundMapProps {
+    /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */
+    groundBias?: number;
+    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.
+     * Default value: false.
+     */
+    transparency?: number | false;
+    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
+    useDepthBuffer?: boolean;
+    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
+    applyTerrain?: boolean;
+    /** Properties associated with terrain display. */
+    terrainSettings?: TerrainProps;
+    /** Globe Mode. Default value: GlobeMode.Ellipsoid */
+    globeMode?: GlobeMode;
+    /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
+     * allows the user to select elements that are behind the map.
+     */
+    nonLocatable?: boolean;
+    /** A planar mask applied to the map geometry
+     * @beta
+     */
+    planarClipMask?: PlanarClipMaskProps;
+    /** See [[DeprecatedBackgroundMapProps.providerName]]. */
+    providerName?: never;
+    /** See [[DeprecatedBackgroundMapProps.providerData]]. */
+    providerData?: never;
+}
+/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.
+ * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in
+ * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.
+ * @public
+ * @extensions
+ */
+export interface DeprecatedBackgroundMapProps {
+    /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
+     * Default value: "BingProvider"
+     * @deprecated use MapImageryProps.backgroundBase.
+     */
+    providerName?: string;
+    /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.
+     * @deprecated use MapImageryProps.backgroundBase
+     */
+    providerData?: {
+        /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */
+        mapType?: BackgroundMapType;
+    };
+}
+/** Persistent JSON representation of a [[BackgroundMapSettings]].
+ * @public
+ * @extensions
+ */
+export declare type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;
+/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.
+ * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.
+ * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.
+ * @public
+ */
+export declare class BackgroundMapSettings {
+    /** Retained strictly for persistence. */
+    private readonly _provider;
+    /** Elevation in meters, relative to WGS84 Ellipsoid.. */
+    readonly groundBias: number;
+    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */
+    readonly transparency: number | false;
+    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
+    readonly useDepthBuffer: boolean;
+    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
+    readonly applyTerrain: boolean;
+    /** Settings associated with terrain display. */
+    readonly terrainSettings: TerrainSettings;
+    /** Globe display mode. */
+    readonly globeMode: GlobeMode;
+    /** Planar Mask - used to mask the background map to avoid overlapping with other geometry
+     * @beta
+     */
+    readonly planarClipMask: PlanarClipMaskSettings;
+    private readonly _locatable;
+    /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
+     * allows the user to select elements that are behind the map.
+     */
+    get locatable(): boolean;
+    /** If transparency is overridden, the transparency to apply; otherwise, undefined. */
+    get transparencyOverride(): number | undefined;
+    private constructor();
+    /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from
+     * the iModel - otherwise, prefer [[fromJSON]].
+     */
+    static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings;
+    /** Construct from JSON, performing validation and applying default values for undefined fields.
+     * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
+     */
+    static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings;
+    /** Convert these settings to their in-memory JSON representation.
+     * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.
+     */
+    toJSON(): BackgroundMapProps;
+    /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to
+     * the iModel - otherwise, prefer [[toJSON]].
+     */
+    toPersistentJSON(): PersistentBackgroundMapProps;
+    /** Returns true if these settings are equivalent to the supplied JSON settings. */
+    equalsJSON(json?: BackgroundMapProps): boolean;
+    /** Returns true if the persistent representation of these settings is equivalent to `json`. */
+    equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean;
+    /** Returns true if these settings are equivalent to `other`. */
+    equals(other: BackgroundMapSettings): boolean;
+    /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps?: BackgroundMapProps): BackgroundMapSettings;
+}
 //# sourceMappingURL=BackgroundMapSettings.d.ts.map