@itwin/core-common 3.6.0-dev.14 → 3.6.0-dev.21

package/lib/esm/Localization.js.map

@@ -1 +1 @@
-{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAqGH;;GAEG;AACH,MAAM,OAAO,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB,IAAY,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtG,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC","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 Localization\r\n */\r\n\r\n/** Options for Localization\r\n * @public\r\n */\r\nexport interface TranslationOptions {\r\n  /** for interpolation values */\r\n  [key: string]: any;\r\n  /**\r\n   * defaultValue to return if a translation was not found\r\n   */\r\n  defaultValue?: any;\r\n  /**\r\n   * count value used for plurals\r\n   */\r\n  count?: number;\r\n  /**\r\n   * used for contexts (eg. male\\female)\r\n   */\r\n  context?: any;\r\n  /**\r\n   * override languages to use\r\n   */\r\n  lngs?: string[];\r\n  /**\r\n   * override language to lookup key if not found see fallbacks for details\r\n   */\r\n  fallbackLng?: string;\r\n}\r\n\r\n/** The interface defining the localization requirements of [IModelApp]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface Localization {\r\n  /** This method must be called and awaited before using an instance of Localization.\r\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\r\n   * becomes the default namespace.\r\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\r\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\r\n   */\r\n  initialize(namespaces: string[]): Promise<void>;\r\n\r\n  /** Return the translated value of a key.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\r\n   * followed by a colon, followed by the property in the JSON file.\r\n   * For example:\r\n   * ``` ts\r\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\r\n   *  ```\r\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedString(key: string | string[], options?: TranslationOptions): string;\r\n  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.\r\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   * @deprecated Use `getLocalizedString` instead; providing either a key with a namespace `<namespace>:<key>` or\r\n   * including `{ ns: <namespace> }` in the options.\r\n   */\r\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** get the English string for a key. */\r\n  getEnglishString(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\r\n   * For example:\r\n   * ``` ts\r\n   * \"MyKeys\": {\r\n   *   \"Key1\": \"First value\",\r\n   *   \"Key2\": \"Second value\"\r\n   *  }\r\n   * ```\r\n   *\r\n   * ``` ts\r\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\r\n   * ```\r\n   */\r\n  getLocalizedKeys(inputString: string): string;\r\n\r\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\r\n   * If the namespace is already registered, its Promise will be returned.\r\n   * @param name - the name of the namespace.\r\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\r\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\r\n   * fulfillment of returned Promise.\r\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\r\n   */\r\n  registerNamespace(namespace: string): Promise<void>;\r\n  /** @internal */\r\n  unregisterNamespace(namespace: string): void;\r\n  /** @internal */\r\n  getNamespacePromise(name: string): Promise<void> | undefined;\r\n  /** Get the list of available languages for translations */\r\n  getLanguageList(): readonly string[];\r\n  /** Change the language for translations. This overrides the language from the browser, for tests. */\r\n  changeLanguage(language: string): Promise<void>;\r\n}\r\n\r\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\r\n * @public\r\n */\r\nexport class EmptyLocalization implements Localization {\r\n  public async initialize(): Promise<void> { }\r\n  public getLocalizedString(key: string | string[]): string { return typeof (key) == \"string\" ? key : key[0]; }\r\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getLocalizedKeys(inputString: string): string { return inputString; }\r\n  public async registerNamespace(): Promise<void> { }\r\n  public unregisterNamespace(): void { }\r\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\r\n  public getLanguageList(): readonly string[] { return []; }\r\n  public async changeLanguage() { }\r\n}\r\n"]}
+{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAqGH;;GAEG;AACH,MAAM,OAAO,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB,IAAY,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtG,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC","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 Localization\n */\n\n/** Options for Localization\n * @public\n */\nexport interface TranslationOptions {\n  /** for interpolation values */\n  [key: string]: any;\n  /**\n   * defaultValue to return if a translation was not found\n   */\n  defaultValue?: any;\n  /**\n   * count value used for plurals\n   */\n  count?: number;\n  /**\n   * used for contexts (eg. male\\female)\n   */\n  context?: any;\n  /**\n   * override languages to use\n   */\n  lngs?: string[];\n  /**\n   * override language to lookup key if not found see fallbacks for details\n   */\n  fallbackLng?: string;\n}\n\n/** The interface defining the localization requirements of [IModelApp]($frontend).\n * @public\n * @extensions\n */\nexport interface Localization {\n  /** This method must be called and awaited before using an instance of Localization.\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\n   * becomes the default namespace.\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\n   */\n  initialize(namespaces: string[]): Promise<void>;\n\n  /** Return the translated value of a key.\n   * @param key - the key that matches a property in the JSON localization file.\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\n   * followed by a colon, followed by the property in the JSON file.\n   * For example:\n   * ``` ts\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\n   *  ```\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\n   * @returns The string corresponding to the first key that resolves.\n   * @throws Error if no keys resolve to a string.\n   */\n  getLocalizedString(key: string | string[], options?: TranslationOptions): string;\n  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\n   * @param key - the key that matches a property in the JSON localization file.\n   * @returns The string corresponding to the first key that resolves.\n   * @throws Error if no keys resolve to a string.\n   * @deprecated Use `getLocalizedString` instead; providing either a key with a namespace `<namespace>:<key>` or\n   * including `{ ns: <namespace> }` in the options.\n   */\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TranslationOptions): string;\n  /** get the English string for a key. */\n  getEnglishString(namespace: string, key: string | string[], options?: TranslationOptions): string;\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\n   * For example:\n   * ``` ts\n   * \"MyKeys\": {\n   *   \"Key1\": \"First value\",\n   *   \"Key2\": \"Second value\"\n   *  }\n   * ```\n   *\n   * ``` ts\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\n   * ```\n   */\n  getLocalizedKeys(inputString: string): string;\n\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\n   * If the namespace is already registered, its Promise will be returned.\n   * @param name - the name of the namespace.\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\n   * fulfillment of returned Promise.\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\n   */\n  registerNamespace(namespace: string): Promise<void>;\n  /** @internal */\n  unregisterNamespace(namespace: string): void;\n  /** @internal */\n  getNamespacePromise(name: string): Promise<void> | undefined;\n  /** Get the list of available languages for translations */\n  getLanguageList(): readonly string[];\n  /** Change the language for translations. This overrides the language from the browser, for tests. */\n  changeLanguage(language: string): Promise<void>;\n}\n\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\n * @public\n */\nexport class EmptyLocalization implements Localization {\n  public async initialize(): Promise<void> { }\n  public getLocalizedString(key: string | string[]): string { return typeof (key) == \"string\" ? key : key[0]; }\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\n  public getLocalizedKeys(inputString: string): string { return inputString; }\n  public async registerNamespace(): Promise<void> { }\n  public unregisterNamespace(): void { }\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\n  public getLanguageList(): readonly string[] { return []; }\n  public async changeLanguage() { }\n}\n"]}

package/lib/esm/MapImagerySettings.d.ts

@@ -1,63 +1,63 @@
-/** @packageDocumentation
- * @module MapLayers
- */
-import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
-import { ColorDef, ColorDefProps } from "./ColorDef";
-import { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from "./MapLayerSettings";
-/** JSON representation of a [[BaseLayerSettings]].
- * @public
- */
-export declare type BaseLayerProps = BaseMapLayerProps | ColorDefProps;
-/** The JSON representation of the map imagery.  Map imagery include the specification for the base layer (which was originally
- * represented by [[BackgroundMapProps.providerName]]  && [[BackgroundMapProps.providerData]]) and additional map layers.
- * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.
- * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as
- * the settings are compatible.
- * The non-base map layers may represent image layers generated by tile servers or model layers that are generated by 2d projection of model geometry, typically from a model
- * that is generated from two dimensional GIS data.
- * @public
- */
-export interface MapImageryProps {
-    backgroundBase?: BaseLayerProps;
-    backgroundLayers?: MapLayerProps[];
-    overlayLayers?: MapLayerProps[];
-}
-/** The base layer for a [[MapImagerySettings]].
- * @see [[MapImagerySettings.backgroundBase]].
- * @public
- */
-export declare type BaseLayerSettings = BaseMapLayerSettings | ColorDef;
-/** @public */
-export declare namespace BaseLayerSettings {
-    /** Create a base layer from its JSON representation. */
-    function fromJSON(props: BaseLayerProps): BaseLayerSettings;
-}
-/** Provides access to the map imagery settings (Base and layers).
- * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.
- * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as
- * the settings are compatible.
- * @public
- */
-export declare class MapImagerySettings {
-    private _backgroundBase;
-    private _backgroundLayers;
-    private _overlayLayers;
-    private constructor();
-    /** The settings for the base layer.
-     *  @note If changing the base provider it is currently necessary to also update the background map settings.
-     */
-    get backgroundBase(): BaseLayerSettings;
-    set backgroundBase(base: BaseLayerSettings);
-    get backgroundLayers(): MapLayerSettings[];
-    get overlayLayers(): MapLayerSettings[];
-    /** Return base transparency as a number between 0 and 1.
-     * @internal
-     */
-    get baseTransparency(): number;
-    /** Construct from JSON, performing validation and applying default values for undefined fields. */
-    static fromJSON(imageryJson?: MapImageryProps): MapImagerySettings;
-    /** @internal */
-    static createFromJSON(imageryJson?: MapImageryProps, mapProps?: DeprecatedBackgroundMapProps): MapImagerySettings;
-    toJSON(): MapImageryProps;
-}
+/** @packageDocumentation
+ * @module MapLayers
+ */
+import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
+import { ColorDef, ColorDefProps } from "./ColorDef";
+import { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from "./MapLayerSettings";
+/** JSON representation of a [[BaseLayerSettings]].
+ * @public
+ */
+export declare type BaseLayerProps = BaseMapLayerProps | ColorDefProps;
+/** The JSON representation of the map imagery.  Map imagery include the specification for the base layer (which was originally
+ * represented by [[BackgroundMapProps.providerName]]  && [[BackgroundMapProps.providerData]]) and additional map layers.
+ * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.
+ * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as
+ * the settings are compatible.
+ * The non-base map layers may represent image layers generated by tile servers or model layers that are generated by 2d projection of model geometry, typically from a model
+ * that is generated from two dimensional GIS data.
+ * @public
+ */
+export interface MapImageryProps {
+    backgroundBase?: BaseLayerProps;
+    backgroundLayers?: MapLayerProps[];
+    overlayLayers?: MapLayerProps[];
+}
+/** The base layer for a [[MapImagerySettings]].
+ * @see [[MapImagerySettings.backgroundBase]].
+ * @public
+ */
+export declare type BaseLayerSettings = BaseMapLayerSettings | ColorDef;
+/** @public */
+export declare namespace BaseLayerSettings {
+    /** Create a base layer from its JSON representation. */
+    function fromJSON(props: BaseLayerProps): BaseLayerSettings;
+}
+/** Provides access to the map imagery settings (Base and layers).
+ * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.
+ * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as
+ * the settings are compatible.
+ * @public
+ */
+export declare class MapImagerySettings {
+    private _backgroundBase;
+    private _backgroundLayers;
+    private _overlayLayers;
+    private constructor();
+    /** The settings for the base layer.
+     *  @note If changing the base provider it is currently necessary to also update the background map settings.
+     */
+    get backgroundBase(): BaseLayerSettings;
+    set backgroundBase(base: BaseLayerSettings);
+    get backgroundLayers(): MapLayerSettings[];
+    get overlayLayers(): MapLayerSettings[];
+    /** Return base transparency as a number between 0 and 1.
+     * @internal
+     */
+    get baseTransparency(): number;
+    /** Construct from JSON, performing validation and applying default values for undefined fields. */
+    static fromJSON(imageryJson?: MapImageryProps): MapImagerySettings;
+    /** @internal */
+    static createFromJSON(imageryJson?: MapImageryProps, mapProps?: DeprecatedBackgroundMapProps): MapImagerySettings;
+    toJSON(): MapImageryProps;
+}
 //# sourceMappingURL=MapImagerySettings.d.ts.map

package/lib/esm/MapImagerySettings.js

@@ -1,77 +1,77 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module MapLayers
- */
-import { ColorDef } from "./ColorDef";
-import { BaseMapLayerSettings, MapLayerSettings } from "./MapLayerSettings";
-/** @public */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export var BaseLayerSettings;
-(function (BaseLayerSettings) {
-    /** Create a base layer from its JSON representation. */
-    function fromJSON(props) {
-        return typeof props === "number" ? ColorDef.fromJSON(props) : BaseMapLayerSettings.fromJSON(props);
-    }
-    BaseLayerSettings.fromJSON = fromJSON;
-})(BaseLayerSettings || (BaseLayerSettings = {}));
-/** Provides access to the map imagery settings (Base and layers).
- * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.
- * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as
- * the settings are compatible.
- * @public
- */
-export class MapImagerySettings {
-    constructor(base, backgroundLayerProps, overlayLayersProps) {
-        this._backgroundLayers = new Array();
-        this._overlayLayers = new Array();
-        this._backgroundBase = base;
-        if (backgroundLayerProps) {
-            for (const layerProps of backgroundLayerProps) {
-                const layer = MapLayerSettings.fromJSON(layerProps);
-                if (layer)
-                    this._backgroundLayers.push(layer);
-            }
-        }
-        if (overlayLayersProps) {
-            for (const overlayLayerProps of overlayLayersProps) {
-                const overlayLayer = MapLayerSettings.fromJSON(overlayLayerProps);
-                if (overlayLayer)
-                    this._overlayLayers.push(overlayLayer);
-            }
-        }
-    }
-    /** The settings for the base layer.
-     *  @note If changing the base provider it is currently necessary to also update the background map settings.
-     */
-    get backgroundBase() { return this._backgroundBase; }
-    set backgroundBase(base) { this._backgroundBase = base; }
-    get backgroundLayers() { return this._backgroundLayers; }
-    get overlayLayers() { return this._overlayLayers; }
-    /** Return base transparency as a number between 0 and 1.
-     * @internal
-     */
-    get baseTransparency() {
-        return (this._backgroundBase instanceof ColorDef) ? (this._backgroundBase.getTransparency() / 255) : this._backgroundBase.transparency;
-    }
-    /** Construct from JSON, performing validation and applying default values for undefined fields. */
-    static fromJSON(imageryJson) {
-        return this.createFromJSON(imageryJson, undefined);
-    }
-    /** @internal */
-    static createFromJSON(imageryJson, mapProps) {
-        const baseLayer = (imageryJson === null || imageryJson === void 0 ? void 0 : imageryJson.backgroundBase) ? BaseLayerSettings.fromJSON(imageryJson.backgroundBase) : BaseMapLayerSettings.fromBackgroundMapProps(mapProps !== null && mapProps !== void 0 ? mapProps : {});
-        return new MapImagerySettings(baseLayer, imageryJson === null || imageryJson === void 0 ? void 0 : imageryJson.backgroundLayers, imageryJson === null || imageryJson === void 0 ? void 0 : imageryJson.overlayLayers);
-    }
-    toJSON() {
-        const props = { backgroundBase: this._backgroundBase.toJSON() };
-        if (this._backgroundLayers.length > 0)
-            props.backgroundLayers = this._backgroundLayers.map((layer) => layer.toJSON());
-        if (this._overlayLayers.length > 0)
-            props.overlayLayers = this._overlayLayers.map((layer) => layer.toJSON());
-        return props;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module MapLayers
+ */
+import { ColorDef } from "./ColorDef";
+import { BaseMapLayerSettings, MapLayerSettings } from "./MapLayerSettings";
+/** @public */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var BaseLayerSettings;
+(function (BaseLayerSettings) {
+    /** Create a base layer from its JSON representation. */
+    function fromJSON(props) {
+        return typeof props === "number" ? ColorDef.fromJSON(props) : BaseMapLayerSettings.fromJSON(props);
+    }
+    BaseLayerSettings.fromJSON = fromJSON;
+})(BaseLayerSettings || (BaseLayerSettings = {}));
+/** Provides access to the map imagery settings (Base and layers).
+ * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.
+ * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as
+ * the settings are compatible.
+ * @public
+ */
+export class MapImagerySettings {
+    constructor(base, backgroundLayerProps, overlayLayersProps) {
+        this._backgroundLayers = new Array();
+        this._overlayLayers = new Array();
+        this._backgroundBase = base;
+        if (backgroundLayerProps) {
+            for (const layerProps of backgroundLayerProps) {
+                const layer = MapLayerSettings.fromJSON(layerProps);
+                if (layer)
+                    this._backgroundLayers.push(layer);
+            }
+        }
+        if (overlayLayersProps) {
+            for (const overlayLayerProps of overlayLayersProps) {
+                const overlayLayer = MapLayerSettings.fromJSON(overlayLayerProps);
+                if (overlayLayer)
+                    this._overlayLayers.push(overlayLayer);
+            }
+        }
+    }
+    /** The settings for the base layer.
+     *  @note If changing the base provider it is currently necessary to also update the background map settings.
+     */
+    get backgroundBase() { return this._backgroundBase; }
+    set backgroundBase(base) { this._backgroundBase = base; }
+    get backgroundLayers() { return this._backgroundLayers; }
+    get overlayLayers() { return this._overlayLayers; }
+    /** Return base transparency as a number between 0 and 1.
+     * @internal
+     */
+    get baseTransparency() {
+        return (this._backgroundBase instanceof ColorDef) ? (this._backgroundBase.getTransparency() / 255) : this._backgroundBase.transparency;
+    }
+    /** Construct from JSON, performing validation and applying default values for undefined fields. */
+    static fromJSON(imageryJson) {
+        return this.createFromJSON(imageryJson, undefined);
+    }
+    /** @internal */
+    static createFromJSON(imageryJson, mapProps) {
+        const baseLayer = (imageryJson === null || imageryJson === void 0 ? void 0 : imageryJson.backgroundBase) ? BaseLayerSettings.fromJSON(imageryJson.backgroundBase) : BaseMapLayerSettings.fromBackgroundMapProps(mapProps !== null && mapProps !== void 0 ? mapProps : {});
+        return new MapImagerySettings(baseLayer, imageryJson === null || imageryJson === void 0 ? void 0 : imageryJson.backgroundLayers, imageryJson === null || imageryJson === void 0 ? void 0 : imageryJson.overlayLayers);
+    }
+    toJSON() {
+        const props = { backgroundBase: this._backgroundBase.toJSON() };
+        if (this._backgroundLayers.length > 0)
+            props.backgroundLayers = this._backgroundLayers.map((layer) => layer.toJSON());
+        if (this._overlayLayers.length > 0)
+            props.overlayLayers = this._overlayLayers.map((layer) => layer.toJSON());
+        return props;
+    }
+}
 //# sourceMappingURL=MapImagerySettings.js.map

package/lib/esm/MapImagerySettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapImagerySettings.js","sourceRoot":"","sources":["../../src/MapImagerySettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAqB,oBAAoB,EAAiB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA4B9G,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,iBAAiB,CAKjC;AALD,WAAiB,iBAAiB;IAChC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAqB;QAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;IAFe,0BAAQ,WAEvB,CAAA;AACH,CAAC,EALgB,iBAAiB,KAAjB,iBAAiB,QAKjC;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAkB;IAK7B,YAAoB,IAAuB,EAAE,oBAAsC,EAAE,kBAAoC;QAHjH,sBAAiB,GAAG,IAAI,KAAK,EAAoB,CAAC;QAClD,mBAAc,GAAG,IAAI,KAAK,EAAoB,CAAC;QAGrD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,oBAAoB,EAAE;YACxB,KAAK,MAAM,UAAU,IAAI,oBAAoB,EAAE;gBAC7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACpD,IAAI,KAAK;oBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACtC;SACF;QACD,IAAI,kBAAkB,EAAE;YACtB,KAAK,MAAM,iBAAiB,IAAI,kBAAkB,EAAE;gBAClD,MAAM,YAAY,GAAG,gBAAgB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;gBAClE,IAAI,YAAY;oBACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aAC1C;SACF;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc,KAAwB,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC/E,IAAW,cAAc,CAAC,IAAuB,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC;IAEnF,IAAW,gBAAgB,KAAyB,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpF,IAAW,aAAa,KAAyB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAE9E;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,CAAC,IAAI,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IAEzI,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,WAA6B;QAClD,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,cAAc,CAAC,WAA6B,EAAE,QAAuC;QACjG,MAAM,SAAS,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,cAAc,EAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAG,CAAC,CAAC;QAEtK,OAAO,IAAI,kBAAkB,CAAC,SAAS,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,CAAC,CAAC;IACtG,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAoB,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;QACjF,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC;YACnC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAEjF,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;YAChC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAE3E,OAAO,KAAK,CAAC;IACf,CAAC;CACF","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 MapLayers\r\n */\r\n\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from \"./MapLayerSettings\";\r\n\r\n/** JSON representation of a [[BaseLayerSettings]].\r\n * @public\r\n */\r\nexport type BaseLayerProps = BaseMapLayerProps | ColorDefProps;\r\n\r\n/** The JSON representation of the map imagery.  Map imagery include the specification for the base layer (which was originally\r\n * represented by [[BackgroundMapProps.providerName]]  && [[BackgroundMapProps.providerData]]) and additional map layers.\r\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\r\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\r\n * the settings are compatible.\r\n * The non-base map layers may represent image layers generated by tile servers or model layers that are generated by 2d projection of model geometry, typically from a model\r\n * that is generated from two dimensional GIS data.\r\n * @public\r\n */\r\nexport interface MapImageryProps {\r\n  backgroundBase?: BaseLayerProps;\r\n  backgroundLayers?: MapLayerProps[];\r\n  overlayLayers?: MapLayerProps[];\r\n}\r\n\r\n/** The base layer for a [[MapImagerySettings]].\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @public\r\n */\r\nexport type BaseLayerSettings = BaseMapLayerSettings | ColorDef;\r\n\r\n/** @public */\r\n// eslint-disable-next-line @typescript-eslint/no-redeclare\r\nexport namespace BaseLayerSettings {\r\n  /** Create a base layer from its JSON representation. */\r\n  export function fromJSON(props: BaseLayerProps): BaseLayerSettings {\r\n    return typeof props === \"number\" ? ColorDef.fromJSON(props) : BaseMapLayerSettings.fromJSON(props);\r\n  }\r\n}\r\n\r\n/** Provides access to the map imagery settings (Base and layers).\r\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\r\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\r\n * the settings are compatible.\r\n * @public\r\n */\r\nexport class MapImagerySettings {\r\n  private _backgroundBase: BaseLayerSettings;\r\n  private _backgroundLayers = new Array<MapLayerSettings>();\r\n  private _overlayLayers = new Array<MapLayerSettings>();\r\n\r\n  private constructor(base: BaseLayerSettings, backgroundLayerProps?: MapLayerProps[], overlayLayersProps?: MapLayerProps[]) {\r\n    this._backgroundBase = base;\r\n    if (backgroundLayerProps) {\r\n      for (const layerProps of backgroundLayerProps) {\r\n        const layer = MapLayerSettings.fromJSON(layerProps);\r\n        if (layer)\r\n          this._backgroundLayers.push(layer);\r\n      }\r\n    }\r\n    if (overlayLayersProps) {\r\n      for (const overlayLayerProps of overlayLayersProps) {\r\n        const overlayLayer = MapLayerSettings.fromJSON(overlayLayerProps);\r\n        if (overlayLayer)\r\n          this._overlayLayers.push(overlayLayer);\r\n      }\r\n    }\r\n  }\r\n\r\n  /** The settings for the base layer.\r\n   *  @note If changing the base provider it is currently necessary to also update the background map settings.\r\n   */\r\n  public get backgroundBase(): BaseLayerSettings { return this._backgroundBase; }\r\n  public set backgroundBase(base: BaseLayerSettings) { this._backgroundBase = base; }\r\n\r\n  public get backgroundLayers(): MapLayerSettings[] { return this._backgroundLayers; }\r\n  public get overlayLayers(): MapLayerSettings[] { return this._overlayLayers; }\r\n\r\n  /** Return base transparency as a number between 0 and 1.\r\n   * @internal\r\n   */\r\n  public get baseTransparency(): number {\r\n    return (this._backgroundBase instanceof ColorDef) ? (this._backgroundBase.getTransparency() / 255) : this._backgroundBase.transparency;\r\n\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(imageryJson?: MapImageryProps) {\r\n    return this.createFromJSON(imageryJson, undefined);\r\n  }\r\n\r\n  /** @internal */\r\n  public static createFromJSON(imageryJson?: MapImageryProps, mapProps?: DeprecatedBackgroundMapProps) {\r\n    const baseLayer = imageryJson?.backgroundBase ? BaseLayerSettings.fromJSON(imageryJson.backgroundBase) : BaseMapLayerSettings.fromBackgroundMapProps(mapProps ?? { });\r\n\r\n    return new MapImagerySettings(baseLayer, imageryJson?.backgroundLayers, imageryJson?.overlayLayers);\r\n  }\r\n\r\n  public toJSON(): MapImageryProps {\r\n    const props: MapImageryProps = { backgroundBase: this._backgroundBase.toJSON() };\r\n    if (this._backgroundLayers.length > 0)\r\n      props.backgroundLayers = this._backgroundLayers.map((layer) => layer.toJSON());\r\n\r\n    if (this._overlayLayers.length > 0)\r\n      props.overlayLayers = this._overlayLayers.map((layer) => layer.toJSON());\r\n\r\n    return props;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MapImagerySettings.js","sourceRoot":"","sources":["../../src/MapImagerySettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAqB,oBAAoB,EAAiB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA4B9G,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,iBAAiB,CAKjC;AALD,WAAiB,iBAAiB;IAChC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAqB;QAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;IAFe,0BAAQ,WAEvB,CAAA;AACH,CAAC,EALgB,iBAAiB,KAAjB,iBAAiB,QAKjC;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAkB;IAK7B,YAAoB,IAAuB,EAAE,oBAAsC,EAAE,kBAAoC;QAHjH,sBAAiB,GAAG,IAAI,KAAK,EAAoB,CAAC;QAClD,mBAAc,GAAG,IAAI,KAAK,EAAoB,CAAC;QAGrD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,oBAAoB,EAAE;YACxB,KAAK,MAAM,UAAU,IAAI,oBAAoB,EAAE;gBAC7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACpD,IAAI,KAAK;oBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACtC;SACF;QACD,IAAI,kBAAkB,EAAE;YACtB,KAAK,MAAM,iBAAiB,IAAI,kBAAkB,EAAE;gBAClD,MAAM,YAAY,GAAG,gBAAgB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;gBAClE,IAAI,YAAY;oBACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aAC1C;SACF;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc,KAAwB,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC/E,IAAW,cAAc,CAAC,IAAuB,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC;IAEnF,IAAW,gBAAgB,KAAyB,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpF,IAAW,aAAa,KAAyB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAE9E;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,CAAC,IAAI,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IAEzI,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,WAA6B;QAClD,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,cAAc,CAAC,WAA6B,EAAE,QAAuC;QACjG,MAAM,SAAS,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,cAAc,EAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAG,CAAC,CAAC;QAEtK,OAAO,IAAI,kBAAkB,CAAC,SAAS,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,CAAC,CAAC;IACtG,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAoB,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;QACjF,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC;YACnC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAEjF,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;YAChC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAE3E,OAAO,KAAK,CAAC;IACf,CAAC;CACF","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 MapLayers\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\nimport { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from \"./MapLayerSettings\";\n\n/** JSON representation of a [[BaseLayerSettings]].\n * @public\n */\nexport type BaseLayerProps = BaseMapLayerProps | ColorDefProps;\n\n/** The JSON representation of the map imagery.  Map imagery include the specification for the base layer (which was originally\n * represented by [[BackgroundMapProps.providerName]]  && [[BackgroundMapProps.providerData]]) and additional map layers.\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\n * the settings are compatible.\n * The non-base map layers may represent image layers generated by tile servers or model layers that are generated by 2d projection of model geometry, typically from a model\n * that is generated from two dimensional GIS data.\n * @public\n */\nexport interface MapImageryProps {\n  backgroundBase?: BaseLayerProps;\n  backgroundLayers?: MapLayerProps[];\n  overlayLayers?: MapLayerProps[];\n}\n\n/** The base layer for a [[MapImagerySettings]].\n * @see [[MapImagerySettings.backgroundBase]].\n * @public\n */\nexport type BaseLayerSettings = BaseMapLayerSettings | ColorDef;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace BaseLayerSettings {\n  /** Create a base layer from its JSON representation. */\n  export function fromJSON(props: BaseLayerProps): BaseLayerSettings {\n    return typeof props === \"number\" ? ColorDef.fromJSON(props) : BaseMapLayerSettings.fromJSON(props);\n  }\n}\n\n/** Provides access to the map imagery settings (Base and layers).\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\n * the settings are compatible.\n * @public\n */\nexport class MapImagerySettings {\n  private _backgroundBase: BaseLayerSettings;\n  private _backgroundLayers = new Array<MapLayerSettings>();\n  private _overlayLayers = new Array<MapLayerSettings>();\n\n  private constructor(base: BaseLayerSettings, backgroundLayerProps?: MapLayerProps[], overlayLayersProps?: MapLayerProps[]) {\n    this._backgroundBase = base;\n    if (backgroundLayerProps) {\n      for (const layerProps of backgroundLayerProps) {\n        const layer = MapLayerSettings.fromJSON(layerProps);\n        if (layer)\n          this._backgroundLayers.push(layer);\n      }\n    }\n    if (overlayLayersProps) {\n      for (const overlayLayerProps of overlayLayersProps) {\n        const overlayLayer = MapLayerSettings.fromJSON(overlayLayerProps);\n        if (overlayLayer)\n          this._overlayLayers.push(overlayLayer);\n      }\n    }\n  }\n\n  /** The settings for the base layer.\n   *  @note If changing the base provider it is currently necessary to also update the background map settings.\n   */\n  public get backgroundBase(): BaseLayerSettings { return this._backgroundBase; }\n  public set backgroundBase(base: BaseLayerSettings) { this._backgroundBase = base; }\n\n  public get backgroundLayers(): MapLayerSettings[] { return this._backgroundLayers; }\n  public get overlayLayers(): MapLayerSettings[] { return this._overlayLayers; }\n\n  /** Return base transparency as a number between 0 and 1.\n   * @internal\n   */\n  public get baseTransparency(): number {\n    return (this._backgroundBase instanceof ColorDef) ? (this._backgroundBase.getTransparency() / 255) : this._backgroundBase.transparency;\n\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\n  public static fromJSON(imageryJson?: MapImageryProps) {\n    return this.createFromJSON(imageryJson, undefined);\n  }\n\n  /** @internal */\n  public static createFromJSON(imageryJson?: MapImageryProps, mapProps?: DeprecatedBackgroundMapProps) {\n    const baseLayer = imageryJson?.backgroundBase ? BaseLayerSettings.fromJSON(imageryJson.backgroundBase) : BaseMapLayerSettings.fromBackgroundMapProps(mapProps ?? { });\n\n    return new MapImagerySettings(baseLayer, imageryJson?.backgroundLayers, imageryJson?.overlayLayers);\n  }\n\n  public toJSON(): MapImageryProps {\n    const props: MapImageryProps = { backgroundBase: this._backgroundBase.toJSON() };\n    if (this._backgroundLayers.length > 0)\n      props.backgroundLayers = this._backgroundLayers.map((layer) => layer.toJSON());\n\n    if (this._overlayLayers.length > 0)\n      props.overlayLayers = this._overlayLayers.map((layer) => layer.toJSON());\n\n    return props;\n  }\n}\n"]}