@itwin/core-common 3.1.0-dev.8 → 3.2.0-dev.12

package/CHANGELOG.md

@@ -1,6 +1,76 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Wed, 12 Jan 2022 14:52:38 GMT and should not be manually modified.
+This log was last generated on Thu, 10 Mar 2022 21:18:13 GMT and should not be manually modified.
+
+## 3.0.2
+Thu, 10 Mar 2022 21:18:13 GMT
+
+_Version update only_
+
+## 3.0.1
+Thu, 24 Feb 2022 15:26:55 GMT
+
+### Updates
+
+- Migrated from deprecated MapBox api.
+
+## 3.0.0
+Mon, 24 Jan 2022 14:00:52 GMT
+
+### Updates
+
+- Add support for producing larger tiles.
+- The Cartographic creation API now takes an interface as an argument with named properties. This will avoid callers mixing up the order of longitude, latitude, and height.
+- improve concurrent query changes
+- Upgrade target to ES2019 and deliver both a CommonJs and ESModule version of package
+- Added additional documentation for ecefLocation iniModel
+- Add support for indexed edges in tile graphics.
+- Added non-existent property to EntityProps to make the compiler discriminate between EntityProps and Entity.
+- Add compare method to ThematicGradientSettings. Fix Gradient.Symb.compareSymb method to also compare thematicSettings.
+- Clean up SkyBox and GroundPlane APIs.
+- improve getMetaData() and provide extended error codes
+- Added support to LightSettings for Fresnel effect.
+- Add new GeoServices class and first method to interpret WKT or complete GCS JSON."
+- GeoCoordStatus documentation added
+- getAccessToken always returns a token
+- Fix frustum translate method.
+- Make ViewFlags immutable. Simplify ViewFlagOverrides.
+- Added LOCAL_ELLIPSOID vertical datum identifier.
+- Added ability to convert iModel coordinates to or from any Geographic CRS
+- rename contextId -> iTwinId
+- MapLayerSettings.fromJSON, BaseLayerSettings.fromJSON and MapSubLayerSettings.fromJSON no longer return undefined.
+- Fix problem with RealityDataSourceKey string convertion
+- Promote RealityDataSource and RealityDataSourceKey API to beta and update documentation
+- Removed internal tag from EGFBAccessors
+- Moved RealityDataAccessProps from core-frontend to core-common
+- FeatureOverrides now merge by default in case of conflicts.
+- rename to @itwin/core-common
+- Fix an import which would cause consumers of core-common to fail during build
+- move js-base64 from devDeps to deps
+- Improve conformance with the glTF 2.0 spec when reading glb chunks.
+- remove ClientRequestContext and its subclasses
+- Added AuthorizationClient
+- Add support for inverting planar clip mask (inside vs outside)
+- Remove deprecated APIs for 3.0.
+- Generalize the way to attach a reality data by adding a RealityDataSourceKey to ContextRealityModelProps
+- Enhance RealityDataSource class
+- Replace usage of I18N with generic Localization interface.
+- GeometryContainmentRequestProps.clip and SnapRequestProps.viewFlags use stricter type than `any`.
+- removed deprecated apis
+- Move map imagery provider from BackgroundMapSettings to MapImagerySettings.backgroundBase.
+- remove IModelWriteRpcInterface
+- Rename AnalysisStyleScalar to AnalysisStyleThematic
+- Rename AnalysisStyleScalar to AnalysisStyleThematic.
+- remove ClientRequestContext.current
+- rework locks
+- Fix for IModel._ecefTrans not being updated when setting IModel._ecefLocation.
+- Deprecate RenderTexture.Params
+-  Renamed an iModel's parent container to iTwin
+- Support Open City Planner (OCP) that stores orbit point clouds (OPC) in their own azure environment.
+- FeatureAppearance transparency override by default ignores render mode and transparency view flag.
+- Adding WebEditServer (test scenarios only for now)
+- Concurrency fix within web IPC transport system.
+- Add ViewFlags.wiremesh to control wiremesh display.
 
 ## 2.19.28
 Wed, 12 Jan 2022 14:52:38 GMT
@@ -193,8 +263,8 @@ Fri, 09 Jul 2021 18:11:24 GMT
 
 ### Updates
 
-- Accomodated the inability to reverse Changesets when creating change summaries.
-- Use ecef location calculated for projected models.
+- Accomodated the inability to reverse Changesets when creating change summaries. 
+- Use ecef location calculated for projected models.  
 - Clean up and promote AnalysisStyle APIs.
 - Added support for section clip to ElementGraphicsRequestProps.
 - Add internal API for reconstructing TileOptions from tree and content Ids.
