@itwin/core-common 4.3.0-dev.8 → 4.3.0

package/lib/esm/MapLayerSettings.js

@@ -1,3 +1,4 @@
+/* eslint-disable deprecation/deprecation */
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -131,6 +132,9 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         this.formatId = props.formatId;
         this.url = props.url;
         this.accessKey = props.accessKey;
+        if (props.queryParams) {
+            this.savedQueryParams = { ...props.queryParams };
+        }
         this.subLayers = [];
         if (!props.subLayers)
             return;
@@ -150,6 +154,8 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         props.formatId = this.formatId;
         if (this.subLayers.length > 0)
             props.subLayers = this.subLayers.map((x) => x.toJSON());
+        if (this.savedQueryParams)
+            props.queryParams = { ...this.savedQueryParams };
         return props;
     }
     /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.
@@ -162,6 +168,10 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         clone.userName = this.userName;
         clone.password = this.password;
         clone.accessKey = this.accessKey;
+        if (this.unsavedQueryParams)
+            clone.unsavedQueryParams = { ...this.unsavedQueryParams };
+        if (this.savedQueryParams)
+            clone.savedQueryParams = { ...this.savedQueryParams };
         return clone;
     }
     /** @internal */
@@ -171,6 +181,12 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         props.url = changedProps.url ?? this.url;
         props.accessKey = changedProps.accessKey ?? this.accessKey;
         props.subLayers = changedProps.subLayers ?? this.subLayers;
+        if (changedProps.queryParams) {
+            props.queryParams = { ...changedProps.queryParams };
+        }
+        else if (this.savedQueryParams) {
+            props.queryParams = { ...this.savedQueryParams };
+        }
         return props;
     }
     /** @internal */
@@ -239,6 +255,17 @@ export class ImageMapLayerSettings extends MapLayerSettings {
         this.userName = userName;
         this.password = password;
     }
