API Reference > imodeljs-common > DisplayStyles > BackgroundMapSettings BackgroundMapSettings Class Normalized representation of a BackgroundMapProps for which type and provider have been validated and default values have been applied where explicit values not defined. Methods Name Description clone(changedProps?: BackgroundMapProps): BackgroundMapSettings Create a copy of this BackgroundMapSettings, optionally modifying some of its properties. equals(other: BackgroundMapSettings): boolean equalsJSON(json?: BackgroundMapProps): boolean Returns true if these settings are equivalent to the supplied JSON settings. toJSON(): BackgroundMapProps fromJSON(json?: BackgroundMapProps): BackgroundMapSettings Static Construct from JSON, performing validation and applying default values for undefined fields. Properties Name Type Description applyTerrain Readonly boolean If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. globeMode Readonly GlobeMode Globe display mode. groundBias Readonly number Elevation in meters, relative to WGS84 Ellipsoid.. locatable Accessor ReadOnly boolean If false, the map will be treated as non-locatable - i.e., tools will not interact with it. mapType Readonly BackgroundMapType The type of map graphics to be drawn. planarClipMask Readonly PlanarClipMaskSettings Planar Mask - used to mask the background map to avoid overlapping with other geometry Beta providerName Readonly BackgroundMapProviderName Identifies the provider from which map image will be obtained. terrainSettings Readonly TerrainSettings Settings associated with terrain display. transparency Readonly number | 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. transparencyOverride Accessor ReadOnly undefined | number If transparency is overridden, the transparency to apply; otherwise, undefined. useDepthBuffer Readonly boolean If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Defined in core/common/src/BackgroundMapSettings.ts Line 106 Last Updated: 12 June, 2024