@itwin/core-frontend 3.3.0-dev.4 → 3.3.0-dev.42

package/lib/esm/DisplayStyleState.d.ts

@@ -67,12 +67,14 @@ export declare abstract class DisplayStyleState extends ElementState implements
     get displayTerrain(): boolean;
     /** @internal */
     get globeMode(): GlobeMode;
-    /** @internal */
-    get backgroundMapLayers(): MapLayerSettings[];
-    /** @beta */
+    /** Settings controlling how the base map is displayed within a view.
+     *  The base map can be provided by any map imagery source or set to be a single color.
+     */
     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.
@@ -88,6 +90,7 @@ export declare abstract class DisplayStyleState extends ElementState implements
      * ``` ts
      *  style.changeBackgroundMapProps({ groundBias: 16.2 });
      * ```
+     * @public
      */
     changeBackgroundMapProps(props: BackgroundMapProps): void;
     /** Change aspects of the [BackgroundMapProvider]($common) from which background map imagery is obtained.
@@ -157,33 +160,81 @@ export declare abstract class DisplayStyleState extends ElementState implements
     hasAttachedRealityModel(name: string, url: string): boolean;
     /** @internal */
     getMapLayers(isOverlay: boolean): MapLayerSettings[];
-    /** @internal */
-    attachMapLayerSettings(settings: MapLayerSettings, isOverlay: boolean, insertIndex?: number): void;
-    /** @internal */
-    attachMapLayer(props: MapLayerProps, isOverlay: boolean, insertIndex?: number): void;
+    /**
+     * 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.
+     * @public
+     *
+     */
+    attachMapLayer(options: {
+        settings: MapLayerSettings;
+        isOverlay?: boolean;
+        insertIndex?: number;
+    }): void;
+    /** @internal */
+    attachMapLayerProps(options: {
+        props: MapLayerProps;
+        isOverlay?: boolean;
+        insertIndex?: number;
+    }): 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)
-     * @internal
+     * @public
      */
     detachMapLayerByIndex(index: number, isOverlay: boolean): void;
-    /** @internal */
+    /**
+     * Lookup a maplayer index by name and source.
+     * @param name Name of of the layer.
+     * @param source Unique string identifying the layer.
+     * @param isOverlay true if layer is overlay, otherwise layer is background. Defaults to false.
+     * @public
+     *
+     */
     findMapLayerIndexByNameAndSource(name: string, source: string, isOverlay: boolean): number;
-    /** @internal */
+    /** @public */
     mapLayerAtIndex(index: number, isOverlay: boolean): MapLayerSettings | undefined;
     /** Return map base transparency as a number between 0 and 1.
-     * @internal
+     * @public
      */
     get baseMapTransparency(): number;
-    /** @internal  */
+    /** Change the map base transparency as a number between 0 and 1.
+     * @public
+     */
     changeBaseMapTransparency(transparency: number): void;
-    /** @internal */
+    /** 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.
+     *
+     * Example that changes only the visibility of the first overlay map layer.
+     * ``` ts
+     *  style.changeMapLayerProps({ visible: false }, 0, false);
+     * ```
+     * @public
+     */
     changeMapLayerProps(props: Partial<MapLayerProps>, index: number, isOverlay: boolean): void;