+    /** Collect all query parameters
+   * @beta
+   */
+    collectQueryParams() {
+        let queryParams = {};
+        if (this.savedQueryParams)
+            queryParams = { ...this.savedQueryParams };
+        if (this.unsavedQueryParams)
+            queryParams = { ...queryParams, ...this.unsavedQueryParams };
+        return queryParams;
+    }
 }
 /** 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.

package/lib/esm/MapLayerSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapLayerSettings.js","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAA8B,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AA2B/G;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAc9B,YAAY,IAAY,EAAE,KAAc,EAAE,OAAiB,EAAE,EAAe,EAAE,MAAmB,EAAE,QAAuB;QACxH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC;QAChD,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAsB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjJ,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAqB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QAE3E,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI;YAChD,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAErB,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,KAAK,CAAC,YAAuC;QAClD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,EAAE,EAAE,SAAS,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YAC7D,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,MAAM,EAAE,SAAS,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;YAC7E,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE;YACtG,KAAK,EAAE,SAAS,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK;SAC1E,CAAC;QACF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAA0B;QAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACpE,CAAC;IAED,6CAA6C;IAC7C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAElG,uDAAuD;IACvD,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,KAAa,OAAO,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;CACzG;AA8ED;;;;;GAKG;AACH,MAAM,OAAgB,gBAAgB;IAUpC,gBAAgB;IAChB,YAAsB,IAAY,EAAE,OAAO,GAAG,IAAI,EAAE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACxG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,QAAQ,CAAC,KAAoB;QACzC,OAAO,SAAS,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrH,CAAC;IAED,gBAAgB;IACN,OAAO;QACf,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK;YACtC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAE3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,YAAoC;QACvD,OAAO;YACL,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,YAAY,EAAE,SAAS,KAAK,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY;YACrG,qBAAqB,EAAE,SAAS,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB;SAC1I,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAuB;QAC3C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,CAAC;IAC9K,CAAC;IAKD,gBAAgB;IACT,oBAAoB,CAAC,IAAY,EAAE,MAAc;QACtD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;IACtD,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAOzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEzD,gBAAgB;IAChB,YAAsB,KAAyB;QAC7C,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC;QAClE,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAE5E,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,SAAS;YAClB,OAAO;QAET,KAAK,MAAM,aAAa,IAAI,KAAK,CAAC,SAAS,EAAE;YAC3C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAC7D,IAAI,QAAQ;gBACV,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACjC;IACH,CAAC;IAEM,MAAM,CAAU,QAAQ,CAAC,KAAyB;QACvD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAC3B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAE5E,0CAA0C;QAC1C,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QAEnE,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QACxD,KAAK,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;QACzC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAC3D,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAE3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAE,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC5E,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE;YAC5H,OAAO,KAAK,CAAC;SACd;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvD,OAAO,KAAK,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iEAAiE;IAC1D,YAAY,CAAC,EAAe;QACjC,OAAO,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEO,qBAAqB,CAAC,QAA8B;QAC1D,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC/B,OAAO,KAAK,CAAC;QAEf,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,kGAAkG;QAClG,4HAA4H;QAC5H,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC;IAED,4FAA4F;IACrF,iBAAiB,CAAC,QAA6B;QACpD,IAAI,CAAC,QAAQ,CAAC,OAAO;YACnB,OAAO,KAAK,CAAC;QAEf,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,kDAAkD;IAClD,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAA6B;QACtD,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACpB,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS;gBACrB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,WAAW,CAAC,IAAuB;QAClD,QAAQ,IAAI,EAAE;YACZ,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,gBAAgB,CAAC;YAC1B,QAAQ;YACR,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,4BAA4B,CAAC;YACtC,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;IAEM,cAAc,CAAC,QAAiB,EAAE,QAAiB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAEzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7D,gBAAgB;IAChB,YAAsB,OAAmB,EAAG,IAAY,EAAE,OAAO,GAAG,IAAI,EACtE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACtD,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAU,QAAQ,CAAC,IAAwB;QACtD,MAAM,qBAAqB,GAAG,CAAC,IAAI,CAAC,qBAAqB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC7G,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;IACnG,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QACnE,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAC,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC3E,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,0GAA0G;IAC1G,IAAW,qBAAqB;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AASD;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,qBAAqB;IAG7D,sEAAsE;IACtE,IAAW,QAAQ,KAAwC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAU,QAAQ,CAAC,KAAwB;QACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QACjD,IAAI,KAAK,CAAC,QAAQ;YAChB,QAAQ,CAAC,SAAS,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEtE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qDAAqD;IACrC,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAClD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,UAAU,CAAC,YAAwC;QACjE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAsB,CAAC;QAElE,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;aACpC,IAAI,IAAI,CAAC,QAAQ;YACpB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mCAAmC;IACnB,KAAK,CAAC,YAAwC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACzB,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAE,CAAC;QAE5E,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,GAAG;YACvC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,YAAY,CAAC,QAA+B,EAAE,OAAwD;QAClH,IAAI,QAAgB,EAAE,GAAW,EAAE,IAAY,CAAC;QAChD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,cAAc,CAAC;YACpB;gBACE,QAAQ,GAAG,UAAU,CAAC;gBAEtB,IAAI,UAAU,CAAC;gBACf,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,MAAM,CAAC;wBACpB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,QAAQ,CAAC;wBACtB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM,CAAC;oBAC9B;wBACE,UAAU,GAAG,kBAAkB,CAAC;wBAChC,MAAM;iBACT;gBAED,IAAI,GAAG,cAAc,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxE,GAAG,GAAG,yDAAyD,UAAU,6CAA6C,CAAC;gBACvH,MAAM;YAER,KAAK,gBAAgB;gBACnB,QAAQ,GAAG,eAAe,CAAC;gBAC3B,IAAI,GAAG,WAAW,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrE,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,4DAA4D,CAAC;wBACnE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,6DAA6D,CAAC;wBACpE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,sEAAsE,CAAC;wBAC7E,MAAM;iBACT;gBAED,MAAM;SACT;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC9B,IAAI;YACJ,QAAQ;YACR,GAAG;YACH,qBAAqB,EAAE,KAAK;YAC5B,OAAO,EAAE,CAAC,OAAO,EAAE,SAAS;YAC5B,YAAY,EAAE,OAAO,EAAE,YAAY;SACpC,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;QAC/B,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QAEjD,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACN,iBAAiB,CAAC,QAA+B;QACtD,OAAO,oBAAoB,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACpH,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 { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport { BackgroundMapProvider, BackgroundMapProviderProps, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** The current set of supported map layer formats.\r\n * In order to be displayed, a corresponding format must have been registered in the [MapLayerFormatRegistry]($frontend)\r\n * @public\r\n */\r\nexport type ImageryMapLayerFormatId  = \"ArcGIS\" | \"BingMaps\" | \"MapboxImagery\" | \"TileURL\" | \"WMS\" | \"WMTS\";\r\n\r\n/** @public */\r\nexport type SubLayerId = string | number;\r\n\r\n/** JSON representation of the settings associated with a map sublayer included within a [[MapLayerProps]].\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * @see [[MapLayerProps]]\r\n * @public\r\n */\r\nexport interface MapSubLayerProps {\r\n  name: string;\r\n  title?: string;\r\n  visible?: boolean;\r\n  id?: SubLayerId;\r\n  parent?: SubLayerId;\r\n  children?: SubLayerId[];\r\n}\r\n\r\n/** Normalized representation of a [[MapSubLayerProps]] for which values\r\n * have been validated and default values have been applied where explicit values not defined.\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * This class can represent a hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.\r\n * @see [[MapLayerSettings]]\r\n * @public\r\n */\r\nexport class MapSubLayerSettings {\r\n  /** Typically Name is a single word used for machine-to-machine communication while the Title is for the benefit of humans (WMS) */\r\n  public readonly name: string;\r\n  /** Title. */\r\n  public readonly title?: string;\r\n  /** If true the sub layer is visible.  If part of a hierarchy, a sub layer is visible only if its ancestors are also visible. */\r\n  public readonly visible: boolean;\r\n  /** A unique string or number that may be used to identify the sub layer (ArcGIS) */\r\n  public readonly id: SubLayerId;\r\n  /** One or more sublayer children */\r\n  public readonly children?: SubLayerId[];\r\n  /** sublayer parent. */\r\n  public readonly parent?: SubLayerId;\r\n\r\n  constructor(name: string, title?: string, visible?: boolean, id?: SubLayerId, parent?: SubLayerId, children?: SubLayerId[]) {\r\n    this.name = name;\r\n    this.title = title;\r\n    this.visible = visible !== undefined && visible;\r\n    this.id = (id === undefined) ? this.name : id;\r\n    this.parent = parent;\r\n    this.children = children;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapSubLayerProps): MapSubLayerSettings {\r\n    return new MapSubLayerSettings(json.name, json.title, json.visible, (json.id === json.name) ? undefined : json.id, json.parent, json.children);\r\n  }\r\n\r\n  public toJSON(): MapSubLayerProps {\r\n    const props: MapSubLayerProps = { name: this.name, visible: this.visible };\r\n\r\n    if (undefined !== this.id && this.id !== this.name)\r\n      props.id = this.id;\r\n\r\n    if (undefined !== this.title)\r\n      props.title = this.title;\r\n\r\n    if (this.children)\r\n      props.children = [...this.children];\r\n\r\n    if (undefined !== this.parent)\r\n      props.parent = this.parent;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Creating a copy of this MapSubLayer, optionally modifying some if its properties */\r\n  public clone(changedProps: Partial<MapSubLayerProps>): MapSubLayerSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      id: undefined !== changedProps.id ? changedProps.id : this.id,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      parent: undefined !== changedProps.parent ? changedProps.parent : this.parent,\r\n      children: undefined !== changedProps.children ? changedProps.children.slice() : this.children?.slice(),\r\n      title: undefined !== changedProps.title ? changedProps.title : this.title,\r\n    };\r\n    return MapSubLayerSettings.fromJSON(props)!;\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapSubLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible;\r\n  }\r\n\r\n  /** return true if this sublayer is named. */\r\n  public get isNamed(): boolean { return this.name.length > 0; }\r\n\r\n  /** return true if this sublayer is a leaf (has no children) */\r\n  public get isLeaf(): boolean { return this.children === undefined || this.children.length === 0; }\r\n\r\n  /** return true if this sublayer is an unnamed group */\r\n  public get isUnnamedGroup(): boolean { return !this.isLeaf && !this.isNamed; }\r\n\r\n  /** return a string representing this sublayer id (converting to string if underlying id is number) */\r\n  public get idString(): string { return (typeof this.id === \"number\") ? this.id.toString(10) : this.id; }\r\n}\r\n\r\n/** JSON representation of properties common to both [[ImageMapLayerProps]] and [[ModelMapLayerProps]].\r\n * @see [[MapImageryProps]]\r\n * @public\r\n */\r\nexport interface CommonMapLayerProps {\r\n  /** Controls visibility of layer. Defaults to 'true'. */\r\n  visible?: boolean;\r\n\r\n  /** A user-friendly name for the layer. */\r\n  name: string;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing,\r\n   * or false to indicate the transparency should not be overridden.\r\n   * Default value: 0.\r\n   */\r\n  transparency?: number;\r\n  /** True to indicate background is transparent.\r\n   * Default: true.\r\n   */\r\n  transparentBackground?: boolean;\r\n}\r\n\r\n/** JSON representation of an [[ImageMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @see [[ImageryMapLayerFormatId]].\r\n * @public\r\n */\r\nexport interface ImageMapLayerProps extends CommonMapLayerProps {\r\n  /** URL */\r\n  url: string;\r\n  /** Identifies the map layers source.*/\r\n  formatId: string;\r\n  /** Source layers. If undefined all layers are displayed. */\r\n  subLayers?: MapSubLayerProps[];\r\n  /** Access Key for the Layer, like a subscription key or access token.\r\n   * ###TODO This does not belong in the props object. It should never be persisted.\r\n   */\r\n  /** @internal */\r\n  accessKey?: MapLayerKey;\r\n\r\n  /** @internal */\r\n  modelId?: never;\r\n}\r\n\r\n/** JSON representation of a [[ModelMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport interface ModelMapLayerProps extends CommonMapLayerProps {\r\n  /** The Id of the [GeometricModel]($backend) containing the geometry to be drawn by the layer. */\r\n  modelId: Id64String;\r\n\r\n  /** @internal */\r\n  url?: never;\r\n  /** @internal */\r\n  formatId?: never;\r\n  /** @internal */\r\n  subLayers?: never;\r\n  /** @internal */\r\n  accessKey?: never;\r\n}\r\n\r\n/** JSON representation of a [[MapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport type MapLayerProps = ImageMapLayerProps | ModelMapLayerProps;\r\n\r\n/**\r\n * stores key-value pair to be added to all requests made involving map layer.\r\n * @public\r\n */\r\nexport interface MapLayerKey {\r\n  key: string;\r\n  value: string;\r\n}\r\n\r\n/** 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.\r\n * This class is extended by [[ImageMapLayerSettings]] and [ModelMapLayerSettings]] to create the settings for image and model based layers.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @public\r\n */\r\nexport abstract class MapLayerSettings {\r\n  public readonly visible: boolean;\r\n\r\n  public readonly name: string;\r\n  public readonly transparency: number;\r\n  public readonly transparentBackground: boolean;\r\n  public abstract get allSubLayersInvisible(): boolean;\r\n  public abstract clone(changedProps: Partial<MapLayerProps>): MapLayerSettings;\r\n  public abstract toJSON(): MapLayerProps;\r\n\r\n  /** @internal */\r\n  protected constructor(name: string, visible = true, transparency: number = 0, transparentBackground = true) {\r\n    this.name = name;\r\n    this.visible = visible;\r\n    this.transparentBackground = transparentBackground;\r\n    this.transparency = transparency;\r\n  }\r\n\r\n  /** Create a map layer settings from its JSON representation. */\r\n  public static fromJSON(props: MapLayerProps): MapLayerSettings {\r\n    return undefined !== props.modelId ? ModelMapLayerSettings.fromJSON(props) : ImageMapLayerSettings.fromJSON(props);\r\n  }\r\n\r\n  /** @internal */\r\n  protected _toJSON(): CommonMapLayerProps {\r\n    const props: CommonMapLayerProps = {\r\n      name: this.name,\r\n      visible: this.visible,\r\n    };\r\n\r\n    if (0 !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.transparentBackground === false)\r\n      props.transparentBackground = this.transparentBackground;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  protected cloneProps(changedProps: Partial<MapLayerProps>): CommonMapLayerProps {\r\n    return {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,\r\n      transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible && this.transparency === other.transparency && this.transparentBackground === other.transparentBackground;\r\n  }\r\n\r\n  /** Return a unique string identifying the layers source... The URL for image layer or modelID for model layer  */\r\n  public abstract get source(): string;\r\n\r\n  /** @internal */\r\n  public matchesNameAndSource(name: string, source: string): boolean {\r\n    return this.name === name && this.source === source;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ImageMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Image map layers are created from servers that produce images that represent map tiles.  Map layers map also be represented by models.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ModelMapLayerSettings]] for model based map layer settings.\r\n * @public\r\n */\r\nexport class ImageMapLayerSettings extends MapLayerSettings {\r\n  public readonly formatId: string;\r\n  public readonly url: string;\r\n  public userName?: string;\r\n  public password?: string;\r\n  public accessKey?: MapLayerKey;\r\n  public readonly subLayers: MapSubLayerSettings[];\r\n  public override get source(): string { return this.url; }\r\n\r\n  /** @internal */\r\n  protected constructor(props: ImageMapLayerProps) {\r\n    const transparentBackground = props.transparentBackground ?? true;\r\n    super(props.name, props.visible, props.transparency, transparentBackground);\r\n\r\n    this.formatId = props.formatId;\r\n    this.url = props.url;\r\n    this.accessKey = props.accessKey;\r\n    this.subLayers = [];\r\n    if (!props.subLayers)\r\n      return;\r\n\r\n    for (const subLayerProps of props.subLayers) {\r\n      const subLayer = MapSubLayerSettings.fromJSON(subLayerProps);\r\n      if (subLayer)\r\n        this.subLayers.push(subLayer);\r\n    }\r\n  }\r\n\r\n  public static override fromJSON(props: ImageMapLayerProps): ImageMapLayerSettings {\r\n    return new this(props);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ImageMapLayerProps {\r\n    const props = super._toJSON() as ImageMapLayerProps;\r\n    props.url = this.url;\r\n    props.formatId = this.formatId;\r\n\r\n    if (this.subLayers.length > 0)\r\n      props.subLayers = this.subLayers.map((x) => x.toJSON());\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerSettings {\r\n    const clone = ImageMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n\r\n    // Clone members not part of MapLayerProps\r\n    clone.userName = this.userName;\r\n    clone.password = this.password;\r\n    clone.accessKey = this.accessKey;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ImageMapLayerProps;\r\n\r\n    props.formatId = changedProps.formatId ?? this.formatId;\r\n    props.url = changedProps.url ?? this.url;\r\n    props.accessKey = changedProps.accessKey ?? this.accessKey;\r\n    props.subLayers = changedProps.subLayers ?? this.subLayers;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (! (other instanceof ImageMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    if (this.userName !== other.userName || this.password !== other.password || this.subLayers.length !== other.subLayers.length) {\r\n      return false;\r\n    }\r\n\r\n    for (let i = 0; i < this.subLayers.length; i++)\r\n      if (!this.subLayers[i].displayMatches(other.subLayers[i]))\r\n        return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Return a sublayer matching id -- or undefined if not found */\r\n  public subLayerById(id?: SubLayerId): MapSubLayerSettings | undefined {\r\n    return id === undefined ? undefined : this.subLayers.find((subLayer) => subLayer.id === id);\r\n  }\r\n\r\n  private hasInvisibleAncestors(subLayer?: MapSubLayerSettings): boolean {\r\n    if (!subLayer || !subLayer.parent)\r\n      return false;\r\n\r\n    const parent = this.subLayerById(subLayer.parent);\r\n    if (!parent)\r\n      return false;\r\n\r\n    // Visibility of named group has no impact on the visibility of children (only unnamed group does)\r\n    // i.e For WMS, its should be possible to request a child layer when its parent is not visible (if the parent is also named)\r\n    return (!parent.visible && !parent.isNamed) || this.hasInvisibleAncestors(parent);\r\n  }\r\n\r\n  /** Return true if sublayer is visible -- testing ancestors for visibility if they exist. */\r\n  public isSubLayerVisible(subLayer: MapSubLayerSettings): boolean {\r\n    if (!subLayer.visible)\r\n      return false;\r\n\r\n    return !this.hasInvisibleAncestors(subLayer);\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible. */\r\n  public get allSubLayersInvisible(): boolean {\r\n    if (this.subLayers.length === 0)\r\n      return false;\r\n\r\n    return this.subLayers.every((subLayer) => (subLayer.isUnnamedGroup || !this.isSubLayerVisible(subLayer)));\r\n  }\r\n\r\n  /** Return the children for a sublayer */\r\n  public getSubLayerChildren(subLayer: MapSubLayerSettings): MapSubLayerSettings[] | undefined {\r\n    if (!subLayer.children)\r\n      return undefined;\r\n\r\n    const children = new Array<MapSubLayerSettings>();\r\n    subLayer.children.forEach((childId) => {\r\n      const child = this.subLayerById(childId);\r\n      if (child !== undefined)\r\n        children.push(child);\r\n    });\r\n\r\n    return children;\r\n  }\r\n\r\n  /** @internal */\r\n  protected static mapTypeName(type: BackgroundMapType) {   // TBD.. Localization.\r\n    switch (type) {\r\n      case BackgroundMapType.Aerial:\r\n        return \"Aerial Imagery\";\r\n      default:\r\n      case BackgroundMapType.Hybrid:\r\n        return \"Aerial Imagery with labels\";\r\n      case BackgroundMapType.Street:\r\n        return \"Streets\";\r\n    }\r\n  }\r\n\r\n  public setCredentials(userName?: string, password?: string) {\r\n    this.userName = userName;\r\n    this.password = password;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ModelMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Model map layers are produced from models, typically from two dimensional geometry that may originate in a GIS system.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ImageMapLayerSettings]] for image based map layer settings.\r\n * @public\r\n */\r\nexport class ModelMapLayerSettings extends MapLayerSettings {\r\n  public readonly modelId: Id64String;\r\n  public override get source(): string { return this.modelId; }\r\n\r\n  /** @internal */\r\n  protected constructor(modelId: Id64String,  name: string, visible = true,\r\n    transparency: number = 0, transparentBackground = true) {\r\n    super(name, visible, transparency, transparentBackground);\r\n    this.modelId = modelId;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static override fromJSON(json: ModelMapLayerProps): ModelMapLayerSettings {\r\n    const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;\r\n    return new this(json.modelId, json.name, json.visible, json.transparency, transparentBackground);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ModelMapLayerProps {\r\n    const props = super._toJSON() as ModelMapLayerProps;\r\n    props.modelId = this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerSettings {\r\n    return ModelMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ModelMapLayerProps;\r\n    props.modelId = changedProps.modelId ?? this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (!(other instanceof ModelMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    return this.modelId === other.modelId;\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible (always false as model layers do not include sublayers). */\r\n  public get allSubLayersInvisible(): boolean {\r\n    return false;\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport interface BaseMapLayerProps extends ImageMapLayerProps {\r\n  provider?: BackgroundMapProviderProps;\r\n}\r\n\r\n/** A [[ImageMapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].\r\n * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based\r\n * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).\r\n * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows\r\n * the imagery provider and/or type to be easily modified.\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @public\r\n */\r\nexport class BaseMapLayerSettings extends ImageMapLayerSettings {\r\n  private _provider?: BackgroundMapProvider;\r\n\r\n  /** The provider from which this base layer was configured, if any. */\r\n  public get provider(): BackgroundMapProvider | undefined { return this._provider; }\r\n\r\n  /** Create a base layer from its JSON representation.\r\n   * TODO: This, MapLayerSettings.fromJSON, and MapSubLayerSettings.fromJSON should never return undefined.\r\n   * That means they should not accept undefined for props and should define props such that it fully describes the\r\n   * layer - e.g., url and name must be defined.\r\n   */\r\n  public static override fromJSON(props: BaseMapLayerProps): BaseMapLayerSettings {\r\n    const settings = super.fromJSON(props);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n    if (props.provider)\r\n      settings._provider = BackgroundMapProvider.fromJSON(props.provider);\r\n\r\n    return settings;\r\n  }\r\n\r\n  /** Convert this layer to its JSON representation. */\r\n  public override toJSON(): BaseMapLayerProps {\r\n    const props = super.toJSON() as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override cloneProps(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as BaseMapLayerProps;\r\n\r\n    if (changedProps.provider)\r\n      props.provider = changedProps.provider;\r\n    else if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this layer. */\r\n  public override clone(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerSettings {\r\n    const prevUrl = this.url;\r\n    const clone = BaseMapLayerSettings.fromJSON(this.cloneProps(changedProps))!;\r\n\r\n    if (this.provider && prevUrl !== this.url)\r\n      clone._provider = undefined;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** Create a base layer from a BackgroundMapProvider. */\r\n  public static fromProvider(provider: BackgroundMapProvider, options?: { invisible?: boolean, transparency?: number }): BaseMapLayerSettings {\r\n    let formatId: string, url: string, name: string;\r\n    switch (provider.name) {\r\n      case \"BingProvider\":\r\n      default:\r\n        formatId = \"BingMaps\";\r\n\r\n        let imagerySet;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            imagerySet = \"Road\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            imagerySet = \"Aerial\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n          default:\r\n            imagerySet = \"AerialWithLabels\";\r\n            break;\r\n        }\r\n\r\n        name = `Bing Maps: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        url = `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/${imagerySet}?o=json&incl=ImageryProviders&key={bingKey}`;\r\n        break;\r\n\r\n      case \"MapBoxProvider\":\r\n        formatId = \"MapboxImagery\";\r\n        name = `MapBox: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/streets-v11/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-v9/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-streets-v11/tiles/\";\r\n            break;\r\n        }\r\n\r\n        break;\r\n    }\r\n\r\n    const settings = super.fromJSON({\r\n      name,\r\n      formatId,\r\n      url,\r\n      transparentBackground: false,\r\n      visible: !options?.invisible,\r\n      transparency: options?.transparency,\r\n    });\r\n\r\n    assert(undefined !== settings);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n\r\n    settings._provider = provider;\r\n    return settings;\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BaseMapLayerSettings {\r\n    return this.fromProvider(BackgroundMapProvider.fromBackgroundMapProps(props));\r\n  }\r\n\r\n  /** @alpha */\r\n  public cloneWithProvider(provider: BackgroundMapProvider): BaseMapLayerSettings {\r\n    return BaseMapLayerSettings.fromProvider(provider, { invisible: !this.visible, transparency: this.transparency });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MapLayerSettings.js","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAA8B,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AA2B/G;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAc9B,YAAY,IAAY,EAAE,KAAc,EAAE,OAAiB,EAAE,EAAe,EAAE,MAAmB,EAAE,QAAuB;QACxH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC;QAChD,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAsB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjJ,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAqB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QAE3E,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI;YAChD,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAErB,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,KAAK,CAAC,YAAuC;QAClD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,EAAE,EAAE,SAAS,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YAC7D,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,MAAM,EAAE,SAAS,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;YAC7E,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE;YACtG,KAAK,EAAE,SAAS,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK;SAC1E,CAAC;QACF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAA0B;QAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACpE,CAAC;IAED,6CAA6C;IAC7C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAElG,uDAAuD;IACvD,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,KAAa,OAAO,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;CACzG;AAoFD;;;;;GAKG;AACH,MAAM,OAAgB,gBAAgB;IAUpC,gBAAgB;IAChB,YAAsB,IAAY,EAAE,OAAO,GAAG,IAAI,EAAE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACxG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,QAAQ,CAAC,KAAoB;QACzC,OAAO,SAAS,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrH,CAAC;IAED,gBAAgB;IACN,OAAO;QACf,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK;YACtC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAE3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,YAAoC;QACvD,OAAO;YACL,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,YAAY,EAAE,SAAS,KAAK,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY;YACrG,qBAAqB,EAAE,SAAS,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB;SAC1I,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAuB;QAC3C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,CAAC;IAC9K,CAAC;IAKD,gBAAgB;IACT,oBAAoB,CAAC,IAAY,EAAE,MAAc;QACtD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;IACtD,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAkBzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEzD,gBAAgB;IAChB,YAAsB,KAAyB;QAC7C,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC;QAClE,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAE5E,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,KAAK,CAAC,WAAW,EAAE;YACrB,IAAI,CAAC,gBAAgB,GAAG,EAAC,GAAG,KAAK,CAAC,WAAW,EAAC,CAAC;SAChD;QACD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,SAAS;YAClB,OAAO;QAET,KAAK,MAAM,aAAa,IAAI,KAAK,CAAC,SAAS,EAAE;YAC3C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAC7D,IAAI,QAAQ;gBACV,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACjC;IACH,CAAC;IAEM,MAAM,CAAU,QAAQ,CAAC,KAAyB;QACvD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAC3B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAE1D,IAAI,IAAI,CAAC,gBAAgB;YACvB,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAEjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAE5E,0CAA0C;QAC1C,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,EAAC,GAAG,IAAI,CAAC,kBAAkB,EAAC,CAAC;QAC1D,IAAI,IAAI,CAAC,gBAAgB;YACvB,KAAK,CAAC,gBAAgB,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QAEnE,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QACxD,KAAK,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;QACzC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAC3D,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAC3D,IAAI,YAAY,CAAC,WAAW,EAAE;YAC5B,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,YAAY,CAAC,WAAW,EAAC,CAAC;SACnD;aAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAChC,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;SAChD;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAE,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC5E,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE;YAC5H,OAAO,KAAK,CAAC;SACd;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvD,OAAO,KAAK,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iEAAiE;IAC1D,YAAY,CAAC,EAAe;QACjC,OAAO,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEO,qBAAqB,CAAC,QAA8B;QAC1D,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC/B,OAAO,KAAK,CAAC;QAEf,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,kGAAkG;QAClG,4HAA4H;QAC5H,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC;IAED,4FAA4F;IACrF,iBAAiB,CAAC,QAA6B;QACpD,IAAI,CAAC,QAAQ,CAAC,OAAO;YACnB,OAAO,KAAK,CAAC;QAEf,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,kDAAkD;IAClD,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAA6B;QACtD,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACpB,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS;gBACrB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,WAAW,CAAC,IAAuB;QAClD,QAAQ,IAAI,EAAE;YACZ,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,gBAAgB,CAAC;YAC1B,QAAQ;YACR,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,4BAA4B,CAAC;YACtC,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;IAEM,cAAc,CAAC,QAAiB,EAAE,QAAiB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;KAEC;IACM,kBAAkB;QACvB,IAAI,WAAW,GAA4B,EAAE,CAAC;QAC9C,IAAI,IAAI,CAAC,gBAAgB;YACvB,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAE3C,IAAI,IAAI,CAAC,kBAAkB;YACzB,WAAW,GAAG,EAAC,GAAG,WAAW,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAEzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7D,gBAAgB;IAChB,YAAsB,OAAmB,EAAG,IAAY,EAAE,OAAO,GAAG,IAAI,EACtE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACtD,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAU,QAAQ,CAAC,IAAwB;QACtD,MAAM,qBAAqB,GAAG,CAAC,IAAI,CAAC,qBAAqB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC7G,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;IACnG,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QACnE,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAC,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC3E,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,0GAA0G;IAC1G,IAAW,qBAAqB;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AASD;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,qBAAqB;IAG7D,sEAAsE;IACtE,IAAW,QAAQ,KAAwC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAU,QAAQ,CAAC,KAAwB;QACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QACjD,IAAI,KAAK,CAAC,QAAQ;YAChB,QAAQ,CAAC,SAAS,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEtE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qDAAqD;IACrC,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAClD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,UAAU,CAAC,YAAwC;QACjE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAsB,CAAC;QAElE,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;aACpC,IAAI,IAAI,CAAC,QAAQ;YACpB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mCAAmC;IACnB,KAAK,CAAC,YAAwC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACzB,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAE,CAAC;QAE5E,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,GAAG;YACvC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,YAAY,CAAC,QAA+B,EAAE,OAAwD;QAClH,IAAI,QAAgB,EAAE,GAAW,EAAE,IAAY,CAAC;QAChD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,cAAc,CAAC;YACpB;gBACE,QAAQ,GAAG,UAAU,CAAC;gBAEtB,IAAI,UAAU,CAAC;gBACf,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,MAAM,CAAC;wBACpB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,QAAQ,CAAC;wBACtB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM,CAAC;oBAC9B;wBACE,UAAU,GAAG,kBAAkB,CAAC;wBAChC,MAAM;iBACT;gBAED,IAAI,GAAG,cAAc,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxE,GAAG,GAAG,yDAAyD,UAAU,6CAA6C,CAAC;gBACvH,MAAM;YAER,KAAK,gBAAgB;gBACnB,QAAQ,GAAG,eAAe,CAAC;gBAC3B,IAAI,GAAG,WAAW,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrE,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,4DAA4D,CAAC;wBACnE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,6DAA6D,CAAC;wBACpE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,sEAAsE,CAAC;wBAC7E,MAAM;iBACT;gBAED,MAAM;SACT;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC9B,IAAI;YACJ,QAAQ;YACR,GAAG;YACH,qBAAqB,EAAE,KAAK;YAC5B,OAAO,EAAE,CAAC,OAAO,EAAE,SAAS;YAC5B,YAAY,EAAE,OAAO,EAAE,YAAY;SACpC,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;QAC/B,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QAEjD,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACN,iBAAiB,CAAC,QAA+B;QACtD,OAAO,oBAAoB,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACpH,CAAC;CACF","sourcesContent":["/* eslint-disable deprecation/deprecation */\r\n/*---------------------------------------------------------------------------------------------\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 { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport { BackgroundMapProvider, BackgroundMapProviderProps, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** The current set of supported map layer formats.\r\n * In order to be displayed, a corresponding format must have been registered in the [MapLayerFormatRegistry]($frontend)\r\n * @public\r\n */\r\nexport type ImageryMapLayerFormatId  = \"ArcGIS\" | \"BingMaps\" | \"MapboxImagery\" | \"TileURL\" | \"WMS\" | \"WMTS\";\r\n\r\n/** @public */\r\nexport type SubLayerId = string | number;\r\n\r\n/** JSON representation of the settings associated with a map sublayer included within a [[MapLayerProps]].\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * @see [[MapLayerProps]]\r\n * @public\r\n */\r\nexport interface MapSubLayerProps {\r\n  name: string;\r\n  title?: string;\r\n  visible?: boolean;\r\n  id?: SubLayerId;\r\n  parent?: SubLayerId;\r\n  children?: SubLayerId[];\r\n}\r\n\r\n/** Normalized representation of a [[MapSubLayerProps]] for which values\r\n * have been validated and default values have been applied where explicit values not defined.\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * This class can represent a hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.\r\n * @see [[MapLayerSettings]]\r\n * @public\r\n */\r\nexport class MapSubLayerSettings {\r\n  /** Typically Name is a single word used for machine-to-machine communication while the Title is for the benefit of humans (WMS) */\r\n  public readonly name: string;\r\n  /** Title. */\r\n  public readonly title?: string;\r\n  /** If true the sub layer is visible.  If part of a hierarchy, a sub layer is visible only if its ancestors are also visible. */\r\n  public readonly visible: boolean;\r\n  /** A unique string or number that may be used to identify the sub layer (ArcGIS) */\r\n  public readonly id: SubLayerId;\r\n  /** One or more sublayer children */\r\n  public readonly children?: SubLayerId[];\r\n  /** sublayer parent. */\r\n  public readonly parent?: SubLayerId;\r\n\r\n  constructor(name: string, title?: string, visible?: boolean, id?: SubLayerId, parent?: SubLayerId, children?: SubLayerId[]) {\r\n    this.name = name;\r\n    this.title = title;\r\n    this.visible = visible !== undefined && visible;\r\n    this.id = (id === undefined) ? this.name : id;\r\n    this.parent = parent;\r\n    this.children = children;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapSubLayerProps): MapSubLayerSettings {\r\n    return new MapSubLayerSettings(json.name, json.title, json.visible, (json.id === json.name) ? undefined : json.id, json.parent, json.children);\r\n  }\r\n\r\n  public toJSON(): MapSubLayerProps {\r\n    const props: MapSubLayerProps = { name: this.name, visible: this.visible };\r\n\r\n    if (undefined !== this.id && this.id !== this.name)\r\n      props.id = this.id;\r\n\r\n    if (undefined !== this.title)\r\n      props.title = this.title;\r\n\r\n    if (this.children)\r\n      props.children = [...this.children];\r\n\r\n    if (undefined !== this.parent)\r\n      props.parent = this.parent;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Creating a copy of this MapSubLayer, optionally modifying some if its properties */\r\n  public clone(changedProps: Partial<MapSubLayerProps>): MapSubLayerSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      id: undefined !== changedProps.id ? changedProps.id : this.id,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      parent: undefined !== changedProps.parent ? changedProps.parent : this.parent,\r\n      children: undefined !== changedProps.children ? changedProps.children.slice() : this.children?.slice(),\r\n      title: undefined !== changedProps.title ? changedProps.title : this.title,\r\n    };\r\n    return MapSubLayerSettings.fromJSON(props)!;\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapSubLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible;\r\n  }\r\n\r\n  /** return true if this sublayer is named. */\r\n  public get isNamed(): boolean { return this.name.length > 0; }\r\n\r\n  /** return true if this sublayer is a leaf (has no children) */\r\n  public get isLeaf(): boolean { return this.children === undefined || this.children.length === 0; }\r\n\r\n  /** return true if this sublayer is an unnamed group */\r\n  public get isUnnamedGroup(): boolean { return !this.isLeaf && !this.isNamed; }\r\n\r\n  /** return a string representing this sublayer id (converting to string if underlying id is number) */\r\n  public get idString(): string { return (typeof this.id === \"number\") ? this.id.toString(10) : this.id; }\r\n}\r\n\r\n/** JSON representation of properties common to both [[ImageMapLayerProps]] and [[ModelMapLayerProps]].\r\n * @see [[MapImageryProps]]\r\n * @public\r\n */\r\nexport interface CommonMapLayerProps {\r\n  /** Controls visibility of layer. Defaults to 'true'. */\r\n  visible?: boolean;\r\n\r\n  /** A user-friendly name for the layer. */\r\n  name: string;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing,\r\n   * or false to indicate the transparency should not be overridden.\r\n   * Default value: 0.\r\n   */\r\n  transparency?: number;\r\n  /** True to indicate background is transparent.\r\n   * Default: true.\r\n   */\r\n  transparentBackground?: boolean;\r\n}\r\n\r\n/** JSON representation of an [[ImageMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @see [[ImageryMapLayerFormatId]].\r\n * @public\r\n */\r\nexport interface ImageMapLayerProps extends CommonMapLayerProps {\r\n  /** URL */\r\n  url: string;\r\n  /** Identifies the map layers source.*/\r\n  formatId: string;\r\n  /** Source layers. If undefined all layers are displayed. */\r\n  subLayers?: MapSubLayerProps[];\r\n  /** Access Key for the Layer, like a subscription key or access token.\r\n   * ###TODO This does not belong in the props object. It should never be persisted.\r\n   */\r\n  /** @internal */\r\n  accessKey?: MapLayerKey;\r\n\r\n  /** @internal */\r\n  modelId?: never;\r\n\r\n  /** List of query parameters that will get appended to the source.\r\n   * @beta\r\n  */\r\n  queryParams?: { [key: string]: string };\r\n\r\n}\r\n\r\n/** JSON representation of a [[ModelMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport interface ModelMapLayerProps extends CommonMapLayerProps {\r\n  /** The Id of the [GeometricModel]($backend) containing the geometry to be drawn by the layer. */\r\n  modelId: Id64String;\r\n\r\n  /** @internal */\r\n  url?: never;\r\n  /** @internal */\r\n  formatId?: never;\r\n  /** @internal */\r\n  subLayers?: never;\r\n  /** @internal */\r\n  accessKey?: never;\r\n}\r\n\r\n/** JSON representation of a [[MapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport type MapLayerProps = ImageMapLayerProps | ModelMapLayerProps;\r\n\r\n/**\r\n * stores key-value pair to be added to all requests made involving map layer.\r\n * @public\r\n */\r\nexport interface MapLayerKey {\r\n  key: string;\r\n  value: string;\r\n}\r\n\r\n/** 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.\r\n * This class is extended by [[ImageMapLayerSettings]] and [ModelMapLayerSettings]] to create the settings for image and model based layers.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @public\r\n */\r\nexport abstract class MapLayerSettings {\r\n  public readonly visible: boolean;\r\n\r\n  public readonly name: string;\r\n  public readonly transparency: number;\r\n  public readonly transparentBackground: boolean;\r\n  public abstract get allSubLayersInvisible(): boolean;\r\n  public abstract clone(changedProps: Partial<MapLayerProps>): MapLayerSettings;\r\n  public abstract toJSON(): MapLayerProps;\r\n\r\n  /** @internal */\r\n  protected constructor(name: string, visible = true, transparency: number = 0, transparentBackground = true) {\r\n    this.name = name;\r\n    this.visible = visible;\r\n    this.transparentBackground = transparentBackground;\r\n    this.transparency = transparency;\r\n  }\r\n\r\n  /** Create a map layer settings from its JSON representation. */\r\n  public static fromJSON(props: MapLayerProps): MapLayerSettings {\r\n    return undefined !== props.modelId ? ModelMapLayerSettings.fromJSON(props) : ImageMapLayerSettings.fromJSON(props);\r\n  }\r\n\r\n  /** @internal */\r\n  protected _toJSON(): CommonMapLayerProps {\r\n    const props: CommonMapLayerProps = {\r\n      name: this.name,\r\n      visible: this.visible,\r\n    };\r\n\r\n    if (0 !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.transparentBackground === false)\r\n      props.transparentBackground = this.transparentBackground;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  protected cloneProps(changedProps: Partial<MapLayerProps>): CommonMapLayerProps {\r\n    return {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,\r\n      transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible && this.transparency === other.transparency && this.transparentBackground === other.transparentBackground;\r\n  }\r\n\r\n  /** Return a unique string identifying the layers source... The URL for image layer or modelID for model layer  */\r\n  public abstract get source(): string;\r\n\r\n  /** @internal */\r\n  public matchesNameAndSource(name: string, source: string): boolean {\r\n    return this.name === name && this.source === source;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ImageMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Image map layers are created from servers that produce images that represent map tiles.  Map layers map also be represented by models.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ModelMapLayerSettings]] for model based map layer settings.\r\n * @public\r\n */\r\nexport class ImageMapLayerSettings extends MapLayerSettings {\r\n  public readonly formatId: string;\r\n  public readonly url: string;\r\n  public userName?: string;\r\n  public password?: string;\r\n  public accessKey?: MapLayerKey;\r\n\r\n  /** List of query parameters to append to the settings URL and persisted as part of the JSON representation.\r\n   * @note Sensitive information like user credentials should be provided in [[unsavedQueryParams]] to ensure it is never persisted.\r\n   * @beta\r\n  */\r\n  public savedQueryParams?: { [key: string]: string };\r\n\r\n  /** List of query parameters that will get appended to the settings URL that should *not* be be persisted part of the JSON representation.\r\n   * @beta\r\n  */\r\n  public unsavedQueryParams?: { [key: string]: string };\r\n  public readonly subLayers: MapSubLayerSettings[];\r\n  public override get source(): string { return this.url; }\r\n\r\n  /** @internal */\r\n  protected constructor(props: ImageMapLayerProps) {\r\n    const transparentBackground = props.transparentBackground ?? true;\r\n    super(props.name, props.visible, props.transparency, transparentBackground);\r\n\r\n    this.formatId = props.formatId;\r\n    this.url = props.url;\r\n    this.accessKey = props.accessKey;\r\n    if (props.queryParams) {\r\n      this.savedQueryParams = {...props.queryParams};\r\n    }\r\n    this.subLayers = [];\r\n    if (!props.subLayers)\r\n      return;\r\n\r\n    for (const subLayerProps of props.subLayers) {\r\n      const subLayer = MapSubLayerSettings.fromJSON(subLayerProps);\r\n      if (subLayer)\r\n        this.subLayers.push(subLayer);\r\n    }\r\n  }\r\n\r\n  public static override fromJSON(props: ImageMapLayerProps): ImageMapLayerSettings {\r\n    return new this(props);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ImageMapLayerProps {\r\n    const props = super._toJSON() as ImageMapLayerProps;\r\n    props.url = this.url;\r\n    props.formatId = this.formatId;\r\n\r\n    if (this.subLayers.length > 0)\r\n      props.subLayers = this.subLayers.map((x) => x.toJSON());\r\n\r\n    if (this.savedQueryParams)\r\n      props.queryParams = {...this.savedQueryParams};\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerSettings {\r\n    const clone = ImageMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n\r\n    // Clone members not part of MapLayerProps\r\n    clone.userName = this.userName;\r\n    clone.password = this.password;\r\n    clone.accessKey = this.accessKey;\r\n    if (this.unsavedQueryParams)\r\n      clone.unsavedQueryParams = {...this.unsavedQueryParams};\r\n    if (this.savedQueryParams)\r\n      clone.savedQueryParams = {...this.savedQueryParams};\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ImageMapLayerProps;\r\n\r\n    props.formatId = changedProps.formatId ?? this.formatId;\r\n    props.url = changedProps.url ?? this.url;\r\n    props.accessKey = changedProps.accessKey ?? this.accessKey;\r\n    props.subLayers = changedProps.subLayers ?? this.subLayers;\r\n    if (changedProps.queryParams) {\r\n      props.queryParams = {...changedProps.queryParams};\r\n    } else if (this.savedQueryParams) {\r\n      props.queryParams = {...this.savedQueryParams};\r\n    }\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (! (other instanceof ImageMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    if (this.userName !== other.userName || this.password !== other.password || this.subLayers.length !== other.subLayers.length) {\r\n      return false;\r\n    }\r\n\r\n    for (let i = 0; i < this.subLayers.length; i++)\r\n      if (!this.subLayers[i].displayMatches(other.subLayers[i]))\r\n        return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Return a sublayer matching id -- or undefined if not found */\r\n  public subLayerById(id?: SubLayerId): MapSubLayerSettings | undefined {\r\n    return id === undefined ? undefined : this.subLayers.find((subLayer) => subLayer.id === id);\r\n  }\r\n\r\n  private hasInvisibleAncestors(subLayer?: MapSubLayerSettings): boolean {\r\n    if (!subLayer || !subLayer.parent)\r\n      return false;\r\n\r\n    const parent = this.subLayerById(subLayer.parent);\r\n    if (!parent)\r\n      return false;\r\n\r\n    // Visibility of named group has no impact on the visibility of children (only unnamed group does)\r\n    // i.e For WMS, its should be possible to request a child layer when its parent is not visible (if the parent is also named)\r\n    return (!parent.visible && !parent.isNamed) || this.hasInvisibleAncestors(parent);\r\n  }\r\n\r\n  /** Return true if sublayer is visible -- testing ancestors for visibility if they exist. */\r\n  public isSubLayerVisible(subLayer: MapSubLayerSettings): boolean {\r\n    if (!subLayer.visible)\r\n      return false;\r\n\r\n    return !this.hasInvisibleAncestors(subLayer);\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible. */\r\n  public get allSubLayersInvisible(): boolean {\r\n    if (this.subLayers.length === 0)\r\n      return false;\r\n\r\n    return this.subLayers.every((subLayer) => (subLayer.isUnnamedGroup || !this.isSubLayerVisible(subLayer)));\r\n  }\r\n\r\n  /** Return the children for a sublayer */\r\n  public getSubLayerChildren(subLayer: MapSubLayerSettings): MapSubLayerSettings[] | undefined {\r\n    if (!subLayer.children)\r\n      return undefined;\r\n\r\n    const children = new Array<MapSubLayerSettings>();\r\n    subLayer.children.forEach((childId) => {\r\n      const child = this.subLayerById(childId);\r\n      if (child !== undefined)\r\n        children.push(child);\r\n    });\r\n\r\n    return children;\r\n  }\r\n\r\n  /** @internal */\r\n  protected static mapTypeName(type: BackgroundMapType) {   // TBD.. Localization.\r\n    switch (type) {\r\n      case BackgroundMapType.Aerial:\r\n        return \"Aerial Imagery\";\r\n      default:\r\n      case BackgroundMapType.Hybrid:\r\n        return \"Aerial Imagery with labels\";\r\n      case BackgroundMapType.Street:\r\n        return \"Streets\";\r\n    }\r\n  }\r\n\r\n  public setCredentials(userName?: string, password?: string) {\r\n    this.userName = userName;\r\n    this.password = password;\r\n  }\r\n\r\n  /** Collect all query parameters\r\n * @beta\r\n */\r\n  public collectQueryParams() {\r\n    let queryParams: {[key: string]: string} = {};\r\n    if (this.savedQueryParams)\r\n      queryParams = {...this.savedQueryParams};\r\n\r\n    if (this.unsavedQueryParams)\r\n      queryParams = {...queryParams, ...this.unsavedQueryParams};\r\n\r\n    return queryParams;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ModelMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Model map layers are produced from models, typically from two dimensional geometry that may originate in a GIS system.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ImageMapLayerSettings]] for image based map layer settings.\r\n * @public\r\n */\r\nexport class ModelMapLayerSettings extends MapLayerSettings {\r\n  public readonly modelId: Id64String;\r\n  public override get source(): string { return this.modelId; }\r\n\r\n  /** @internal */\r\n  protected constructor(modelId: Id64String,  name: string, visible = true,\r\n    transparency: number = 0, transparentBackground = true) {\r\n    super(name, visible, transparency, transparentBackground);\r\n    this.modelId = modelId;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static override fromJSON(json: ModelMapLayerProps): ModelMapLayerSettings {\r\n    const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;\r\n    return new this(json.modelId, json.name, json.visible, json.transparency, transparentBackground);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ModelMapLayerProps {\r\n    const props = super._toJSON() as ModelMapLayerProps;\r\n    props.modelId = this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerSettings {\r\n    return ModelMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ModelMapLayerProps;\r\n    props.modelId = changedProps.modelId ?? this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (!(other instanceof ModelMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    return this.modelId === other.modelId;\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible (always false as model layers do not include sublayers). */\r\n  public get allSubLayersInvisible(): boolean {\r\n    return false;\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport interface BaseMapLayerProps extends ImageMapLayerProps {\r\n  provider?: BackgroundMapProviderProps;\r\n}\r\n\r\n/** A [[ImageMapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].\r\n * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based\r\n * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).\r\n * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows\r\n * the imagery provider and/or type to be easily modified.\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @public\r\n */\r\nexport class BaseMapLayerSettings extends ImageMapLayerSettings {\r\n  private _provider?: BackgroundMapProvider;\r\n\r\n  /** The provider from which this base layer was configured, if any. */\r\n  public get provider(): BackgroundMapProvider | undefined { return this._provider; }\r\n\r\n  /** Create a base layer from its JSON representation.\r\n   * TODO: This, MapLayerSettings.fromJSON, and MapSubLayerSettings.fromJSON should never return undefined.\r\n   * That means they should not accept undefined for props and should define props such that it fully describes the\r\n   * layer - e.g., url and name must be defined.\r\n   */\r\n  public static override fromJSON(props: BaseMapLayerProps): BaseMapLayerSettings {\r\n    const settings = super.fromJSON(props);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n    if (props.provider)\r\n      settings._provider = BackgroundMapProvider.fromJSON(props.provider);\r\n\r\n    return settings;\r\n  }\r\n\r\n  /** Convert this layer to its JSON representation. */\r\n  public override toJSON(): BaseMapLayerProps {\r\n    const props = super.toJSON() as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override cloneProps(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as BaseMapLayerProps;\r\n\r\n    if (changedProps.provider)\r\n      props.provider = changedProps.provider;\r\n    else if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this layer. */\r\n  public override clone(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerSettings {\r\n    const prevUrl = this.url;\r\n    const clone = BaseMapLayerSettings.fromJSON(this.cloneProps(changedProps))!;\r\n\r\n    if (this.provider && prevUrl !== this.url)\r\n      clone._provider = undefined;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** Create a base layer from a BackgroundMapProvider. */\r\n  public static fromProvider(provider: BackgroundMapProvider, options?: { invisible?: boolean, transparency?: number }): BaseMapLayerSettings {\r\n    let formatId: string, url: string, name: string;\r\n    switch (provider.name) {\r\n      case \"BingProvider\":\r\n      default:\r\n        formatId = \"BingMaps\";\r\n\r\n        let imagerySet;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            imagerySet = \"Road\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            imagerySet = \"Aerial\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n          default:\r\n            imagerySet = \"AerialWithLabels\";\r\n            break;\r\n        }\r\n\r\n        name = `Bing Maps: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        url = `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/${imagerySet}?o=json&incl=ImageryProviders&key={bingKey}`;\r\n        break;\r\n\r\n      case \"MapBoxProvider\":\r\n        formatId = \"MapboxImagery\";\r\n        name = `MapBox: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/streets-v11/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-v9/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-streets-v11/tiles/\";\r\n            break;\r\n        }\r\n\r\n        break;\r\n    }\r\n\r\n    const settings = super.fromJSON({\r\n      name,\r\n      formatId,\r\n      url,\r\n      transparentBackground: false,\r\n      visible: !options?.invisible,\r\n      transparency: options?.transparency,\r\n    });\r\n\r\n    assert(undefined !== settings);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n\r\n    settings._provider = provider;\r\n    return settings;\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BaseMapLayerSettings {\r\n    return this.fromProvider(BackgroundMapProvider.fromBackgroundMapProps(props));\r\n  }\r\n\r\n  /** @alpha */\r\n  public cloneWithProvider(provider: BackgroundMapProvider): BaseMapLayerSettings {\r\n    return BaseMapLayerSettings.fromProvider(provider, { invisible: !this.visible, transparency: this.transparency });\r\n  }\r\n}\r\n"]}