@@ -460,7 +530,7 @@ Thu, 28 Jan 2021 13:39:27 GMT
 ### Updates
 
 - Fix brep DataProps to/from flatbuffer to account for base64 string header.
-- Element geometry creation by brep operations.
+- Element geometry creation by brep operations. 
 - add EditCommand
 - Improve ElementGeometry documentation.
 - Remove assertion in supplyPathForOperation when defaulting changeSetId.
@@ -616,8 +686,8 @@ Fri, 02 Oct 2020 18:03:32 GMT
 
 - Add documentation for ContextRealityModelProps.
 - Fix calculation of cartographic range.
-- Fixes to front end methods to pull, merge and push.
-- Fixed desktop authorization after recent changes.
+- Fixes to front end methods to pull, merge and push. 
+- Fixed desktop authorization after recent changes. 
 - Update Tile version due to changes to indexes for tesselated polylines
 - On iOS download in background
 - Introduce NoContentError (transmitted via 204)
@@ -749,7 +819,7 @@ Fri, 10 Jul 2020 17:23:14 GMT
 - Add ability to create selective overrides from display style settings, and apply the overrides to another settings.
 - Fix orientation of Ecef.createFromCartographicOrigin
 - Add non-locatable flag to TerrainSettings.
-- Setup BriefcaseDb.open() to allow profile and domain schema validation and upgrades.
+- Setup BriefcaseDb.open() to allow profile and domain schema validation and upgrades. 
 - Support for multiple RPC interface clients and attaching interfaces after startup.
 - Add function to convert solar angles to solar direction.
 - enforce max texture size for stepped gradients.
@@ -783,7 +853,7 @@ Thu, 28 May 2020 22:48:59 GMT
 ### Updates
 
 - Improved log message written on rpc error
-- Change default origin mode for terrain to Geodetic.
+- Change default origin mode for terrain to Geodetic. 
 - Fix transforms for creating and querying part instance geometry in world coordinate.
 - channel rules
 - Optimize thematic sensor display by culling sensors based on a distanceCutoff property on ThematicDisplaySensorSettings.
@@ -798,7 +868,7 @@ Wed, 06 May 2020 13:17:49 GMT
 - Show min/max window error for mouse wheel zoom.
 - Make animation state of a display style persistent.
 - Send a default pending message since Azure strips content-type header if no data is present
-- Monitor progress of downloading briefcases, ability to cancel download of briefcases.
+- Monitor progress of downloading briefcases, ability to cancel download of briefcases. 
 - Added to DisplayStyle3dSettings: MonochromeMode, LightSettings.
 - Simplify GeometryStreamIteratorEntry (breaking API change).
 - constructor of ColorDef wasn't setting transparency properly for rgba() strings
@@ -821,11 +891,11 @@ Wed, 06 May 2020 13:17:49 GMT
 - Added file size.
 - Supply RPC routing props for SnapshotIModelRpcInterface open methods"
 - MobileRpcConfiguration throws exception
-- Added NativeApp.deleteBriefcase, avoided authorization exceptions when offline.
-- Refactored NativeApp API and RPC interfaces. This continues to be WIP.
-- Added DownloadBriefcaseOptions and OpenBriefcaseOptions as parameters to the download/open calls for a briefcase.
+- Added NativeApp.deleteBriefcase, avoided authorization exceptions when offline. 
+- Refactored NativeApp API and RPC interfaces. This continues to be WIP. 
+- Added DownloadBriefcaseOptions and OpenBriefcaseOptions as parameters to the download/open calls for a briefcase. 
 - Added new interface for native app
-- VSTS#217447, 162382: Cleanups to implementation of downloading/opening/discovering briefcases in native applications (WIP).
+- VSTS#217447, 162382: Cleanups to implementation of downloading/opening/discovering briefcases in native applications (WIP). 
 - Handle null JSON in ViewDetails.
 - Renamed OIDC constructs for consistency; Removed SAML support.
 - OrbitGT point cloud interface.
@@ -875,7 +945,7 @@ Wed, 12 Feb 2020 17:45:50 GMT
 - iModel write API development
 - Fix issue with constructing the tile cache URL() on Safari.
 - Prevent reuse of cached tiles after project extents change.
-- VSTS#256133: Fixed issue with reopening connections if the backend crashes. Fixes to integration tests.
+- VSTS#256133: Fixed issue with reopening connections if the backend crashes. Fixes to integration tests. 
 - Define ViewDetails for manipulating optional detail settings of ViewDefinition and ViewState.
 - Add support for plan projection models with 3d display priority.
 - Add settings to control display of plan projection models.
