---
title: "background.MTBackgroundLayer | Mobile sdk | Mobile sdk android | Android"
description: "MTBackgroundLayer"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# background.MTBackgroundLayer

@Serializable

class [MTBackgroundLayer](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/) : [MTLayer](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer/-m-t-layer/)

The background style layer covers the entire map. Use it to configure a color or pattern rendered beneath all other map content. If the background layer is transparent or omitted, any area not covered by another layer is transparent.

Members

## Constructors

[MTBackgroundLayer](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/-m-t-background-layer/)

constructor(identifier: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html))

constructor(identifier: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), type: [MTLayerType](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer/-m-t-layer-type/), maxZoom: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?, minZoom: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?, color: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)?, opacity: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?, pattern: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?, visibility: [MTLayerVisibility](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer/-m-t-layer-visibility/))

## Properties

[color](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/color/)

@Serializable(with = [ColorAsHexSerializer::class](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.fill/-color-as-hex-serializer/))

var [color](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/color/): [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)?

The color with which the background will be drawn. Defaults to black. Disabled by [pattern](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/pattern/).

[identifier](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/identifier/)

@SerialName(value = "id")

open override var [identifier](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/identifier/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)

Unique layer identifier.

[maxZoom](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/max-zoom/)

@SerialName(value = "maxzoom")

open override var [maxZoom](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/max-zoom/): [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?

Max zoom of the layer.

[minZoom](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/min-zoom/)

@SerialName(value = "minzoom")

open override var [minZoom](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/min-zoom/): [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?

Min zoom of the layer.

[opacity](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/opacity/)

var [opacity](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/opacity/): [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?

The opacity at which the background will be drawn. Optional number between 0 and 1 inclusive. Defaults to 1.

[pattern](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/pattern/)

var [pattern](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/pattern/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a power of two.

[sourceIdentifier](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/source-identifier/)

@Transient

open override var [sourceIdentifier](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/source-identifier/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)

Background layers do not have a source. Kept only to satisfy [MTLayer](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer/-m-t-layer/) contract and excluded from serialization.

[sourceLayer](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/source-layer/)

@Transient

open override var [sourceLayer](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/source-layer/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?

Source layer is not applicable for background layers. Excluded from serialization.

[type](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/type/)

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

open override var [type](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/type/): [MTLayerType](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer/-m-t-layer-type/)

Type of the layer. Always [MTLayerType.BACKGROUND](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer/-m-t-layer-type/-b-a-c-k-g-r-o-u-n-d/).

[visibility](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/visibility/)

var [visibility](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer.background/-m-t-background-layer/visibility/): [MTLayerVisibility](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.style.layer/-m-t-layer-visibility/)

Whether this layer is displayed.