package/lib/esm/ThematicDisplay.d.ts

@@ -4,6 +4,7 @@
 import { Point3d, Range1d, Range1dProps, Vector3d, XYZProps } from "@itwin/core-geometry";
 import { ColorDef, ColorDefProps } from "./ColorDef";
 import { Gradient } from "./Gradient";
+import { TextureTransparency } from "./TextureProps";
 /** A thematic gradient mode used to generate and apply a thematic effect to a scene.
  * @see [[ThematicGradientSettings.mode]]
  * @public
@@ -19,6 +20,23 @@ export declare enum ThematicGradientMode {
     /** Apply isolines to the scene to achieve an effect similar to a contour map. Can only be used with [[ThematicDisplayMode.Height]]. */
     IsoLines = 3
 }
+/** Describes how transparency is computed when applying a thematic gradient to a surface.
+ * Each [[Gradient.KeyColor]] in [[ThematicGradientSettings.customKeys]] has a transparency value.
+ * Each surface to which the gradient is applied has its own transparency.
+ * The transparency mode determines how these two values are combined to compute the final transparency.
+ * @see [[ThematicGradientSettings.transparencyMode]].
+ * @public
+ * @extensions
+ */
+export declare enum ThematicGradientTransparencyMode {
+    /** Ignore the gradient's transparency, applying only the surface's own transparency. */
+    SurfaceOnly = 0,
+    /** The final transparency is computed from the product of the surface and gradient alpha channels.
+     * (Alpha is the inverse of transparency, where `alpha = (255 - transparency) / 255`).
+     * If the gradient color is opaque, this produces the same result as [[SurfaceOnly]].
+     */
+    MultiplySurfaceAndGradient = 1
+}
 /** A color scheme used to generate the colors of a thematic gradient within an applied range.
  * @see [[ThematicGradientSettings.colorScheme]]
  * @see [[ThematicDisplay.range]]
@@ -58,6 +76,8 @@ export interface ThematicGradientSettingsProps {
     customKeys?: Gradient.KeyColorProps[];
     /** See [[ThematicGradientSettings.colorMix]]. */
     colorMix?: number;
