@itwin/core-frontend 4.0.0-dev.73 → 4.0.0-dev.75

package/lib/cjs/DisplayStyleState.d.ts

@@ -9,8 +9,7 @@ import { ContextRealityModelState } from "./ContextRealityModelState";
 import { ElementState } from "./EntityState";
 import { IModelConnection } from "./IModelConnection";
 import { PlanarClipMaskState } from "./PlanarClipMaskState";
-import { MapCartoRectangle, TileTreeReference } from "./tile/internal";
-import { ScreenViewport } from "./Viewport";
+import { MapLayerIndex, TileTreeReference } from "./tile/internal";
 /** @internal */
 export declare class TerrainDisplayOverrides {
     wantSkirts?: boolean;
@@ -75,10 +74,6 @@ export declare abstract class DisplayStyleState extends ElementState implements
      */
     get backgroundMapBase(): BaseLayerSettings;
     set backgroundMapBase(base: BaseLayerSettings);
-    /** @internal */
-    get backgroundMapLayers(): MapLayerSettings[];
-    /** @internal */
-    get overlayMapLayers(): MapLayerSettings[];
     /** The settings controlling how a background map is displayed within a view.
      * @see [[ViewFlags.backgroundMap]] for toggling display of the map on or off.
      */
@@ -150,40 +145,38 @@ export declare abstract class DisplayStyleState extends ElementState implements
      * The options [[OsmBuildingDisplayOptions]] control the display and appearance overrides.
      */
     setOSMBuildingDisplay(options: OsmBuildingDisplayOptions): boolean;
-    /**
-     * Return if a context reality model is attached.
+    /** Return if a context reality model is attached.
      * @see [[ContextRealityModelProps]].
-     * */
+     */
     hasAttachedRealityModel(name: string, url: string): boolean;
     /** @internal */
     getMapLayers(isOverlay: boolean): MapLayerSettings[];
-    /**
-     * Attach a map layer to display style.
+    /** Attach a map layer to display style.
      * @param Settings representing the map layer.
-     * @param isOverlay true if layer is overlay, otherwise layer is background. Defaults to false.
-     * @param index where the layer should be inserted. Defaults to -1, appended to end.
+     * @param mapLayerIndex the [[MapLayerIndex]] where the map layer should be attached.
      * @public
-     *
      */
     attachMapLayer(options: {
         settings: MapLayerSettings;
-        isOverlay?: boolean;
-        insertIndex?: number;
+        mapLayerIndex: MapLayerIndex;
     }): void;
-    /** @internal */
+    /**
+     * @param mapLayerIndex the [[MapLayerIndex]] where the map layer should be attached.
+     * @internal
+     */
     attachMapLayerProps(options: {
         props: MapLayerProps;
-        isOverlay?: boolean;
-        insertIndex?: number;
+        mapLayerIndex: MapLayerIndex;
     }): void;
     /** @internal */
     hasAttachedMapLayer(name: string, source: string, isOverlay: boolean): boolean;
     /** @internal */
     detachMapLayerByNameAndSource(name: string, source: string, isOverlay: boolean): void;
     /** Detach map layer at index (-1 to remove all layers)
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to detach.
      * @public
      */
-    detachMapLayerByIndex(index: number, isOverlay: boolean): void;
+    detachMapLayerByIndex(mapLayerIndex: MapLayerIndex): void;
     /**
      * Lookup a maplayer index by name and source.
      * @param name Name of of the layer.
@@ -193,8 +186,11 @@ export declare abstract class DisplayStyleState extends ElementState implements
      *
      */
     findMapLayerIndexByNameAndSource(name: string, source: string, isOverlay: boolean): number;
-    /** @public */
-    mapLayerAtIndex(index: number, isOverlay: boolean): MapLayerSettings | undefined;
+    /** Return the map layer settings for a map layer at the provided index.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer.
+     * @public
+     */
+    mapLayerAtIndex(mapLayerIndex: MapLayerIndex): MapLayerSettings | undefined;
     /** Return map base transparency as a number between 0 and 1.
      * @public
      */
@@ -205,8 +201,7 @@ export declare abstract class DisplayStyleState extends ElementState implements
     changeBaseMapTransparency(transparency: number): void;
     /** Modify a subset of a map layer settings.
      * @param props props JSON representation of the properties to change. Any properties not present will retain their current values.
-     * @param index where the layer should be inserted.
-     * @param isOverlay true if layer is overlay, otherwise layer is background.
+     * @param mapLayerIndex the [[MapLayerIndex]] where the map layer should be inserted.
      *
      * Example that changes only the visibility of the first overlay map layer.
      * ``` ts
@@ -214,49 +209,36 @@ export declare abstract class DisplayStyleState extends ElementState implements
      * ```
      * @public
      */
-    changeMapLayerProps(props: Partial<MapLayerProps>, index: number, isOverlay: boolean): void;
-    /** @public */
-    changeMapLayerCredentials(index: number, isOverlay: boolean, userName?: string, password?: string): void;
+    changeMapLayerProps(props: Partial<MapLayerProps>, mapLayerIndex: MapLayerIndex): void;
+    /** Change the credentials for a map layer.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to change the credentials of.
+     * @public
+     */
+    changeMapLayerCredentials(mapLayerIndex: MapLayerIndex, userName?: string, password?: string): void;
     /** Modify a subset of a sub-layer settings.
      * @param props props JSON representation of the properties to change. Any properties not present will retain their current values.
      * @param subLayerId Id of the sub-layer that should be modified.
-     * @param layerIndex of the owning map layer.
-     * @param isOverlay true if the map layer is overlay, otherwise layer is background
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer that contains the sub-layer to be modified.
      *
      * @public
      */
-    changeMapSubLayerProps(props: Partial<MapSubLayerProps>, subLayerId: SubLayerId, layerIndex: number, isOverlay: boolean): void;
-    /** Returns the cartographic range of map layer.
-     * @param layerIndex of the map layer.
-     * @param isOverlay true if the map layer is overlay, otherwise layer is background
-     *
-     * @internal
-     */
-    getMapLayerRange(layerIndex: number, isOverlay: boolean): Promise<MapCartoRectangle | undefined>;
-    /** change viewport to include range of map layer.
-     * @internal
-     */
-    viewMapLayerRange(layerIndex: number, isOverlay: boolean, vp: ScreenViewport): Promise<boolean>;
+    changeMapSubLayerProps(props: Partial<MapSubLayerProps>, subLayerId: SubLayerId, mapLayerIndex: MapLayerIndex): void;
     private _synchBackgroundMapImagery;
-    /**
-     * Move map layer to top.
-     * @param index index of layer to move.
-     * @param isOverlay true if layer is overlay.
+    /** Move map layer to top.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to move.
      * @public
      *
      */
-    moveMapLayerToTop(index: number, isOverlay: boolean): void;
-    /**
-     * Move map layer to bottom.
-     * @param index index of layer to move.
-     * @param isOverlay true if layer is overlay.
+    moveMapLayerToTop(mapLayerIndex: MapLayerIndex): void;
+    /** Move map layer to bottom.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to move.
      * @public
      */
-    moveMapLayerToBottom(index: number, isOverlay: boolean): void;
-    /**
-     * Reorder map layers
+    moveMapLayerToBottom(mapLayerIndex: MapLayerIndex): void;
+    /** Reorder map layers
      * @param fromIndex index of map layer to move
      * @param toIndex insert index. If equal to length of map array the map layer is moved to end of array.
+     * @param isOverlay true if map-layer is part of the overlay map, otherwise it is part of the background map.
      * @public
      */
     moveMapLayerToIndex(fromIndex: number, toIndex: number, isOverlay: boolean): void;

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

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyleState.d.ts","sourceRoot":"","sources":["../../src/DisplayStyleState.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAU,OAAO,EAAQ,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAS,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,EACL,kBAAkB,EAAyB,0BAA0B,EAAE,qBAAqB,EAC5F,iBAAiB,EAA2C,QAAQ,EAAE,wBAAwB,EAAE,sBAAsB,EACtH,iBAAiB,EAAE,oBAAoB,EAAE,WAAW,EAAE,iBAAiB,EAAE,SAAS,EAAyB,aAAa,EAAE,aAAa,EACvI,gBAAgB,EAAE,gBAAgB,EAAyB,cAAc,EAAE,mBAAmB,EAC9F,mBAAmB,EAAE,mBAAmB,EAAE,UAAU,EAAuF,SAAS,EACrJ,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAA4B,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEjG,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAG5C,gBAAgB;AAChB,qBAAa,uBAAuB;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,oIAAoI;IACpI,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,4FAA4F;IAC5F,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;CACzC;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,YAAa,YAAW,iBAAiB;IACvF,WAA2B,SAAS,WAA6B;IACjE,OAAO,CAAC,gBAAgB,CAAC,CAAiC;IAC1D,OAAO,CAAC,qBAAqB,CAAoC;IACjE,OAAO,CAAC,oCAAoC,CAA8C;IAC1F,gBAAgB;IAChB,SAAS,CAAC,gCAAgC,CAAC,EAAE,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC;IACtF,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;OAEG;IACH,SAAgB,gCAAgC,+BAAoC,eAAe,eAAe,GAAG,SAAS,KAAK,IAAI,EAAI;IAC3I,2EAA2E;IAC3E,SAAgB,uBAAuB,sBAA2B,eAAe,MAAM,GAAG,SAAS,KAAK,IAAI,EAAI;IAChH,wGAAwG;IACxG,SAAgB,2BAA2B,sCAA2C,OAAO,KAAK,IAAI,EAAI;IAE1G,uDAAuD;IACvD,aAAoB,QAAQ,IAAI,oBAAoB,CAAC;IAErD,gBAAgB;aACA,sBAAsB,IAAI,uBAAuB,GAAG,SAAS;IAE7E;;;;OAIG;gBACS,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,iBAAiB;IAgB1F;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBlC,OAAO,CAAC,6BAA6B;YAiBvB,+BAA+B;IA6B7C,gBAAgB;cACA,wBAAwB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAQ1G,gBAAgB;IAChB,IAAW,cAAc,YAExB;IAED,gBAAgB;IAChB,IAAW,SAAS,IAAI,SAAS,CAAkD;IAEnF;;OAEG;IACH,IAAW,iBAAiB,IAAI,iBAAiB,CAEhD;IACD,IAAW,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,EAGnD;IAED,gBAAgB;IAChB,IAAW,mBAAmB,IAAI,gBAAgB,EAAE,CAAsD;IAE1G,gBAAgB;IAChB,IAAW,gBAAgB,IAAI,gBAAgB,EAAE,CAAmD;IAEpG;;OAEG;IACH,IAAW,qBAAqB,IAAI,qBAAqB,CAAwC;IACjG,IAAW,qBAAqB,CAAC,QAAQ,EAAE,qBAAqB,EAE/D;IAED;;;;;;;;;;OAUG;IACI,wBAAwB,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI;IAKhE;;;OAGG;IACI,2BAA2B,CAAC,KAAK,EAAE,0BAA0B,GAAG,IAAI;IAY3E;;OAEG;IACI,mBAAmB,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,GAAG,IAAI;IAOjF,gBAAgB;IACT,yBAAyB,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,IAAI,GAAG,IAAI;IAI9E,gBAAgB;IACT,kBAAkB,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,IAAI,GAAG,IAAI;IAIvE;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAOpD,oCAAoC;IACpC,IAAW,IAAI,IAAI,MAAM,CAA4B;IAErD;;;OAGG;IACU,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAUpF;;OAEG;IACH,IAAW,cAAc,IAAI,cAAc,CAAC,MAAM,GAAG,SAAS,CAE7D;IAED,IAAW,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,SAAS,EAkBlE;IAED;;;OAGG;IACH,IAAW,uBAAuB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS,CAE/E;IAED;;;OAGG;IACI,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,GAAG,wBAAwB;IAMpF;;;OAGG;IACI,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAKzE;;OAEG;IACI,0BAA0B,IAAI,wBAAwB,GAAG,SAAS;IAWzE;;;OAGG;IACI,qBAAqB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO;IA6BzE;;;SAGK;IACE,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAIlE,gBAAgB;IACT,YAAY,CAAC,SAAS,EAAE,OAAO;IAEtC;;;;;;;OAOG;IACI,cAAc,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,gBAAgB,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI;IAkB9G,gBAAgB;IACT,mBAAmB,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI;IAQ7G,gBAAgB;IACT,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO;IAIrF,gBAAgB;IACT,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;IAM5F;;OAEG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;IAUrE;;;;;;;OAOG;IACI,gCAAgC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAIxF,cAAc;IACP,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,gBAAgB,GAAG,SAAS;IAKvF;;OAEG;IACH,IAAW,mBAAmB,IAAI,MAAM,CAEvC;IAED;;OAEG;IACI,yBAAyB,CAAC,YAAY,EAAE,MAAM;IASrD;;;;;;;;;;OAUG;IACI,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAQ3F,cAAc;IACP,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAWxG;;;;;;;OAOG;IACI,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAkB9H;;;;;OAKG;IACU,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAqC7G;;OAEG;IACU,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAc5G,OAAO,CAAC,0BAA0B;IAIlC;;;;;;OAMG;IACI,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAS1D;;;;;OAKG;IACI,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAS7D;;;;;OAKG;IACI,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAajF;;OAEG;IACH,IAAW,SAAS,IAAI,SAAS,CAAoC;IACrE,IAAW,SAAS,CAAC,KAAK,EAAE,SAAS,EAAsC;IAE3E,iDAAiD;IACjD,IAAW,eAAe,IAAI,QAAQ,CAA0C;IAChF,IAAW,eAAe,CAAC,GAAG,EAAE,QAAQ,EAA0C;IAElF;;OAEG;IACH,IAAW,eAAe,IAAI,QAAQ,CAA0C;IAChF,IAAW,eAAe,CAAC,GAAG,EAAE,QAAQ,EAA0C;IAElF,OAAO,CAAC,sBAAsB,CAAC,CAI7B;IAEF,gBAAgB;IACT,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAUrD,gBAAgB;IACT,yBAAyB,IAAI,OAAO;IAG3C,gBAAgB;IAChB,IAAW,0BAA0B,IAAI,MAAM,GAAG,SAAS,CAiB1D;IAED,gBAAgB;IACT,wBAAwB,IAAI,qBAAqB,GAAG,SAAS;IAiBpE;;OAEG;IACH,IAAW,yBAAyB,IAAI,aAAa,CAAC,wBAAwB,CAAC,CAE9E;IAED,gBAAgB;IACT,+BAA+B,IAAI;QAAE,QAAQ,EAAE,qBAAqB,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS;IAkB/G,kDAAkD;IAC3C,IAAI,IAAI,IAAI,IAAI,mBAAmB;IAE1C;;;;OAIG;IACI,mBAAmB,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,mBAAmB;IAEnE;;;OAGG;IACI,uBAAuB,CAAC,EAAE,EAAE,UAAU;IAE7C,6EAA6E;IAC7E,IAAW,sBAAsB,YAAmD;IAEpF;;;;OAIG;IACI,sBAAsB,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;IAE9E;;;;;;OAMG;IACI,4BAA4B,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAalE;;;;;OAKG;IACI,qBAAqB,CAAC,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAiBlF,6EAA6E;IAC7E,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED,gBAAgB;IAChB,SAAS,CAAC,8BAA8B,IAAI,IAAI;IAgChD,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,GAAG,wBAAwB;IAIvF,gBAAgB;IACT,sBAAsB,CAAC,OAAO,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;CAIpF;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,WAA2B,SAAS,WAA+B;IACnE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IAEjD,IAAW,QAAQ,IAAI,oBAAoB,CAA2B;IAEtE,gBAAgB;IACT,sBAAsB,IAAI,uBAAuB,GAAG,SAAS;gBAExD,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB;CAU/D;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,WAA2B,SAAS,WAA+B;IACnE,OAAO,CAAC,SAAS,CAAyB;IAE1C,IAAW,QAAQ,IAAI,sBAAsB,CAA2B;gBAErD,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,mBAAmB;IAWnG,IAAW,WAAW,IAAI,WAAW,CAEpC;IACD,IAAW,WAAW,CAAC,GAAG,EAAE,WAAW,EAEtC;IAED,IAAW,MAAM,IAAI,aAAa,CAAiC;IACnE,IAAW,MAAM,CAAC,MAAM,EAAE,aAAa,EAAoC;IAE3E,wCAAwC;IACxC,IAAW,YAAY,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAE5C;IAED;;;;OAIG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAI9B,2CAA2C;IAC3C,IAAW,YAAY,IAAI,mBAAmB,CAE7C;IACD,IAAW,YAAY,CAAC,QAAQ,EAAE,mBAAmB,EAEpD;IAED,gBAAgB;cACG,8BAA8B,IAAI,IAAI;IAezD,gBAAgB;IACT,sBAAsB,IAAI,uBAAuB,GAAG,SAAS;CAWrE"}
+{"version":3,"file":"DisplayStyleState.d.ts","sourceRoot":"","sources":["../../src/DisplayStyleState.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAU,OAAO,EAAQ,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EACL,kBAAkB,EAAyB,0BAA0B,EAAE,qBAAqB,EAC5F,iBAAiB,EAAwB,QAAQ,EAAE,wBAAwB,EAAE,sBAAsB,EACnG,iBAAiB,EAAE,oBAAoB,EAAE,WAAW,EAAE,iBAAiB,EAAE,SAAS,EAAyB,aAAa,EAAE,aAAa,EACvI,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,mBAAmB,EACvE,mBAAmB,EAAE,mBAAmB,EAAE,UAAU,EAAuF,SAAS,EACrJ,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAA4B,aAAa,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAE7F,gBAAgB;AAChB,qBAAa,uBAAuB;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,oIAAoI;IACpI,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,4FAA4F;IAC5F,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;CACzC;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,YAAa,YAAW,iBAAiB;IACvF,WAA2B,SAAS,WAA6B;IACjE,OAAO,CAAC,gBAAgB,CAAC,CAAiC;IAC1D,OAAO,CAAC,qBAAqB,CAAoC;IACjE,OAAO,CAAC,oCAAoC,CAA8C;IAC1F,gBAAgB;IAChB,SAAS,CAAC,gCAAgC,CAAC,EAAE,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC;IACtF,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;OAEG;IACH,SAAgB,gCAAgC,+BAAoC,eAAe,eAAe,GAAG,SAAS,KAAK,IAAI,EAAI;IAC3I,2EAA2E;IAC3E,SAAgB,uBAAuB,sBAA2B,eAAe,MAAM,GAAG,SAAS,KAAK,IAAI,EAAI;IAChH,wGAAwG;IACxG,SAAgB,2BAA2B,sCAA2C,OAAO,KAAK,IAAI,EAAI;IAE1G,uDAAuD;IACvD,aAAoB,QAAQ,IAAI,oBAAoB,CAAC;IAErD,gBAAgB;aACA,sBAAsB,IAAI,uBAAuB,GAAG,SAAS;IAE7E;;;;OAIG;gBACS,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,iBAAiB;IAgB1F;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBlC,OAAO,CAAC,6BAA6B;YAiBvB,+BAA+B;IA6B7C,gBAAgB;cACA,wBAAwB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAQ1G,gBAAgB;IAChB,IAAW,cAAc,YAExB;IAED,gBAAgB;IAChB,IAAW,SAAS,IAAI,SAAS,CAAkD;IAEnF;;OAEG;IACH,IAAW,iBAAiB,IAAI,iBAAiB,CAEhD;IACD,IAAW,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,EAGnD;IAED;;OAEG;IACH,IAAW,qBAAqB,IAAI,qBAAqB,CAAwC;IACjG,IAAW,qBAAqB,CAAC,QAAQ,EAAE,qBAAqB,EAE/D;IAED;;;;;;;;;;OAUG;IACI,wBAAwB,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI;IAKhE;;;OAGG;IACI,2BAA2B,CAAC,KAAK,EAAE,0BAA0B,GAAG,IAAI;IAY3E;;OAEG;IACI,mBAAmB,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,GAAG,IAAI;IAOjF,gBAAgB;IACT,yBAAyB,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,IAAI,GAAG,IAAI;IAI9E,gBAAgB;IACT,kBAAkB,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,IAAI,GAAG,IAAI;IAIvE;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAOpD,oCAAoC;IACpC,IAAW,IAAI,IAAI,MAAM,CAA4B;IAErD;;;OAGG;IACU,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAUpF;;OAEG;IACH,IAAW,cAAc,IAAI,cAAc,CAAC,MAAM,GAAG,SAAS,CAE7D;IAED,IAAW,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,SAAS,EAkBlE;IAED;;;OAGG;IACH,IAAW,uBAAuB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS,CAE/E;IAED;;;OAGG;IACI,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,GAAG,wBAAwB;IAMpF;;;OAGG;IACI,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAKzE;;OAEG;IACI,0BAA0B,IAAI,wBAAwB,GAAG,SAAS;IAWzE;;;OAGG;IACI,qBAAqB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO;IA6BzE;;OAEG;IACI,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAIlE,gBAAgB;IACT,YAAY,CAAC,SAAS,EAAE,OAAO;IAEtC;;;;OAIG;IACI,cAAc,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,gBAAgB,CAAC;QAAC,aAAa,EAAE,aAAa,CAAA;KAAE,GAAG,IAAI;IAkBlG;;;OAGG;IACI,mBAAmB,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,aAAa,EAAE,aAAa,CAAA;KAAE,GAAG,IAAI;IAQjG,gBAAgB;IACT,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO;IAIrF,gBAAgB;IACT,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;IAM5F;;;OAGG;IACI,qBAAqB,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAWhE;;;;;;;OAOG;IACI,gCAAgC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAIxF;;;OAGG;IACI,eAAe,CAAC,aAAa,EAAE,aAAa,GAAG,gBAAgB,GAAG,SAAS;IAMlF;;OAEG;IACH,IAAW,mBAAmB,IAAI,MAAM,CAEvC;IAED;;OAEG;IACI,yBAAyB,CAAC,YAAY,EAAE,MAAM;IASrD;;;;;;;;;OASG;IACI,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,aAAa,EAAE,aAAa;IAStF;;;OAGG;IACI,yBAAyB,CAAC,aAAa,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAYnG;;;;;;OAMG;IACI,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa;IAmBpH,OAAO,CAAC,0BAA0B;IAIlC;;;;OAIG;IACI,iBAAiB,CAAC,aAAa,EAAE,aAAa;IAUrD;;;OAGG;IACI,oBAAoB,CAAC,aAAa,EAAE,aAAa;IAUxD;;;;;OAKG;IACI,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAajF;;OAEG;IACH,IAAW,SAAS,IAAI,SAAS,CAAoC;IACrE,IAAW,SAAS,CAAC,KAAK,EAAE,SAAS,EAAsC;IAE3E,iDAAiD;IACjD,IAAW,eAAe,IAAI,QAAQ,CAA0C;IAChF,IAAW,eAAe,CAAC,GAAG,EAAE,QAAQ,EAA0C;IAElF;;OAEG;IACH,IAAW,eAAe,IAAI,QAAQ,CAA0C;IAChF,IAAW,eAAe,CAAC,GAAG,EAAE,QAAQ,EAA0C;IAElF,OAAO,CAAC,sBAAsB,CAAC,CAI7B;IAEF,gBAAgB;IACT,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAUrD,gBAAgB;IACT,yBAAyB,IAAI,OAAO;IAG3C,gBAAgB;IAChB,IAAW,0BAA0B,IAAI,MAAM,GAAG,SAAS,CAiB1D;IAED,gBAAgB;IACT,wBAAwB,IAAI,qBAAqB,GAAG,SAAS;IAiBpE;;OAEG;IACH,IAAW,yBAAyB,IAAI,aAAa,CAAC,wBAAwB,CAAC,CAE9E;IAED,gBAAgB;IACT,+BAA+B,IAAI;QAAE,QAAQ,EAAE,qBAAqB,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS;IAkB/G,kDAAkD;IAC3C,IAAI,IAAI,IAAI,IAAI,mBAAmB;IAE1C;;;;OAIG;IACI,mBAAmB,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,mBAAmB;IAEnE;;;OAGG;IACI,uBAAuB,CAAC,EAAE,EAAE,UAAU;IAE7C,6EAA6E;IAC7E,IAAW,sBAAsB,YAAmD;IAEpF;;;;OAIG;IACI,sBAAsB,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;IAE9E;;;;;;OAMG;IACI,4BAA4B,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAalE;;;;;OAKG;IACI,qBAAqB,CAAC,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAiBlF,6EAA6E;IAC7E,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED,gBAAgB;IAChB,SAAS,CAAC,8BAA8B,IAAI,IAAI;IAgChD,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,GAAG,wBAAwB;IAIvF,gBAAgB;IACT,sBAAsB,CAAC,OAAO,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;CAIpF;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,WAA2B,SAAS,WAA+B;IACnE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IAEjD,IAAW,QAAQ,IAAI,oBAAoB,CAA2B;IAEtE,gBAAgB;IACT,sBAAsB,IAAI,uBAAuB,GAAG,SAAS;gBAExD,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB;CAU/D;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,WAA2B,SAAS,WAA+B;IACnE,OAAO,CAAC,SAAS,CAAyB;IAE1C,IAAW,QAAQ,IAAI,sBAAsB,CAA2B;gBAErD,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,mBAAmB;IAWnG,IAAW,WAAW,IAAI,WAAW,CAEpC;IACD,IAAW,WAAW,CAAC,GAAG,EAAE,WAAW,EAEtC;IAED,IAAW,MAAM,IAAI,aAAa,CAAiC;IACnE,IAAW,MAAM,CAAC,MAAM,EAAE,aAAa,EAAoC;IAE3E,wCAAwC;IACxC,IAAW,YAAY,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAE5C;IAED;;;;OAIG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAI9B,2CAA2C;IAC3C,IAAW,YAAY,IAAI,mBAAmB,CAE7C;IACD,IAAW,YAAY,CAAC,QAAQ,EAAE,mBAAmB,EAEpD;IAED,gBAAgB;cACG,8BAA8B,IAAI,IAAI;IAezD,gBAAgB;IACT,sBAAsB,IAAI,uBAAuB,GAAG,SAAS;CAWrE"}

package/lib/cjs/DisplayStyleState.js

@@ -18,8 +18,6 @@ const EntityState_1 = require("./EntityState");
 const IModelApp_1 = require("./IModelApp");
 const PlanarClipMaskState_1 = require("./PlanarClipMaskState");
 const internal_1 = require("./tile/internal");
-const ViewGlobalLocation_1 = require("./ViewGlobalLocation");
-const ModelState_1 = require("./ModelState");
 /** @internal */
 class TerrainDisplayOverrides {
 }
@@ -149,10 +147,6 @@ class DisplayStyleState extends EntityState_1.ElementState {
         this.settings.mapImagery.backgroundBase = base;
         this._synchBackgroundMapImagery();
     }
-    /** @internal */
-    get backgroundMapLayers() { return this.settings.mapImagery.backgroundLayers; }
-    /** @internal */
-    get overlayMapLayers() { return this.settings.mapImagery.overlayLayers; }
     /** The settings controlling how a background map is displayed within a view.
      * @see [[ViewFlags.backgroundMap]] for toggling display of the map on or off.
      */
@@ -315,29 +309,25 @@ class DisplayStyleState extends EntityState_1.ElementState {
             model.appearanceOverrides = options.appearanceOverrides;
         return true;
     }
-    /**
-     * Return if a context reality model is attached.
+    /** Return if a context reality model is attached.
      * @see [[ContextRealityModelProps]].
-     * */
+     */
     hasAttachedRealityModel(name, url) {
         return undefined !== this.settings.contextRealityModels.models.find((x) => x.matchesNameAndUrl(name, url));
     }
     /** @internal */
-    getMapLayers(isOverlay) { return isOverlay ? this.overlayMapLayers : this.backgroundMapLayers; }
-    /**
-     * Attach a map layer to display style.
+    getMapLayers(isOverlay) { return isOverlay ? this.settings.mapImagery.overlayLayers : this.settings.mapImagery.backgroundLayers; }
+    /** Attach a map layer to display style.
      * @param Settings representing the map layer.
-     * @param isOverlay true if layer is overlay, otherwise layer is background. Defaults to false.
-     * @param index where the layer should be inserted. Defaults to -1, appended to end.
+     * @param mapLayerIndex the [[MapLayerIndex]] where the map layer should be attached.
      * @public
-     *
      */
     attachMapLayer(options) {
         const layerSettings = options.settings.clone({});
         if (undefined === layerSettings)
             return;
-        const isOverlay = options.isOverlay ?? false;
-        const insertIndex = options.insertIndex ?? -1;
+        const isOverlay = options.mapLayerIndex.isOverlay;
+        const insertIndex = options.mapLayerIndex.index;
         const layers = this.getMapLayers(isOverlay);
         if (insertIndex < 0 || insertIndex > (layers.length - 1)) {
             this.getMapLayers(isOverlay).push(layerSettings);
@@ -347,12 +337,15 @@ class DisplayStyleState extends EntityState_1.ElementState {
         }
         this._synchBackgroundMapImagery();
     }
-    /** @internal */
+    /**
+     * @param mapLayerIndex the [[MapLayerIndex]] where the map layer should be attached.
+     * @internal
+     */
     attachMapLayerProps(options) {
         const settings = core_common_1.MapLayerSettings.fromJSON(options.props);
         if (undefined === settings)
             return;
-        this.attachMapLayer({ settings, isOverlay: options.isOverlay, insertIndex: options.insertIndex });
+        this.attachMapLayer({ settings, mapLayerIndex: options.mapLayerIndex });
     }
     /** @internal */
     hasAttachedMapLayer(name, source, isOverlay) {
@@ -362,13 +355,15 @@ class DisplayStyleState extends EntityState_1.ElementState {
     detachMapLayerByNameAndSource(name, source, isOverlay) {
         const index = this.findMapLayerIndexByNameAndSource(name, source, isOverlay);
         if (-1 !== index)
-            this.detachMapLayerByIndex(index, isOverlay);
+            this.detachMapLayerByIndex({ index, isOverlay });
     }
     /** Detach map layer at index (-1 to remove all layers)
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to detach.
      * @public
      */
-    detachMapLayerByIndex(index, isOverlay) {
-        const layers = this.getMapLayers(isOverlay);
+    detachMapLayerByIndex(mapLayerIndex) {
+        const layers = this.getMapLayers(mapLayerIndex.isOverlay);
+        const index = mapLayerIndex.index;
         if (index < 0)
             layers.length = 0;
         else
@@ -386,9 +381,13 @@ class DisplayStyleState extends EntityState_1.ElementState {
     findMapLayerIndexByNameAndSource(name, source, isOverlay) {
         return this.getMapLayers(isOverlay).findIndex((layer) => layer.matchesNameAndSource(name, source));
     }
-    /** @public */
-    mapLayerAtIndex(index, isOverlay) {
-        const layers = this.getMapLayers(isOverlay);
+    /** Return the map layer settings for a map layer at the provided index.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer.
+     * @public
+     */
+    mapLayerAtIndex(mapLayerIndex) {
+        const layers = this.getMapLayers(mapLayerIndex.isOverlay);
+        const index = mapLayerIndex.index;
         return (index < 0 || index >= layers.length) ? undefined : layers[index];
     }
     /** Return map base transparency as a number between 0 and 1.
@@ -411,8 +410,7 @@ class DisplayStyleState extends EntityState_1.ElementState {
     }
     /** Modify a subset of a map layer settings.
      * @param props props JSON representation of the properties to change. Any properties not present will retain their current values.
-     * @param index where the layer should be inserted.
-     * @param isOverlay true if layer is overlay, otherwise layer is background.
+     * @param mapLayerIndex the [[MapLayerIndex]] where the map layer should be inserted.
      *
      * Example that changes only the visibility of the first overlay map layer.
      * ``` ts
@@ -420,16 +418,21 @@ class DisplayStyleState extends EntityState_1.ElementState {
      * ```
      * @public
      */
-    changeMapLayerProps(props, index, isOverlay) {
-        const layers = this.getMapLayers(isOverlay);
+    changeMapLayerProps(props, mapLayerIndex) {
+        const index = mapLayerIndex.index;
+        const layers = this.getMapLayers(mapLayerIndex.isOverlay);
         if (index < 0 || index >= layers.length)
             return;
         layers[index] = layers[index].clone(props);
         this._synchBackgroundMapImagery();
     }
-    /** @public */
-    changeMapLayerCredentials(index, isOverlay, userName, password) {
-        const layers = this.getMapLayers(isOverlay);
+    /** Change the credentials for a map layer.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to change the credentials of.
+     * @public
+     */
+    changeMapLayerCredentials(mapLayerIndex, userName, password) {
+        const layers = this.getMapLayers(mapLayerIndex.isOverlay);
+        const index = mapLayerIndex.index;
         if (index < 0 || index >= layers.length)
             return;
         const layer = layers[index];
@@ -441,13 +444,12 @@ class DisplayStyleState extends EntityState_1.ElementState {
     /** Modify a subset of a sub-layer settings.
      * @param props props JSON representation of the properties to change. Any properties not present will retain their current values.
      * @param subLayerId Id of the sub-layer that should be modified.
-     * @param layerIndex of the owning map layer.
-     * @param isOverlay true if the map layer is overlay, otherwise layer is background
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer that contains the sub-layer to be modified.
      *
      * @public
      */
-    changeMapSubLayerProps(props, subLayerId, layerIndex, isOverlay) {
-        const mapLayerSettings = this.mapLayerAtIndex(layerIndex, isOverlay);
+    changeMapSubLayerProps(props, subLayerId, mapLayerIndex) {
+        const mapLayerSettings = this.mapLayerAtIndex(mapLayerIndex);
         if (undefined === mapLayerSettings)
             return;
         if (!(mapLayerSettings instanceof core_common_1.ImageMapLayerSettings)) {
@@ -458,95 +460,43 @@ class DisplayStyleState extends EntityState_1.ElementState {
         for (const subLayer of mapLayerSettings.subLayers) {
             subLayers.push((subLayerId === -1 || subLayer.id === subLayerId) ? subLayer.clone(props).toJSON() : subLayer.toJSON());
         }
-        this.changeMapLayerProps({ subLayers }, layerIndex, isOverlay);
-    }
-    /** Returns the cartographic range of map layer.
-     * @param layerIndex of the map layer.
-     * @param isOverlay true if the map layer is overlay, otherwise layer is background
-     *
-     * @internal
-     */
-    async getMapLayerRange(layerIndex, isOverlay) {
-        const mapLayerSettings = this.mapLayerAtIndex(layerIndex, isOverlay);
-        if (undefined === mapLayerSettings)
-            return undefined;
-        if (mapLayerSettings instanceof core_common_1.ModelMapLayerSettings) {
-            const ecefTransform = this.iModel.ecefLocation?.getTransform();
-            if (!ecefTransform)
-                return undefined;
-            const model = this.iModel.models.getLoaded(mapLayerSettings.modelId);
-            if (!model || !(model instanceof ModelState_1.GeometricModelState))
-                return undefined;
-            const modelRange = await model.queryModelRange();
-            const cartoRange = new core_common_1.CartographicRange(modelRange, ecefTransform).getLongitudeLatitudeBoundingBox();
-            return internal_1.MapCartoRectangle.fromRadians(cartoRange.low.x, cartoRange.low.y, cartoRange.high.x, cartoRange.high.y);
-        }
-        if (!(mapLayerSettings instanceof core_common_1.ImageMapLayerSettings)) {
-            (0, core_bentley_1.assert)(false);
-            return undefined;
-        }
-        const imageryProvider = IModelApp_1.IModelApp.mapLayerFormatRegistry.createImageryProvider(mapLayerSettings);
-        if (undefined === imageryProvider)
-            return undefined;
-        try {
-            await imageryProvider.initialize();
-            return imageryProvider.cartoRange;
-        }
-        catch (_error) {
-            return undefined;
-        }
-        return undefined;
-    }
-    /** change viewport to include range of map layer.
-     * @internal
-     */
-    async viewMapLayerRange(layerIndex, isOverlay, vp) {
-        const range = await this.getMapLayerRange(layerIndex, isOverlay);
-        if (!range)
-            return false;
-        if (range.xLength() > 1.5 * core_geometry_1.Angle.piRadians)
-            (0, ViewGlobalLocation_1.viewGlobalLocation)(vp, true, ViewGlobalLocation_1.ViewGlobalLocationConstants.satelliteHeightAboveEarthInMeters, undefined, undefined);
-        else
-            (0, ViewGlobalLocation_1.viewGlobalLocation)(vp, true, undefined, undefined, range.globalLocation);
-        return true;
+        this.changeMapLayerProps({ subLayers }, mapLayerIndex);
     }
     /* @internal */
     _synchBackgroundMapImagery() {
         this.settings.synchMapImagery();
     }
-    /**
-     * Move map layer to top.
-     * @param index index of layer to move.
-     * @param isOverlay true if layer is overlay.
+    /** Move map layer to top.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to move.
      * @public
      *
      */
-    moveMapLayerToTop(index, isOverlay) {
-        const layers = this.getMapLayers(isOverlay);
+    moveMapLayerToTop(mapLayerIndex) {
+        const layers = this.getMapLayers(mapLayerIndex.isOverlay);
+        const index = mapLayerIndex.index;
         if (index >= 0 && index < layers.length - 1) {
             const layer = layers.splice(index, 1);
             layers.push(layer[0]);
             this._synchBackgroundMapImagery();
         }
     }
-    /**
-     * Move map layer to bottom.
-     * @param index index of layer to move.
-     * @param isOverlay true if layer is overlay.
+    /** Move map layer to bottom.
+     * @param mapLayerIndex the [[MapLayerIndex]] of the map layer to move.
      * @public
      */
-    moveMapLayerToBottom(index, isOverlay) {
-        const layers = this.getMapLayers(isOverlay);
+    moveMapLayerToBottom(mapLayerIndex) {
+        const layers = this.getMapLayers(mapLayerIndex.isOverlay);
+        const index = mapLayerIndex.index;
         if (index > 0 && index < layers.length) {
             const layer = layers.splice(index, 1);
             layers.unshift(layer[0]);
             this._synchBackgroundMapImagery();
         }
     }
-    /**
-     * Reorder map layers
+    /** Reorder map layers
      * @param fromIndex index of map layer to move
      * @param toIndex insert index. If equal to length of map array the map layer is moved to end of array.
+     * @param isOverlay true if map-layer is part of the overlay map, otherwise it is part of the background map.
      * @public
      */
     moveMapLayerToIndex(fromIndex, toIndex, isOverlay) {