+    /** @public */
     changeMapLayerCredentials(index: number, isOverlay: boolean, 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
+     *
+     * @public
+     */
     changeMapSubLayerProps(props: Partial<MapSubLayerProps>, subLayerId: SubLayerId, layerIndex: number, isOverlay: boolean): void;
-    /** @internal */
+    /** 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
@@ -194,7 +245,7 @@ export declare abstract class DisplayStyleState extends ElementState implements
      * Move map layer to top.
      * @param index index of layer to move.
      * @param isOverlay true if layer is overlay.
-     * @internal
+     * @public
      *
      */
     moveMapLayerToTop(index: number, isOverlay: boolean): void;
@@ -202,14 +253,14 @@ export declare abstract class DisplayStyleState extends ElementState implements
      * Move map layer to bottom.
      * @param index index of layer to move.
      * @param isOverlay true if layer is overlay.
-     * @internal
+     * @public
      */
     moveMapLayerToBottom(index: number, isOverlay: boolean): 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.
-     * @internal
+     * @public
      */
     moveMapLayerToIndex(fromIndex: number, toIndex: number, isOverlay: boolean): void;
     /** Flags controlling various aspects of the display style.

package/lib/esm/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,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACxE,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,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,gBAAgB;IAChB,WAA2B,SAAS,WAA6B;IACjE,OAAO,CAAC,cAAc,CAAC,CAAsB;IAC7C,OAAO,CAAC,qBAAqB,CAAoC;IACjE,OAAO,CAAC,oCAAoC,CAA8C;IAC1F,gBAAgB;IAChB,SAAS,CAAC,gCAAgC,CAAC,EAAE,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC;IAEtF,oFAAoF;IACpF,SAAgB,gCAAgC,+BAAoC,eAAe,eAAe,GAAG,SAAS,KAAK,IAAI,EAAI;IAC3I,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;IAsBlC,OAAO,CAAC,2BAA2B;YAkBrB,6BAA6B;IA0B3C,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,gBAAgB;IAChB,IAAW,mBAAmB,IAAI,gBAAgB,EAAE,CAAsD;IAE1G,YAAY;IACZ,IAAW,iBAAiB,IAAI,iBAAiB,CAEhD;IACD,IAAW,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,EAGnD;IAED,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;;;;;;;;;OASG;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;;;OAGG;IACH,IAAW,uBAAuB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS,CAE/E;IAED,gBAAgB;IAChB,IAAW,aAAa,IAAI,mBAAmB,GAAG,SAAS,CAE1D;IAED;;;OAGG;IACI,gBAAgB,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,IAAI;IAWrE;;;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,gBAAgB;IACT,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,SAAK,GAAG,IAAI;IAgBrG,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,SAAK,GAAG,IAAI;IAQvF,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,gBAAgB;IACT,gCAAgC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAIxF,gBAAgB;IACT,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,gBAAgB,GAAG,SAAS;IAKvF;;OAEG;IACH,IAAW,mBAAmB,IAAI,MAAM,CAEvC;IAED,iBAAiB;IACV,yBAAyB,CAAC,YAAY,EAAE,MAAM;IASrD,gBAAgB;IACT,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAQpF,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAWjG,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAkB9H,gBAAgB;IACH,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,gBAAgB;IAChB,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED,gBAAgB;IAChB,SAAS,CAAC,8BAA8B,IAAI,IAAI;IAyBhD,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,gBAAgB;IAChB,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;CAK/D;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,gBAAgB;IAChB,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;IAMnG,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,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACxE,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,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,gBAAgB;IAChB,WAA2B,SAAS,WAA6B;IACjE,OAAO,CAAC,cAAc,CAAC,CAAsB;IAC7C,OAAO,CAAC,qBAAqB,CAAoC;IACjE,OAAO,CAAC,oCAAoC,CAA8C;IAC1F,gBAAgB;IAChB,SAAS,CAAC,gCAAgC,CAAC,EAAE,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC;IAEtF,oFAAoF;IACpF,SAAgB,gCAAgC,+BAAoC,eAAe,eAAe,GAAG,SAAS,KAAK,IAAI,EAAI;IAC3I,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;IAsBlC,OAAO,CAAC,2BAA2B;YAkBrB,6BAA6B;IA0B3C,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;;;OAGG;IACH,IAAW,uBAAuB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS,CAE/E;IAED,gBAAgB;IAChB,IAAW,aAAa,IAAI,mBAAmB,GAAG,SAAS,CAE1D;IAED;;;OAGG;IACI,gBAAgB,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,IAAI;IAWrE;;;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,gBAAgB;IAChB,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED,gBAAgB;IAChB,SAAS,CAAC,8BAA8B,IAAI,IAAI;IAyBhD,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,gBAAgB;IAChB,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;CAK/D;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,gBAAgB;IAChB,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;IAMnG,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/esm/DisplayStyleState.js

@@ -129,9 +129,9 @@ export class DisplayStyleState extends ElementState {
     }
     /** @internal */
     get globeMode() { return this.settings.backgroundMap.globeMode; }
-    /** @internal */
-    get backgroundMapLayers() { return this.settings.mapImagery.backgroundLayers; }
-    /** @beta */
+    /** Settings controlling how the base map is displayed within a view.
+     *  The base map can be provided by any map imagery source or set to be a single color.
+     */
     get backgroundMapBase() {
         return this.settings.mapImagery.backgroundBase;
     }
@@ -140,6 +140,8 @@ export class DisplayStyleState extends ElementState {
         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.
@@ -157,6 +159,7 @@ export class DisplayStyleState extends ElementState {
      * ``` ts
      *  style.changeBackgroundMapProps({ groundBias: 16.2 });
      * ```
+     * @public
      */
     changeBackgroundMapProps(props) {
         const newSettings = this.backgroundMapSettings.clone(props);
@@ -311,11 +314,21 @@ export class DisplayStyleState extends ElementState {
     }
     /** @internal */
     getMapLayers(isOverlay) { return isOverlay ? this.overlayMapLayers : this.backgroundMapLayers; }
-    /** @internal */
-    attachMapLayerSettings(settings, isOverlay, insertIndex = -1) {
-        const layerSettings = settings.clone({});
+    /**
+     * 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.
+     * @public
+     *
+     */
+    attachMapLayer(options) {
+        var _a, _b;
+        const layerSettings = options.settings.clone({});
         if (undefined === layerSettings)
             return;
+        const isOverlay = (_a = options.isOverlay) !== null && _a !== void 0 ? _a : false;
+        const insertIndex = (_b = options.insertIndex) !== null && _b !== void 0 ? _b : -1;
         const layers = this.getMapLayers(isOverlay);
         if (insertIndex < 0 || insertIndex > (layers.length - 1)) {
             this.getMapLayers(isOverlay).push(layerSettings);
@@ -326,11 +339,11 @@ export class DisplayStyleState extends ElementState {
         this._synchBackgroundMapImagery();
     }
     /** @internal */
-    attachMapLayer(props, isOverlay, insertIndex = -1) {
-        const layerSettings = MapLayerSettings.fromJSON(props);
-        if (undefined === layerSettings)
+    attachMapLayerProps(options) {
+        const settings = MapLayerSettings.fromJSON(options.props);
+        if (undefined === settings)
             return;
-        this.attachMapLayerSettings(layerSettings, isOverlay, insertIndex);
+        this.attachMapLayer({ settings, isOverlay: options.isOverlay, insertIndex: options.insertIndex });
     }
     /** @internal */
     hasAttachedMapLayer(name, source, isOverlay) {
@@ -343,7 +356,7 @@ export class DisplayStyleState extends ElementState {
             this.detachMapLayerByIndex(index, isOverlay);
     }
     /** Detach map layer at index (-1 to remove all layers)
-     * @internal
+     * @public
      */
     detachMapLayerByIndex(index, isOverlay) {
         const layers = this.getMapLayers(isOverlay);
@@ -353,22 +366,31 @@ export class DisplayStyleState extends ElementState {
             layers.splice(index, 1);
         this._synchBackgroundMapImagery();
     }
-    /** @internal */
+    /**
+     * Lookup a maplayer index by name and source.
+     * @param name Name of of the layer.
+     * @param source Unique string identifying the layer.
+     * @param isOverlay true if layer is overlay, otherwise layer is background. Defaults to false.
+     * @public
+     *
+     */
     findMapLayerIndexByNameAndSource(name, source, isOverlay) {
         return this.getMapLayers(isOverlay).findIndex((layer) => layer.matchesNameAndSource(name, source));
     }
-    /** @internal */
+    /** @public */
     mapLayerAtIndex(index, isOverlay) {
         const layers = this.getMapLayers(isOverlay);
         return (index < 0 || index >= layers.length) ? undefined : layers[index];
     }
     /** Return map base transparency as a number between 0 and 1.
-     * @internal
+     * @public
      */
     get baseMapTransparency() {
         return this.settings.mapImagery.baseTransparency;
     }
-    /** @internal  */
+    /** Change the map base transparency as a number between 0 and 1.
+     * @public
+     */
     changeBaseMapTransparency(transparency) {
         if (this.settings.mapImagery.backgroundBase instanceof ColorDef) {
             this.settings.mapImagery.backgroundBase = this.settings.mapImagery.backgroundBase.withTransparency(transparency * 255);
@@ -378,7 +400,17 @@ export class DisplayStyleState extends ElementState {
         }
         this._synchBackgroundMapImagery();
     }
-    /** @internal */
+    /** 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.
+     *
+     * Example that changes only the visibility of the first overlay map layer.
+     * ``` ts
+     *  style.changeMapLayerProps({ visible: false }, 0, false);
+     * ```
+     * @public
+     */
     changeMapLayerProps(props, index, isOverlay) {
         const layers = this.getMapLayers(isOverlay);
         if (index < 0 || index >= layers.length)
@@ -386,6 +418,7 @@ export class DisplayStyleState extends ElementState {
         layers[index] = layers[index].clone(props);
         this._synchBackgroundMapImagery();
     }
+    /** @public */
     changeMapLayerCredentials(index, isOverlay, userName, password) {
         const layers = this.getMapLayers(isOverlay);
         if (index < 0 || index >= layers.length)
@@ -396,6 +429,14 @@ export class DisplayStyleState extends ElementState {
             this._synchBackgroundMapImagery();
         }
     }
+    /** 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
+     *
+     * @public
+     */
     changeMapSubLayerProps(props, subLayerId, layerIndex, isOverlay) {
         const mapLayerSettings = this.mapLayerAtIndex(layerIndex, isOverlay);
         if (undefined === mapLayerSettings)
@@ -410,7 +451,12 @@ export class DisplayStyleState extends ElementState {
         }
         this.changeMapLayerProps({ subLayers }, layerIndex, isOverlay);
     }
-    /** @internal */
+    /** 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) {
         var _a;
         const mapLayerSettings = this.mapLayerAtIndex(layerIndex, isOverlay);
@@ -464,7 +510,7 @@ export class DisplayStyleState extends ElementState {
      * Move map layer to top.
      * @param index index of layer to move.
      * @param isOverlay true if layer is overlay.
-     * @internal
+     * @public
      *
      */
     moveMapLayerToTop(index, isOverlay) {
@@ -479,7 +525,7 @@ export class DisplayStyleState extends ElementState {
      * Move map layer to bottom.
      * @param index index of layer to move.
      * @param isOverlay true if layer is overlay.
-     * @internal
+     * @public
      */
     moveMapLayerToBottom(index, isOverlay) {
         const layers = this.getMapLayers(isOverlay);
@@ -493,7 +539,7 @@ export class DisplayStyleState extends ElementState {
      * 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.
-     * @internal
+     * @public
      */
     moveMapLayerToIndex(fromIndex, toIndex, isOverlay) {
         const layers = this.getMapLayers(isOverlay);