+    /** See [[ThematicGradientSettings.transparencyMode]]. */
+    transparencyMode?: ThematicGradientTransparencyMode;
 }
 /** Thematic settings specific to creating a color gradient used by [[ThematicDisplay]].
  * @public
@@ -79,11 +99,18 @@ export declare class ThematicGradientSettings {
     /** The percentage to mix in the original color with the thematic display gradient color (0-1).
      * Applies to background map terrain and point clouds only.  Defaults to 0. */
     readonly colorMix: number;
+    /** Specifies how the transparency is computed. Defaults to [[ThematicGradientTransparencyMode.SurfaceOnly]].
+     * @note This property is ignored for gradients applied using an [[AnalysisStyle]] via [[AnalysisStyleThematic]] - in that case, only the color and
+     * transparency of the thematic gradient are applied.
+     */
+    readonly transparencyMode: ThematicGradientTransparencyMode;
     static get margin(): number;
     static get contentRange(): number;
     static get contentMax(): number;
     static readonly defaults: ThematicGradientSettings;
     private static _defaultCustomKeys;
+    /** @alpha */
+    get textureTransparency(): TextureTransparency;
     equals(other: ThematicGradientSettings): boolean;
     /** Compares two sets of thematic gradient settings.
      * @param lhs First set of thematic gradient settings to compare

package/lib/esm/ThematicDisplay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ThematicDisplay.d.ts","sourceRoot":"","sources":["../../src/ThematicDisplay.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;GAIG;AACH,oBAAY,oBAAoB;IAC9B,kDAAkD;IAClD,MAAM,IAAI;IACV,mDAAmD;IACnD,OAAO,IAAI;IACX,yJAAyJ;IACzJ,oBAAoB,IAAI;IACxB,uIAAuI;IACvI,QAAQ,IAAI;CACb;AAED;;;;;GAKG;AACH,oBAAY,2BAA2B;IACrC,uEAAuE;IACvE,OAAO,IAAI;IACX,uEAAuE;IACvE,OAAO,IAAI;IACX,uFAAuF;IACvF,UAAU,IAAI;IACd,kEAAkE;IAClE,WAAW,IAAI;IACf,mEAAmE;IACnE,WAAW,IAAI;IACf;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;;IAGI;AACJ,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,oDAAoD;IACpD,WAAW,CAAC,EAAE,2BAA2B,CAAC;IAC1C,iDAAiD;IACjD,UAAU,CAAC,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtC,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACnC,0GAA0G;IAC1G,SAAgB,IAAI,EAAE,oBAAoB,CAAC;IAC3C,mMAAmM;IACnM,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,sKAAsK;IACtK,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,wJAAwJ;IACxJ,SAAgB,WAAW,EAAE,2BAA2B,CAAC;IACzD;;;OAGG;IACH,SAAgB,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAChD;kFAC8E;IAC9E,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,WAAkB,MAAM,IAAI,MAAM,CAAiB;IACnD,WAAkB,YAAY,IAAI,MAAM,CAAwD;IAChG,WAAkB,UAAU,IAAI,MAAM,CAAkD;IAExF,gBAAuB,QAAQ,2BAAoC;IAEnE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0C;IAEpE,MAAM,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO;IAsBvD;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAE,wBAAwB,GAAG,MAAM;IAuB3F,OAAO;WAqCO,QAAQ,CAAC,IAAI,CAAC,EAAE,6BAA6B;IAIpD,MAAM,IAAI,6BAA6B;IAwB9C;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,6BAA6B,GAAG,wBAAwB;CAerF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,0HAA0H;IAC1H,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,4EAA4E;IACrE,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,0HAA0H;IAC1H,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,OAAO;IAcA,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;WAItC,QAAQ,CAAC,IAAI,CAAC,EAAE,0BAA0B;IAIjD,MAAM,IAAI,0BAA0B;CAM5C;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,+DAA+D;IAC/D,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACvC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,6BAA6B;IACxC,+DAA+D;IAC/D,SAAgB,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjD;;;;OAIG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAYA,MAAM,CAAC,KAAK,EAAE,6BAA6B,GAAG,OAAO;WAkB9C,QAAQ,CAAC,IAAI,CAAC,EAAE,kCAAkC;IAIzD,MAAM,IAAI,kCAAkC;CAUpD;AAED;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B,8GAA8G;IAC9G,MAAM,IAAI;IACV;;OAEG;IACH,8BAA8B,IAAI;IAClC;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,uJAAuJ;IACvJ,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,wKAAwK;IACxK,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IACjD;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,gPAAgP;IAChP,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,mHAAmH;IACnH,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,kCAAkC,CAAC;CACrD;AAED;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B,uJAAuJ;IACvJ,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,wKAAwK;IACxK,SAAgB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3D;;;;OAIG;IACH,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,2OAA2O;IAC3O,SAAgB,IAAI,EAAE,QAAQ,CAAC;IAC/B,mHAAmH;IACnH,SAAgB,YAAY,EAAE,QAAQ,CAAC;IACvC;;OAEG;IACH,SAAgB,cAAc,EAAE,6BAA6B,CAAC;IAEvD,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAiB9C,OAAO;WAkCO,QAAQ,CAAC,IAAI,CAAC,EAAE,oBAAoB;IAI3C,MAAM,IAAI,oBAAoB;CActC"}
+{"version":3,"file":"ThematicDisplay.d.ts","sourceRoot":"","sources":["../../src/ThematicDisplay.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD;;;;GAIG;AACH,oBAAY,oBAAoB;IAC9B,kDAAkD;IAClD,MAAM,IAAI;IACV,mDAAmD;IACnD,OAAO,IAAI;IACX,yJAAyJ;IACzJ,oBAAoB,IAAI;IACxB,uIAAuI;IACvI,QAAQ,IAAI;CACb;AAED;;;;;;;GAOG;AACH,oBAAY,gCAAgC;IAC1C,wFAAwF;IACxF,WAAW,IAAI;IACf;;;OAGG;IACH,0BAA0B,IAAI;CAC/B;AAED;;;;;GAKG;AACH,oBAAY,2BAA2B;IACrC,uEAAuE;IACvE,OAAO,IAAI;IACX,uEAAuE;IACvE,OAAO,IAAI;IACX,uFAAuF;IACvF,UAAU,IAAI;IACd,kEAAkE;IAClE,WAAW,IAAI;IACf,mEAAmE;IACnE,WAAW,IAAI;IACf;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;;IAGI;AACJ,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,oDAAoD;IACpD,WAAW,CAAC,EAAE,2BAA2B,CAAC;IAC1C,iDAAiD;IACjD,UAAU,CAAC,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtC,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,gCAAgC,CAAC;CACrD;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACnC,0GAA0G;IAC1G,SAAgB,IAAI,EAAE,oBAAoB,CAAC;IAC3C,mMAAmM;IACnM,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,sKAAsK;IACtK,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,wJAAwJ;IACxJ,SAAgB,WAAW,EAAE,2BAA2B,CAAC;IACzD;;;OAGG;IACH,SAAgB,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAChD;kFAC8E;IAC9E,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,gBAAgB,EAAE,gCAAgC,CAAC;IAEnE,WAAkB,MAAM,IAAI,MAAM,CAAiB;IACnD,WAAkB,YAAY,IAAI,MAAM,CAAwD;IAChG,WAAkB,UAAU,IAAI,MAAM,CAAkD;IAExF,gBAAuB,QAAQ,2BAAoC;IAEnE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0C;IAE3E,aAAa;IACb,IAAW,mBAAmB,IAAI,mBAAmB,CAoBpD;IAEM,MAAM,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO;IAUvD;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAE,wBAAwB,GAAG,MAAM;IAwB3F,OAAO;WAuCO,QAAQ,CAAC,IAAI,CAAC,EAAE,6BAA6B;IAIpD,MAAM,IAAI,6BAA6B;IA2B9C;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,6BAA6B,GAAG,wBAAwB;CAgBrF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,0HAA0H;IAC1H,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,4EAA4E;IACrE,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,0HAA0H;IAC1H,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,OAAO;IAcA,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;WAItC,QAAQ,CAAC,IAAI,CAAC,EAAE,0BAA0B;IAIjD,MAAM,IAAI,0BAA0B;CAM5C;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,+DAA+D;IAC/D,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACvC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,6BAA6B;IACxC,+DAA+D;IAC/D,SAAgB,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjD;;;;OAIG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAYA,MAAM,CAAC,KAAK,EAAE,6BAA6B,GAAG,OAAO;WAkB9C,QAAQ,CAAC,IAAI,CAAC,EAAE,kCAAkC;IAIzD,MAAM,IAAI,kCAAkC;CAUpD;AAED;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B,8GAA8G;IAC9G,MAAM,IAAI;IACV;;OAEG;IACH,8BAA8B,IAAI;IAClC;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,uJAAuJ;IACvJ,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,wKAAwK;IACxK,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IACjD;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,gPAAgP;IAChP,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,mHAAmH;IACnH,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,kCAAkC,CAAC;CACrD;AAED;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B,uJAAuJ;IACvJ,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,wKAAwK;IACxK,SAAgB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3D;;;;OAIG;IACH,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,2OAA2O;IAC3O,SAAgB,IAAI,EAAE,QAAQ,CAAC;IAC/B,mHAAmH;IACnH,SAAgB,YAAY,EAAE,QAAQ,CAAC;IACvC;;OAEG;IACH,SAAgB,cAAc,EAAE,6BAA6B,CAAC;IAEvD,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAiB9C,OAAO;WAkCO,QAAQ,CAAC,IAAI,CAAC,EAAE,oBAAoB;IAI3C,MAAM,IAAI,oBAAoB;CActC"}

package/lib/esm/ThematicDisplay.js

@@ -9,6 +9,7 @@ import { compareNumbers } from "@itwin/core-bentley";
 import { Point3d, Range1d, Vector3d } from "@itwin/core-geometry";
 import { ColorDef } from "./ColorDef";
 import { Gradient } from "./Gradient";
+import { TextureTransparency } from "./TextureProps";
 /** A thematic gradient mode used to generate and apply a thematic effect to a scene.
  * @see [[ThematicGradientSettings.mode]]
  * @public
@@ -25,6 +26,24 @@ export var ThematicGradientMode;
     /** Apply isolines to the scene to achieve an effect similar to a contour map. Can only be used with [[ThematicDisplayMode.Height]]. */
     ThematicGradientMode[ThematicGradientMode["IsoLines"] = 3] = "IsoLines";
 })(ThematicGradientMode || (ThematicGradientMode = {}));
