@itwin/core-common 3.1.0-dev.6 → 3.2.0-dev.0

package/lib/esm/MapLayerSettings.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"MapLayerSettings.d.ts","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC/G,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE,YAAY;AACZ,oBAAY,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,mIAAmI;IACnI,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,aAAa;IACb,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAC/B,gIAAgI;IAChI,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,oFAAoF;IACpF,SAAgB,EAAE,EAAE,UAAU,CAAC;IAC/B,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxC,uBAAuB;IACvB,SAAgB,MAAM,CAAC,EAAE,UAAU,CAAC;gBAExB,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,UAAU,EAAE;IAQ1H,mGAAmG;WACrF,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,mBAAmB;IAG5D,MAAM,IAAI,gBAAgB;IAkBjC,uFAAuF;IAChF,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB;IAc1E,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAG1D,6CAA6C;IAC7C,IAAW,OAAO,IAAI,OAAO,CAAiC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,IAAI,OAAO,CAAsE;IAElG,uDAAuD;IACvD,IAAW,cAAc,IAAI,OAAO,CAA0C;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,IAAI,MAAM,CAA2E;CACzG;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,4DAA4D;IAC5D,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B;;oCAEgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,6CAA6C;IAC7C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,WAAW,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;IAC3B,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,GAAG,EAAE,MAAM,CAAC;IAC5B,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,SAAgB,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjD,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,SAAgB,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,WAAW,CAAC;IAExB,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAK1D,gBAAgB;IAChB,SAAS,aAAa,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,UAAO,EAC/E,aAAa,GAAE,gBAAgB,EAAE,GAAG,SAAqB,EAAE,YAAY,GAAE,MAAU,EACnF,qBAAqB,UAAO,EAAE,MAAM,UAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW;IA0B7G,mGAAmG;WACrF,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,gBAAgB;IAK7D,iEAAiE;IAC1D,MAAM,IAAI,aAAa;IAwB9B,gBAAgB;IAChB,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB;IAYpD;;;OAGG;IACI,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,gBAAgB;IAWpE,gBAAgB;IAChB,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,aAAa;IAazE,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAoBvD,gBAAgB;IACT,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAI5D,iEAAiE;IAC1D,YAAY,CAAC,EAAE,CAAC,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;IAIrE,OAAO,CAAC,qBAAqB;IAa7B,4FAA4F;IACrF,iBAAiB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO;IAOhE,gDAAgD;IAChD,IAAW,qBAAqB,IAAI,OAAO,CAK1C;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,mBAAmB,EAAE,GAAG,SAAS;CAa7F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,gBAAgB;IACxD,OAAO,CAAC,SAAS,CAAC,CAAwB;IAE1C,sEAAsE;IACtE,IAAW,QAAQ,IAAI,qBAAqB,GAAG,SAAS,CAA2B;IAEnF;;;;OAIG;WACoB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,oBAAoB;IAS/E,qDAAqD;IACrC,MAAM,IAAI,iBAAiB;IAQ3C,gBAAgB;IACA,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,iBAAiB;IAQnF,mCAAmC;IACnB,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,oBAAoB;IAUjF,wDAAwD;WAC1C,YAAY,CAAC,QAAQ,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,oBAAoB;IA0D3I,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,oBAAoB;IAI/F,aAAa;IACN,iBAAiB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,oBAAoB;CAGhF"}
+{"version":3,"file":"MapLayerSettings.d.ts","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC/G,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE,YAAY;AACZ,oBAAY,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,mIAAmI;IACnI,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,aAAa;IACb,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAC/B,gIAAgI;IAChI,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,oFAAoF;IACpF,SAAgB,EAAE,EAAE,UAAU,CAAC;IAC/B,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxC,uBAAuB;IACvB,SAAgB,MAAM,CAAC,EAAE,UAAU,CAAC;gBAExB,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,UAAU,EAAE;IAS1H,mGAAmG;WACrF,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,mBAAmB;IAI5D,MAAM,IAAI,gBAAgB;IAkBjC,uFAAuF;IAChF,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB;IAe1E,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAI1D,6CAA6C;IAC7C,IAAW,OAAO,IAAI,OAAO,CAAiC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,IAAI,OAAO,CAAsE;IAElG,uDAAuD;IACvD,IAAW,cAAc,IAAI,OAAO,CAA0C;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,IAAI,MAAM,CAA2E;CACzG;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,UAAU;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,WAAW,CAAC;IAExB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,iGAAiG;IACjG,OAAO,EAAE,UAAU,CAAC;IAEpB,gBAAgB;IAChB,GAAG,CAAC,EAAE,KAAK,CAAC;IACZ,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,gBAAgB;IAChB,SAAS,CAAC,EAAE,KAAK,CAAC;IAClB,gBAAgB;IAChB,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,aAAoB,qBAAqB,IAAI,OAAO,CAAC;aACrC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,gBAAgB;aAC7D,MAAM,IAAI,aAAa;IAEvC,gBAAgB;IAChB,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,OAAO,UAAO,EAAE,YAAY,GAAE,MAAU,EAAE,qBAAqB,UAAO;IAO1G,gEAAgE;WAClD,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB;IAI9D,gBAAgB;IAChB,SAAS,CAAC,OAAO,IAAI,mBAAmB;IAexC,gBAAgB;IAChB,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,mBAAmB;IAS/E,gBAAgB;IACT,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAIvD,kHAAkH;IAClH,aAAoB,MAAM,IAAI,MAAM,CAAC;IAErC,gBAAgB;IACT,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;CAGnE;AAED;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,WAAW,CAAC;IAC/B,SAAgB,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjD,IAAoB,MAAM,IAAI,MAAM,CAAqB;IAEzD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,kBAAkB;WAkBxB,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,qBAAqB;IAIjF,iEAAiE;IACjD,MAAM,IAAI,kBAAkB;IAW5C;;;OAGG;IACI,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,qBAAqB;IAW9E,gBAAgB;cACG,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB;IAW5F,gBAAgB;IACA,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAehE,iEAAiE;IAC1D,YAAY,CAAC,EAAE,CAAC,EAAE,UAAU,GAAG,mBAAmB,GAAG,SAAS;IAIrE,OAAO,CAAC,qBAAqB;IAa7B,4FAA4F;IACrF,iBAAiB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO;IAOhE,kDAAkD;IAClD,IAAW,qBAAqB,IAAI,OAAO,CAK1C;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,mBAAmB,EAAE,GAAG,SAAS;IAc5F,gBAAgB;IAChB,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB;IAY7C,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;CAI3D;AAED;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,IAAoB,MAAM,IAAI,MAAM,CAAyB;IAE7D,gBAAgB;IAChB,SAAS,aAAa,OAAO,EAAE,UAAU,EAAG,IAAI,EAAE,MAAM,EAAE,OAAO,UAAO,EACtE,YAAY,GAAE,MAAU,EAAE,qBAAqB,UAAO;IAKxD,mGAAmG;WAC5E,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,qBAAqB;IAKhF,iEAAiE;IACjD,MAAM,IAAI,kBAAkB;IAM5C;;;OAGG;IACI,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,qBAAqB;IAI9E,gBAAgB;cACG,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB;IAM5F,gBAAgB;IACA,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAOhE,0GAA0G;IAC1G,IAAW,qBAAqB,IAAI,OAAO,CAE1C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB;IAC7D,OAAO,CAAC,SAAS,CAAC,CAAwB;IAE1C,sEAAsE;IACtE,IAAW,QAAQ,IAAI,qBAAqB,GAAG,SAAS,CAA2B;IAEnF;;;;OAIG;WACoB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,oBAAoB;IAS/E,qDAAqD;IACrC,MAAM,IAAI,iBAAiB;IAQ3C,gBAAgB;IACA,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,iBAAiB;IAWvF,mCAAmC;IACnB,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,oBAAoB;IAUrF,wDAAwD;WAC1C,YAAY,CAAC,QAAQ,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,oBAAoB;IA2D3I,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,oBAAoB;IAI/F,aAAa;IACN,iBAAiB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,oBAAoB;CAGhF"}