@@ -1037,7 +1107,7 @@ Mon, 13 May 2019 15:52:05 GMT
 
 ### Updates
 
-- Support spatial classification of context reality models.
+- Support spatial classification of context reality models. 
 - Added OpenAPIInfo to the barrel file
 - Adds parameter for api-extractor to validate missing release tags
 - Adds ignoreMissingTags flag
@@ -1050,14 +1120,14 @@ Mon, 13 May 2019 15:52:05 GMT
 - LoggerCategory -> CommonLoggerCategory
 - Fix default line pattern for hidden edges.
 - Introduce LoggerCategory enum to advertise logger categories used by this package.
-- Logging fixes.
+- Logging fixes. 
 - Put sourcemap in npm package.
 - Add SVG to ImageSourceFormat
 - Add imodeljs-markup
 - New tile cache naming scheme.
 - queryPage use memoization/pending pattern
 - Remove StandaloneIModelRpcInterface
-- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization.
+- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization. 
 - Prefer the IModelToken values in the url (if different from values in JSON body -- should never happen except in a malicious request).
 - Exports interface MarshalingBinaryMarker to prevent errors in api-extractor V7
 - Add SnapshotIModelRpcInterface

package/lib/cjs/BackgroundMapProvider.d.ts

@@ -42,5 +42,9 @@ export declare class BackgroundMapProvider {
     static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider;
     /** Return true if this provider is equivalent to `other`. */
     equals(other: BackgroundMapProvider): boolean;
+    /** 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: BackgroundMapProviderProps): BackgroundMapProvider;
 }
 //# sourceMappingURL=BackgroundMapProvider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,wDAAwD;IACxD,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAgBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;CAGrD"}
+{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,wDAAwD;IACxD,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAgBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAIpD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,0BAA0B,GAAG,qBAAqB;CAM9E"}

package/lib/cjs/BackgroundMapProvider.js

@@ -54,6 +54,15 @@ class BackgroundMapProvider {
     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;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAmBD;;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;CACF;AA3CD,sDA2CC","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 */\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 */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @beta\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 * @beta\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"]}
+{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAmBD;;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 */\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 */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @beta\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 * @beta\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"]}

package/lib/cjs/Fonts.d.ts

@@ -9,12 +9,19 @@ export declare enum FontType {
     Rsc = 2,
     Shx = 3
 }
-/** The properties of a Font. This includes a iModel local id, the font type, and the font name.
+/** An iModel-local identifier for a font.
+ * @public
+ */
+export declare type FontId = number;
+/** The properties of a Font.
  * @public
  */
 export interface FontProps {
-    id: number;
+    /** the Id, within an iModel, of this font. */
+    id: FontId;
+    /** The type of font */
     type: FontType;
+    /** The name of the font. */
     name: string;
 }
 /** The properties of a FontMap
@@ -23,8 +30,12 @@ export interface FontProps {
 export interface FontMapProps {
     fonts: FontProps[];
 }
-/** A FontMap holds the table of known fonts available in an iModel.
- * A font is referenced by an "id" that is local to the iModel. This table maps those local ids to a FontProps.
+/**
+ * A FontMap holds the set of font names available in an iModel.
+ * Within the GeometryStream of an Element, a specific font is referenced by its FontId that is local to the iModel.
+ * This class maps FontIds to FontProps.
+ * @note The font map is generally established when the iModel is first created to specify the set of fonts available
+ * for editors. Adding new entries requires that the schema lock be held.
  * @public
  */
 export declare class FontMap {
@@ -33,6 +44,6 @@ export declare class FontMap {
     addFonts(fonts: FontProps[]): void;
     toJSON(): FontMapProps;
     /** look up a font by name or number and return its FontProps */
-    getFont(arg: string | number): FontProps | undefined;
+    getFont(arg: string | FontId): FontProps | undefined;
 }
 //# sourceMappingURL=Fonts.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Fonts.d.ts","sourceRoot":"","sources":["../../src/Fonts.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,QAAQ;IAAG,QAAQ,IAAI;IAAE,GAAG,IAAI;IAAE,GAAG,IAAI;CAAE;AAEvD;;GAEG;AACH,MAAM,WAAW,SAAS;IAAG,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;AAEvE;;GAEG;AACH,MAAM,WAAW,YAAY;IAAG,KAAK,EAAE,SAAS,EAAE,CAAA;CAAE;AAEpD;;;GAGG;AACH,qBAAa,OAAO;IAClB,SAAgB,KAAK,yBAAgC;gBACzC,KAAK,CAAC,EAAE,YAAY;IAIzB,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE;IAG3B,MAAM,IAAI,YAAY;IAK7B,gEAAgE;IACzD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS;CAM5D"}
+{"version":3,"file":"Fonts.d.ts","sourceRoot":"","sources":["../../src/Fonts.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,QAAQ;IAAG,QAAQ,IAAI;IAAE,GAAG,IAAI;IAAE,GAAG,IAAI;CAAE;AAEvD;;GAEG;AACH,oBAAY,MAAM,GAAG,MAAM,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,IAAI,EAAE,QAAQ,CAAC;IACf,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAAG,KAAK,EAAE,SAAS,EAAE,CAAA;CAAE;AAEpD;;;;;;;GAOG;AACH,qBAAa,OAAO;IAClB,SAAgB,KAAK,yBAAgC;gBACzC,KAAK,CAAC,EAAE,YAAY;IAIzB,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE;IAG3B,MAAM,IAAI,YAAY;IAK7B,gEAAgE;IACzD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS;CAM5D"}

package/lib/cjs/Fonts.js

@@ -17,8 +17,12 @@ var FontType;
     FontType[FontType["Rsc"] = 2] = "Rsc";
     FontType[FontType["Shx"] = 3] = "Shx";
 })(FontType = exports.FontType || (exports.FontType = {}));
-/** A FontMap holds the table of known fonts available in an iModel.
- * A font is referenced by an "id" that is local to the iModel. This table maps those local ids to a FontProps.
+/**
+ * A FontMap holds the set of font names available in an iModel.
+ * Within the GeometryStream of an Element, a specific font is referenced by its FontId that is local to the iModel.
+ * This class maps FontIds to FontProps.
+ * @note The font map is generally established when the iModel is first created to specify the set of fonts available
+ * for editors. Adding new entries requires that the schema lock be held.
  * @public
  */
 class FontMap {

package/lib/cjs/Fonts.js.map

@@ -1 +1 @@
-{"version":3,"file":"Fonts.js","sourceRoot":"","sources":["../../src/Fonts.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,QAA2C;AAAvD,WAAY,QAAQ;IAAG,+CAAY,CAAA;IAAE,qCAAO,CAAA;IAAE,qCAAO,CAAA;AAAC,CAAC,EAA3C,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAAmC;AAYvD;;;GAGG;AACH,MAAa,OAAO;IAElB,YAAY,KAAoB;QADhB,UAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;QAEnD,IAAI,SAAS,KAAK,KAAK;YACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACM,QAAQ,CAAC,KAAkB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IACzD,CAAC;IACM,MAAM;QACX,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IACD,gEAAgE;IACzD,OAAO,CAAC,GAAoB;QACjC,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACpC,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AArBD,0BAqBC","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 Symbology\r\n */\r\n\r\n/** The type of a font.\r\n * @public\r\n */\r\nexport enum FontType { TrueType = 1, Rsc = 2, Shx = 3 }\r\n\r\n/** The properties of a Font. This includes a iModel local id, the font type, and the font name.\r\n * @public\r\n */\r\nexport interface FontProps { id: number, type: FontType, name: string }\r\n\r\n/** The properties of a FontMap\r\n * @public\r\n */\r\nexport interface FontMapProps { fonts: FontProps[] }\r\n\r\n/** A FontMap holds the table of known fonts available in an iModel.\r\n * A font is referenced by an \"id\" that is local to the iModel. This table maps those local ids to a FontProps.\r\n * @public\r\n */\r\nexport class FontMap {\r\n  public readonly fonts = new Map<number, FontProps>();\r\n  constructor(props?: FontMapProps) {\r\n    if (undefined !== props)\r\n      this.addFonts(props.fonts);\r\n  }\r\n  public addFonts(fonts: FontProps[]) {\r\n    fonts.forEach((font) => this.fonts.set(font.id, font));\r\n  }\r\n  public toJSON(): FontMapProps {\r\n    const fonts: FontProps[] = [];\r\n    this.fonts.forEach((font) => fonts.push(font));\r\n    return { fonts };\r\n  }\r\n  /** look up a font by name or number and return its FontProps */\r\n  public getFont(arg: string | number): FontProps | undefined {\r\n    if (typeof arg === \"number\") return this.fonts.get(arg);\r\n    for (const font of this.fonts.values())\r\n      if (font.name === arg) return font;\r\n    return undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Fonts.js","sourceRoot":"","sources":["../../src/Fonts.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,QAA2C;AAAvD,WAAY,QAAQ;IAAG,+CAAY,CAAA;IAAE,qCAAO,CAAA;IAAE,qCAAO,CAAA;AAAC,CAAC,EAA3C,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAAmC;AAwBvD;;;;;;;GAOG;AACH,MAAa,OAAO;IAElB,YAAY,KAAoB;QADhB,UAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;QAEnD,IAAI,SAAS,KAAK,KAAK;YACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACM,QAAQ,CAAC,KAAkB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IACzD,CAAC;IACM,MAAM;QACX,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IACD,gEAAgE;IACzD,OAAO,CAAC,GAAoB;QACjC,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACpC,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AArBD,0BAqBC","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 Symbology\r\n */\r\n\r\n/** The type of a font.\r\n * @public\r\n */\r\nexport enum FontType { TrueType = 1, Rsc = 2, Shx = 3 }\r\n\r\n/** An iModel-local identifier for a font.\r\n * @public\r\n */\r\nexport type FontId = number;\r\n\r\n/** The properties of a Font.\r\n * @public\r\n */\r\nexport interface FontProps {\r\n  /** the Id, within an iModel, of this font. */\r\n  id: FontId;\r\n  /** The type of font */\r\n  type: FontType;\r\n  /** The name of the font. */\r\n  name: string;\r\n}\r\n\r\n/** The properties of a FontMap\r\n * @public\r\n */\r\nexport interface FontMapProps { fonts: FontProps[] }\r\n\r\n/**\r\n * A FontMap holds the set of font names available in an iModel.\r\n * Within the GeometryStream of an Element, a specific font is referenced by its FontId that is local to the iModel.\r\n * This class maps FontIds to FontProps.\r\n * @note The font map is generally established when the iModel is first created to specify the set of fonts available\r\n * for editors. Adding new entries requires that the schema lock be held.\r\n * @public\r\n */\r\nexport class FontMap {\r\n  public readonly fonts = new Map<FontId, FontProps>();\r\n  constructor(props?: FontMapProps) {\r\n    if (undefined !== props)\r\n      this.addFonts(props.fonts);\r\n  }\r\n  public addFonts(fonts: FontProps[]) {\r\n    fonts.forEach((font) => this.fonts.set(font.id, font));\r\n  }\r\n  public toJSON(): FontMapProps {\r\n    const fonts: FontProps[] = [];\r\n    this.fonts.forEach((font) => fonts.push(font));\r\n    return { fonts };\r\n  }\r\n  /** look up a font by name or number and return its FontProps */\r\n  public getFont(arg: string | FontId): FontProps | undefined {\r\n    if (typeof arg === \"number\") return this.fonts.get(arg);\r\n    for (const font of this.fonts.values())\r\n      if (font.name === arg) return font;\r\n    return undefined;\r\n  }\r\n}\r\n"]}

package/lib/cjs/MapImagerySettings.d.ts

@@ -13,6 +13,8 @@ export declare type BaseLayerProps = BaseMapLayerProps | ColorDefProps;
  * 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 geomety, typically from a model
+ * that is generated from two dimensional GIS data.
  * @beta
  */
 export interface MapImageryProps {

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

@@ -1 +1 @@
-{"version":3,"file":"MapImagerySettings.d.ts","sourceRoot":"","sources":["../../src/MapImagerySettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE9G;;GAEG;AACH,oBAAY,cAAc,GAAG,iBAAiB,GAAG,aAAa,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,gBAAgB,CAAC,EAAE,aAAa,EAAE,CAAC;IACnC,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,oBAAoB,GAAG,QAAQ,CAAC;AAEhE,YAAY;AAEZ,yBAAiB,iBAAiB,CAAC;IACjC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,iBAAiB,CAEjE;CACF;AAED;;;;;GAKG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,cAAc,CAAiC;IAEvD,OAAO;IAkBP;;OAEG;IACH,IAAW,cAAc,IAAI,iBAAiB,CAAiC;IAC/E,IAAW,cAAc,CAAC,IAAI,EAAE,iBAAiB,EAAkC;IAEnF,IAAW,gBAAgB,IAAI,gBAAgB,EAAE,CAAmC;IACpF,IAAW,aAAa,IAAI,gBAAgB,EAAE,CAAgC;IAE9E;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAGpC;IAED,mGAAmG;WACrF,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe;IAIpD,gBAAgB;WACF,cAAc,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,4BAA4B;IAM5F,MAAM,IAAI,eAAe;CAUjC"}
+{"version":3,"file":"MapImagerySettings.d.ts","sourceRoot":"","sources":["../../src/MapImagerySettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE9G;;GAEG;AACH,oBAAY,cAAc,GAAG,iBAAiB,GAAG,aAAa,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,gBAAgB,CAAC,EAAE,aAAa,EAAE,CAAC;IACnC,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,oBAAoB,GAAG,QAAQ,CAAC;AAEhE,YAAY;AAEZ,yBAAiB,iBAAiB,CAAC;IACjC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,iBAAiB,CAEjE;CACF;AAED;;;;;GAKG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,cAAc,CAAiC;IAEvD,OAAO;IAkBP;;OAEG;IACH,IAAW,cAAc,IAAI,iBAAiB,CAAiC;IAC/E,IAAW,cAAc,CAAC,IAAI,EAAE,iBAAiB,EAAkC;IAEnF,IAAW,gBAAgB,IAAI,gBAAgB,EAAE,CAAmC;IACpF,IAAW,aAAa,IAAI,gBAAgB,EAAE,CAAgC;IAE9E;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAGpC;IAED,mGAAmG;WACrF,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe;IAIpD,gBAAgB;WACF,cAAc,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,4BAA4B;IAM5F,MAAM,IAAI,eAAe;CAUjC"}

package/lib/cjs/MapImagerySettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapImagerySettings.js","sourceRoot":"","sources":["../../src/MapImagerySettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,yCAAqD;AACrD,yDAA8G;AA0B9G,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,iBAAiB,CAKjC;AALD,WAAiB,iBAAiB;IAChC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAqB;QAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,uCAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;IAFe,0BAAQ,WAEvB,CAAA;AACH,CAAC,EALgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAKjC;AAED;;;;;GAKG;AACH,MAAa,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,mCAAgB,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,mCAAgB,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,mBAAQ,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,uCAAoB,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;AA9DD,gDA8DC","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\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from \"./MapLayerSettings\";\r\n\r\n/** JSON representation of a [[BaseLayerSettings]].\r\n * @beta\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 * @beta\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 * @beta\r\n */\r\nexport type BaseLayerSettings = BaseMapLayerSettings | ColorDef;\r\n\r\n/** @beta */\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 * @beta\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,yCAAqD;AACrD,yDAA8G;AA4B9G,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,iBAAiB,CAKjC;AALD,WAAiB,iBAAiB;IAChC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAqB;QAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,uCAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;IAFe,0BAAQ,WAEvB,CAAA;AACH,CAAC,EALgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAKjC;AAED;;;;;GAKG;AACH,MAAa,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,mCAAgB,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,mCAAgB,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,mBAAQ,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,uCAAoB,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;AA9DD,gDA8DC","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\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from \"./MapLayerSettings\";\r\n\r\n/** JSON representation of a [[BaseLayerSettings]].\r\n * @beta\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 geomety, typically from a model\r\n * that is generated from two dimensional GIS data.\r\n * @beta\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 * @beta\r\n */\r\nexport type BaseLayerSettings = BaseMapLayerSettings | ColorDef;\r\n\r\n/** @beta */\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 * @beta\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"]}

package/lib/cjs/MapLayerSettings.d.ts

@@ -1,6 +1,7 @@
 /** @packageDocumentation
  * @module DisplayStyles
  */
+import { Id64String } from "@itwin/core-bentley";
 import { BackgroundMapProvider, BackgroundMapProviderProps, BackgroundMapType } from "./BackgroundMapProvider";
 import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
 /** @beta */
@@ -57,34 +58,64 @@ export declare class MapSubLayerSettings {
     /** return a string representing this sublayer id (converting to string if underlying id is number) */
     get idString(): string;
 }
-/** JSON representation of the settings associated with a map layer.  One or more map layers may be included within a [[MapImageryProps]] object.
+/** JSON representation of properties common to both [[ImageMapLayerProps]] and [[ModelMapLayerProps]].
  * @see [[MapImageryProps]]
  * @beta
  */
-export interface MapLayerProps {
+export interface CommonMapLayerProps {
     /** Controls visibility of layer. Defaults to 'true'. */
     visible?: boolean;
-    /** Identifies the map layers source.*/
-    formatId: string;
-    /** Name */
+    /** A user-friendly name for the layer. */
     name: string;
+    /** 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: 0.
+     */
+    transparency?: number;
+    /** True to indicate background is transparent.
+     * Default: true.
+     */
+    transparentBackground?: boolean;
+}
+/** JSON representation of an [[ImageMapLayerSettings]].
+ * @see [[MapImagerySettings]].
+ * @beta
+ */
+export interface ImageMapLayerProps extends CommonMapLayerProps {
     /** URL */
     url: string;
+    /** Identifies the map layers source.*/
+    formatId: string;
     /** Source layers. If undefined all layers are displayed. */
     subLayers?: MapSubLayerProps[];
-    /** 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: 0.
-     * If omitted, defaults to 0. */
-    transparency?: number;
-    /** True to indicate background is transparent.  Defaults to 'true'. */
-    transparentBackground?: boolean;
-    /** Is a base layer.  Defaults to 'false'. */
-    isBase?: boolean;
     /** Access Key for the Layer, like a subscription key or access token.
-     * TODO This does not belong in the props object. It should never be persisted.
+     * ###TODO This does not belong in the props object. It should never be persisted.
      */
     accessKey?: MapLayerKey;
+    /** @internal */
+    modelId?: never;
 }
+/** JSON representation of a [[ModelMapLayerSettings]].
+ * @see [[MapImagerySettings]].
+ * @beta
+ */
+export interface ModelMapLayerProps extends CommonMapLayerProps {
+    /** The Id of the [GeometricModel]($backend) containing the geometry to be drawn by the layer. */
+    modelId: Id64String;
+    /** @internal */
+    url?: never;
+    /** @internal */
+    formatId?: never;
+    /** @internal */
+    subLayers?: never;
+    /** @internal */
+    accessKey?: never;
+}
+/** JSON representation of a [[MapLayerSettings]].
+ * @see [[MapImagerySettings]].
+ * @beta
+ */
+export declare type MapLayerProps = ImageMapLayerProps | ModelMapLayerProps;
 /**
  * stores key-value pair to be added to all requests made involving map layer.
  * @beta
@@ -93,60 +124,112 @@ export interface MapLayerKey {
     key: string;
     value: string;
 }
-/** Normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+/** Abstract base class for normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+ * This class is extended by [[ImageMapLayerSettings]] and [ModelMapLayerSettings]] to create the settings for image and model based layers.
  * One or more map layers may be included within [[MapImagerySettings]] object.
  * @see [[MapImagerySettings]]
  * @beta
  */
-export declare class MapLayerSettings {
+export declare abstract class MapLayerSettings {
     readonly visible: boolean;
-    readonly formatId: string;
     readonly name: string;
-    readonly url: string;
     readonly transparency: number;
-    readonly subLayers: MapSubLayerSettings[];
     readonly transparentBackground: boolean;
-    readonly isBase: boolean;
+    abstract get allSubLayersInvisible(): boolean;
+    abstract clone(changedProps: Partial<MapLayerProps>): MapLayerSettings;
+    abstract toJSON(): MapLayerProps;
+    /** @internal */
+    protected constructor(name: string, visible?: boolean, transparency?: number, transparentBackground?: boolean);
+    /** Create a map layer settings from its JSON representation. */
+    static fromJSON(props: MapLayerProps): MapLayerSettings;
+    /** @internal */
+    protected _toJSON(): CommonMapLayerProps;
+    /** @internal */
+    protected cloneProps(changedProps: Partial<MapLayerProps>): CommonMapLayerProps;
+    /** @internal */
+    displayMatches(other: MapLayerSettings): boolean;
+    /** Return a unique string identifying the layers source... The URL for image layer or modelID for model layer  */
+    abstract get source(): string;
+    /** @internal */
+    matchesNameAndSource(name: string, source: string): boolean;
+}
+/** Normalized representation of a [[ImageMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+ * Image map layers are created from servers that produce images that represent map tiles.  Map layers map also be represented by models.
+ * One or more map layers may be included within [[MapImagerySettings]] object.
+ * @see [[MapImagerySettings]]
+ * @see [[ModelMapLayerSettings]] for model based map layer settings.
+ * @beta
+ */
+export declare class ImageMapLayerSettings extends MapLayerSettings {
+    readonly formatId: string;
+    readonly url: string;
     userName?: string;
     password?: string;
     accessKey?: MapLayerKey;
-    setCredentials(userName?: string, password?: string): void;
+    readonly subLayers: MapSubLayerSettings[];
+    get source(): string;
     /** @internal */
-    protected constructor(url: string, name: string, formatId: string, visible?: boolean, jsonSubLayers?: MapSubLayerProps[] | undefined, transparency?: number, transparentBackground?: boolean, isBase?: boolean, userName?: string, password?: string, accessKey?: MapLayerKey);
-    /** Construct from JSON, performing validation and applying default values for undefined fields. */
-    static fromJSON(json: MapLayerProps): MapLayerSettings;
+    protected constructor(props: ImageMapLayerProps);
+    static fromJSON(props: ImageMapLayerProps): ImageMapLayerSettings;
     /** return JSON representation of this MapLayerSettings object */
-    toJSON(): MapLayerProps;
-    /** @internal */
-    protected static mapTypeName(type: BackgroundMapType): "Aerial Imagery" | "Aerial Imagery with labels" | "Streets";
+    toJSON(): ImageMapLayerProps;
     /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.
      * @param changedProps JSON representation of the properties to change.
      * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
      */
-    clone(changedProps: Partial<MapLayerProps>): MapLayerSettings;
+    clone(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerSettings;
     /** @internal */
-    protected cloneProps(changedProps: Partial<MapLayerProps>): MapLayerProps;
+    protected cloneProps(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerProps;
     /** @internal */
     displayMatches(other: MapLayerSettings): boolean;
-    /** @internal */
-    matchesNameAndUrl(name: string, url: string): boolean;
     /** Return a sublayer matching id -- or undefined if not found */
     subLayerById(id?: SubLayerId): MapSubLayerSettings | undefined;
     private hasInvisibleAncestors;
     /** Return true if sublayer is visible -- testing ancestors for visibility if they exist. */
     isSubLayerVisible(subLayer: MapSubLayerSettings): boolean;
-    /** Return true if all sublayers are visible. */
+    /** Return true if all sublayers are invisible. */
     get allSubLayersInvisible(): boolean;
     /** Return the children for a sublayer */
     getSubLayerChildren(subLayer: MapSubLayerSettings): MapSubLayerSettings[] | undefined;
+    /** @internal */
+    protected static mapTypeName(type: BackgroundMapType): "Aerial Imagery" | "Aerial Imagery with labels" | "Streets";
+    setCredentials(userName?: string, password?: string): void;
+}
+/** Normalized representation of a [[ModelMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+ * Model map layers are produced from models, typically from two dimensional geometry that may originate in a GIS system.
+ * One or more map layers may be included within [[MapImagerySettings]] object.
+ * @see [[MapImagerySettings]]
+ * @see [[ImageMapLayerSettings]] for image based map layer settings.
+ * @beta
+ */
+export declare class ModelMapLayerSettings extends MapLayerSettings {
+    readonly modelId: Id64String;
+    get source(): string;
+    /** @internal */
+    protected constructor(modelId: Id64String, name: string, visible?: boolean, transparency?: number, transparentBackground?: boolean);
+    /** Construct from JSON, performing validation and applying default values for undefined fields. */
+    static fromJSON(json: ModelMapLayerProps): ModelMapLayerSettings;
+    /** return JSON representation of this MapLayerSettings object */
+    toJSON(): ModelMapLayerProps;
+    /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerSettings;
+    /** @internal */
+    protected cloneProps(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerProps;
+    /** @internal */
+    displayMatches(other: MapLayerSettings): boolean;
+    /** Return true if all sublayers are invisible (always false as model layers do not include sublayers). */
+    get allSubLayersInvisible(): boolean;
 }
 /** JSON representation of a [[BaseMapLayerSettings]].
  * @beta
  */
-export interface BaseMapLayerProps extends MapLayerProps {
+export interface BaseMapLayerProps extends ImageMapLayerProps {
     provider?: BackgroundMapProviderProps;
 }
-/** A [[MapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].
+/** A [[ImageMapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].
  * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based
  * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).
  * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows
@@ -154,7 +237,7 @@ export interface BaseMapLayerProps extends MapLayerProps {
  * @see [[MapImagerySettings.backgroundBase]].
  * @beta
  */
-export declare class BaseMapLayerSettings extends MapLayerSettings {
+export declare class BaseMapLayerSettings extends ImageMapLayerSettings {
     private _provider?;
     /** The provider from which this base layer was configured, if any. */
     get provider(): BackgroundMapProvider | undefined;
@@ -167,9 +250,9 @@ export declare class BaseMapLayerSettings extends MapLayerSettings {
     /** Convert this layer to its JSON representation. */
     toJSON(): BaseMapLayerProps;
     /** @internal */
-    cloneProps(changedProps: Partial<MapLayerProps>): BaseMapLayerProps;
+    cloneProps(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerProps;
     /** Create a copy of this layer. */
-    clone(changedProps: Partial<MapLayerProps>): BaseMapLayerSettings;
+    clone(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerSettings;
     /** Create a base layer from a BackgroundMapProvider. */
     static fromProvider(provider: BackgroundMapProvider, options?: {
         invisible?: boolean;