+/** Describes how transparency is computed when applying a thematic gradient to a surface.
+ * Each [[Gradient.KeyColor]] in [[ThematicGradientSettings.customKeys]] has a transparency value.
+ * Each surface to which the gradient is applied has its own transparency.
+ * The transparency mode determines how these two values are combined to compute the final transparency.
+ * @see [[ThematicGradientSettings.transparencyMode]].
+ * @public
+ * @extensions
+ */
+export var ThematicGradientTransparencyMode;
+(function (ThematicGradientTransparencyMode) {
+    /** Ignore the gradient's transparency, applying only the surface's own transparency. */
+    ThematicGradientTransparencyMode[ThematicGradientTransparencyMode["SurfaceOnly"] = 0] = "SurfaceOnly";
+    /** The final transparency is computed from the product of the surface and gradient alpha channels.
+     * (Alpha is the inverse of transparency, where `alpha = (255 - transparency) / 255`).
+     * If the gradient color is opaque, this produces the same result as [[SurfaceOnly]].
+     */
+    ThematicGradientTransparencyMode[ThematicGradientTransparencyMode["MultiplySurfaceAndGradient"] = 1] = "MultiplySurfaceAndGradient";
+})(ThematicGradientTransparencyMode || (ThematicGradientTransparencyMode = {}));
 /** A color scheme used to generate the colors of a thematic gradient within an applied range.
  * @see [[ThematicGradientSettings.colorScheme]]
  * @see [[ThematicDisplay.range]]
@@ -55,24 +74,32 @@ class ThematicGradientSettings {
     static get margin() { return .001; } // A fixed portion of the gradient for out of range values.
     static get contentRange() { return 1.0 - 2.0 * ThematicGradientSettings.margin; }
     static get contentMax() { return 1.0 - ThematicGradientSettings.margin; }
+    /** @alpha */
+    get textureTransparency() {
+        let transp = TextureTransparency.Opaque;
+        if (ThematicGradientColorScheme.Custom === this.colorScheme) {
+            let haveOpaque = false;
+            let haveTransparent = false;
+            for (const key of this.customKeys) {
+                const isOpaque = key.color.isOpaque;
+                haveOpaque = haveOpaque || isOpaque;
+                haveTransparent = haveTransparent || !isOpaque;
+            }
+            if (haveTransparent)
+                transp = haveOpaque ? TextureTransparency.Mixed : TextureTransparency.Translucent;
+        }
+        if (transp !== TextureTransparency.Mixed)
+            if (this.marginColor.isOpaque !== (transp === TextureTransparency.Opaque))
+                transp = TextureTransparency.Mixed;
+        return transp;
+    }
     equals(other) {
-        if (this.mode !== other.mode)
-            return false;
-        if (this.stepCount !== other.stepCount)
+        if (this.mode !== other.mode || this.stepCount !== other.stepCount || !this.marginColor.equals(other.marginColor)
+            || this.colorScheme !== other.colorScheme || this.customKeys.length !== other.customKeys.length
+            || this.colorMix !== other.colorMix || this.transparencyMode !== other.transparencyMode) {
             return false;
-        if (!this.marginColor.equals(other.marginColor))
-            return false;
-        if (this.colorScheme !== other.colorScheme)
-            return false;
-        if (this.customKeys.length !== other.customKeys.length)
-            return false;
-        if (this.colorMix !== other.colorMix)
-            return false;
-        for (let i = 0; i < this.customKeys.length; i++) {
-            if (!Gradient.keyColorEquals(this.customKeys[i], other.customKeys[i]))
-                return false;
         }
-        return true;
+        return this.customKeys.every((key, index) => Gradient.keyColorEquals(key, other.customKeys[index]));
     }
     /** Compares two sets of thematic gradient settings.
      * @param lhs First set of thematic gradient settings to compare
@@ -93,10 +120,11 @@ class ThematicGradientSettings {
             return diff;
         if ((diff = compareNumbers(lhs.customKeys.length, rhs.customKeys.length)) !== 0)
             return diff;
-        for (let i = 0; i < lhs.customKeys.length; i++) {
+        if ((diff = compareNumbers(lhs.transparencyMode, rhs.transparencyMode)) !== 0)
+            return diff;
+        for (let i = 0; i < lhs.customKeys.length; i++)
             if ((diff = compareNumbers(lhs.customKeys[i].color.tbgr, rhs.customKeys[i].color.tbgr)) !== 0)
                 return diff;
-        }
         return diff;
     }
     constructor(json) {
@@ -107,6 +135,7 @@ class ThematicGradientSettings {
             this.marginColor = ColorDef.fromJSON();
             this.colorScheme = ThematicGradientColorScheme.BlueRed;
             this.colorMix = 0.0;
+            this.transparencyMode = ThematicGradientTransparencyMode.SurfaceOnly;
         }
         else {
             this.mode = (json.mode !== undefined && json.mode !== null) ? json.mode : ThematicGradientMode.Smooth;
@@ -128,6 +157,7 @@ class ThematicGradientSettings {
                     this.customKeys.push(new Gradient.KeyColor({ value: keyValue[0], color: ColorDef.computeTbgrFromComponents(keyValue[1], keyValue[3], keyValue[2]) }));
             }
             this.colorMix = json.colorMix ?? 0.0;
+            this.transparencyMode = json.transparencyMode ?? ThematicGradientTransparencyMode.SurfaceOnly;
         }
     }
     static fromJSON(json) {
@@ -146,6 +176,8 @@ class ThematicGradientSettings {
             props.colorScheme = this.colorScheme;
         if (0 !== this.colorMix)
             props.colorMix = this.colorMix;
+        if (ThematicGradientTransparencyMode.SurfaceOnly !== this.transparencyMode)
+            props.transparencyMode = this.transparencyMode;
         if (this.customKeys.length > 0)
             props.customKeys = this.customKeys.map((key) => { return { value: key.value, color: key.color.toJSON() }; });
         return props;
@@ -164,6 +196,7 @@ class ThematicGradientSettings {
             colorScheme: undefined !== changedProps.colorScheme ? changedProps.colorScheme : this.colorScheme,
             customKeys: undefined !== changedProps.customKeys ? changedProps.customKeys : this.customKeys.map((key) => ({ value: key.value, color: key.color.tbgr })),
             colorMix: undefined !== changedProps.colorMix ? changedProps.colorMix : this.colorMix,
+            transparencyMode: changedProps.transparencyMode ?? this.transparencyMode,
         };
         return ThematicGradientSettings.fromJSON(props);
     }