package/lib/esm/MapLayerSettings.js

@@ -68,85 +68,98 @@ export class MapSubLayerSettings {
     /** return a string representing this sublayer id (converting to string if underlying id is number) */
     get idString() { return (typeof this.id === "number") ? this.id.toString(10) : this.id; }
 }
-/** Normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+/** Abstract base class for normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+ * This class is extended by [[ImageMapLayerSettings]] and [ModelMapLayerSettings]] to create the settings for image and model based layers.
  * One or more map layers may be included within [[MapImagerySettings]] object.
  * @see [[MapImagerySettings]]
  * @beta
  */
 export class MapLayerSettings {
     /** @internal */
-    constructor(url, name, formatId, visible = true, jsonSubLayers = undefined, transparency = 0, transparentBackground = true, isBase = false, userName, password, accessKey) {
-        var _a;
-        this.formatId = formatId;
+    constructor(name, visible = true, transparency = 0, transparentBackground = true) {
         this.name = name;
         this.visible = visible;
         this.transparentBackground = transparentBackground;
-        this.isBase = isBase;
-        this.subLayers = new Array();
-        if (jsonSubLayers !== undefined) {
-            let hasUnnamedGroups = false;
-            for (const jsonSubLayer of jsonSubLayers) {
-                const subLayer = MapSubLayerSettings.fromJSON(jsonSubLayer);
-                if (undefined !== subLayer) {
-                    this.subLayers.push(subLayer);
-                    if (((_a = subLayer.children) === null || _a === void 0 ? void 0 : _a.length) !== 0 && !subLayer.isNamed && !hasUnnamedGroups)
-                        hasUnnamedGroups = true;
-                }
-            }
-            this.userName = userName;
-            this.password = password;
-        }
-        this.accessKey = accessKey;
         this.transparency = transparency;
-        this.url = url;
-    }
-    setCredentials(userName, password) {
-        this.userName = userName;
-        this.password = password;
     }
-    /** Construct from JSON, performing validation and applying default values for undefined fields. */
-    static fromJSON(json) {
-        const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;
-        return new this(json.url, json.name, json.formatId, json.visible, json.subLayers, json.transparency, transparentBackground, json.isBase === true, undefined, undefined, json.accessKey);
+    /** Create a map layer settings from its JSON representation. */
+    static fromJSON(props) {
+        return undefined !== props.modelId ? ModelMapLayerSettings.fromJSON(props) : ImageMapLayerSettings.fromJSON(props);
     }
-    /** return JSON representation of this MapLayerSettings object */
-    toJSON() {
-        const props = { formatId: this.formatId, name: this.name, url: this.url };
-        if (this.subLayers.length > 0) {
-            props.subLayers = [];
-            this.subLayers.forEach((subLayer) => {
-                const subLayerJson = subLayer.toJSON();
-                if (subLayerJson)
-                    props.subLayers.push(subLayerJson);
-            });
-        }
+    /** @internal */
+    _toJSON() {
+        const props = {
+            name: this.name,
+            visible: this.visible,
+        };
         if (0 !== this.transparency)
             props.transparency = this.transparency;
         if (this.transparentBackground === false)
             props.transparentBackground = this.transparentBackground;
-        if (this.isBase === true)
-            props.isBase = this.isBase;
-        props.visible = this.visible;
         return props;
     }
     /** @internal */
-    static mapTypeName(type) {
-        switch (type) {
-            case BackgroundMapType.Aerial:
-                return "Aerial Imagery";
-            default:
-            case BackgroundMapType.Hybrid:
-                return "Aerial Imagery with labels";
-            case BackgroundMapType.Street:
-                return "Streets";
+    cloneProps(changedProps) {
+        return {
+            name: undefined !== changedProps.name ? changedProps.name : this.name,
+            visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,
+            transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,
+            transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,
+        };
+    }
+    /** @internal */
+    displayMatches(other) {
+        return this.name === other.name && this.visible === other.visible && this.transparency === other.transparency && this.transparentBackground === other.transparentBackground;
+    }
+    /** @internal */
+    matchesNameAndSource(name, source) {
+        return this.name === name && this.source === source;
+    }
+}
+/** Normalized representation of a [[ImageMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+ * Image map layers are created from servers that produce images that represent map tiles.  Map layers map also be represented by models.
+ * One or more map layers may be included within [[MapImagerySettings]] object.
+ * @see [[MapImagerySettings]]
+ * @see [[ModelMapLayerSettings]] for model based map layer settings.
+ * @beta
+ */
+export class ImageMapLayerSettings extends MapLayerSettings {
+    /** @internal */
+    constructor(props) {
+        var _a;
+        const transparentBackground = (_a = props.transparentBackground) !== null && _a !== void 0 ? _a : true;
+        super(props.name, props.visible, props.transparency, transparentBackground);
+        this.formatId = props.formatId;
+        this.url = props.url;
+        this.accessKey = props.accessKey;
+        this.subLayers = [];
+        if (!props.subLayers)
+            return;
+        for (const subLayerProps of props.subLayers) {
+            const subLayer = MapSubLayerSettings.fromJSON(subLayerProps);
+            if (subLayer)
+                this.subLayers.push(subLayer);
         }
     }
+    get source() { return this.url; }
+    static fromJSON(props) {
+        return new this(props);
+    }
+    /** return JSON representation of this MapLayerSettings object */
+    toJSON() {
+        const props = super._toJSON();
+        props.url = this.url;
+        props.formatId = this.formatId;
+        if (this.subLayers.length > 0)
+            props.subLayers = this.subLayers.map((x) => x.toJSON());
+        return props;
+    }
     /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.
      * @param changedProps JSON representation of the properties to change.
      * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
      */
     clone(changedProps) {
-        const clone = MapLayerSettings.fromJSON(this.cloneProps(changedProps));
+        const clone = ImageMapLayerSettings.fromJSON(this.cloneProps(changedProps));
         // Clone members not part of MapLayerProps
         clone.userName = this.userName;
         clone.password = this.password;
@@ -155,27 +168,19 @@ export class MapLayerSettings {
     }
     /** @internal */
     cloneProps(changedProps) {
-        return {
-            name: undefined !== changedProps.name ? changedProps.name : this.name,
-            formatId: undefined !== changedProps.formatId ? changedProps.formatId : this.formatId,
-            visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,
-            url: undefined !== changedProps.url ? changedProps.url : this.url,
-            transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,
-            transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,
-            subLayers: undefined !== changedProps.subLayers ? changedProps.subLayers : this.subLayers,
-            accessKey: undefined !== changedProps.accessKey ? changedProps.accessKey : this.accessKey,
-        };
+        var _a, _b, _c, _d;
+        const props = super.cloneProps(changedProps);
+        props.formatId = (_a = changedProps.formatId) !== null && _a !== void 0 ? _a : this.formatId;
+        props.url = (_b = changedProps.url) !== null && _b !== void 0 ? _b : this.url;
+        props.accessKey = (_c = changedProps.accessKey) !== null && _c !== void 0 ? _c : this.accessKey;
+        props.subLayers = (_d = changedProps.subLayers) !== null && _d !== void 0 ? _d : this.subLayers;
+        return props;
     }
     /** @internal */
     displayMatches(other) {
-        if (!this.matchesNameAndUrl(other.name, other.url)
-            || this.visible !== other.visible
-            || this.transparency !== other.transparency
-            || this.transparentBackground !== other.transparentBackground
-            || this.subLayers.length !== other.subLayers.length) {
+        if (!(other instanceof ImageMapLayerSettings) || !super.displayMatches(other))
             return false;
-        }
-        if (this.userName !== other.userName || this.password !== other.password) {
+        if (this.userName !== other.userName || this.password !== other.password || this.subLayers.length !== other.subLayers.length) {
             return false;
         }
         for (let i = 0; i < this.subLayers.length; i++)
@@ -183,10 +188,6 @@ export class MapLayerSettings {
                 return false;
         return true;
     }
-    /** @internal */
-    matchesNameAndUrl(name, url) {
-        return this.name === name && this.url === url;
-    }
     /** Return a sublayer matching id -- or undefined if not found */
     subLayerById(id) {
         return id === undefined ? undefined : this.subLayers.find((subLayer) => subLayer.id === id);
@@ -207,7 +208,7 @@ export class MapLayerSettings {
             return false;
         return !this.hasInvisibleAncestors(subLayer);
     }
-    /** Return true if all sublayers are visible. */
+    /** Return true if all sublayers are invisible. */
     get allSubLayersInvisible() {
         if (this.subLayers.length === 0)
             return false;
@@ -225,8 +226,74 @@ export class MapLayerSettings {
         });
         return children;
     }
+    /** @internal */
+    static mapTypeName(type) {
+        switch (type) {
+            case BackgroundMapType.Aerial:
+                return "Aerial Imagery";
+            default:
+            case BackgroundMapType.Hybrid:
+                return "Aerial Imagery with labels";
+            case BackgroundMapType.Street:
+                return "Streets";
+        }
+    }
+    setCredentials(userName, password) {
+        this.userName = userName;
+        this.password = password;
+    }
+}
+/** Normalized representation of a [[ModelMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
+ * Model map layers are produced from models, typically from two dimensional geometry that may originate in a GIS system.
+ * One or more map layers may be included within [[MapImagerySettings]] object.
+ * @see [[MapImagerySettings]]
+ * @see [[ImageMapLayerSettings]] for image based map layer settings.
+ * @beta
+ */
+export class ModelMapLayerSettings extends MapLayerSettings {
+    /** @internal */
+    constructor(modelId, name, visible = true, transparency = 0, transparentBackground = true) {
+        super(name, visible, transparency, transparentBackground);
+        this.modelId = modelId;
+    }
+    get source() { return this.modelId; }
+    /** Construct from JSON, performing validation and applying default values for undefined fields. */
+    static fromJSON(json) {
+        const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;
+        return new this(json.modelId, json.name, json.visible, json.transparency, transparentBackground);
+    }
+    /** return JSON representation of this MapLayerSettings object */
+    toJSON() {
+        const props = super._toJSON();
+        props.modelId = this.modelId;
+        return props;
+    }
+    /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps) {
+        return ModelMapLayerSettings.fromJSON(this.cloneProps(changedProps));
+    }
+    /** @internal */
+    cloneProps(changedProps) {
+        var _a;
+        const props = super.cloneProps(changedProps);
+        props.modelId = (_a = changedProps.modelId) !== null && _a !== void 0 ? _a : this.modelId;
+        return props;
+    }
+    /** @internal */
+    displayMatches(other) {
+        if (!(other instanceof ModelMapLayerSettings) || !super.displayMatches(other))
+            return false;
+        return this.modelId === other.modelId;
+    }
+    /** Return true if all sublayers are invisible (always false as model layers do not include sublayers). */
+    get allSubLayersInvisible() {
+        return false;
+    }
 }
-/** A [[MapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].
+/** A [[ImageMapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].
  * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based
  * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).
  * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows
@@ -234,7 +301,7 @@ export class MapLayerSettings {
  * @see [[MapImagerySettings.backgroundBase]].
  * @beta
  */
-export class BaseMapLayerSettings extends MapLayerSettings {
+export class BaseMapLayerSettings extends ImageMapLayerSettings {
     /** The provider from which this base layer was configured, if any. */
     get provider() { return this._provider; }
     /** Create a base layer from its JSON representation.
@@ -259,7 +326,9 @@ export class BaseMapLayerSettings extends MapLayerSettings {
     /** @internal */
     cloneProps(changedProps) {
         const props = super.cloneProps(changedProps);
-        if (this.provider)
+        if (changedProps.provider)
+            props.provider = changedProps.provider;
+        else if (this.provider)
             props.provider = this.provider.toJSON();
         return props;
     }
@@ -291,21 +360,21 @@ export class BaseMapLayerSettings extends MapLayerSettings {
                         imagerySet = "AerialWithLabels";
                         break;
                 }
-                name = `Bing Maps: ${MapLayerSettings.mapTypeName(provider.type)}`;
+                name = `Bing Maps: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;
                 url = `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/${imagerySet}?o=json&incl=ImageryProviders&key={bingKey}`;
                 break;
             case "MapBoxProvider":
                 formatId = "MapboxImagery";
-                name = `MapBox: ${MapLayerSettings.mapTypeName(provider.type)}`;
+                name = `MapBox: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;
                 switch (provider.type) {
                     case BackgroundMapType.Street:
-                        url = "https://api.mapbox.com/v4/mapbox.streets/";
+                        url = "https://api.mapbox.com/styles/v1/mapbox/streets-v11/tiles/";
                         break;
                     case BackgroundMapType.Aerial:
-                        url = "https://api.mapbox.com/v4/mapbox.satellite/";
+                        url = "https://api.mapbox.com/styles/v1/mapbox/satellite-v9/tiles/";
                         break;
                     case BackgroundMapType.Hybrid:
-                        url = "https://api.mapbox.com/v4/mapbox.streets-satellite/";
+                        url = "https://api.mapbox.com/styles/v1/mapbox/satellite-streets-v11/tiles/";
                         break;
                 }
                 break;
@@ -315,7 +384,6 @@ export class BaseMapLayerSettings extends MapLayerSettings {
             formatId,
             url,
             transparentBackground: false,
-            isBase: true,
             visible: !(options === null || options === void 0 ? void 0 : options.invisible),
             transparency: options === null || options === void 0 ? void 0 : options.transparency,
         });