MglBackgroundLayer

Background Layer

See the layer style specification

import { MglBackgroundLayer } from '@indoorequal/vue-maplibre-gl';

Props

layerId

• Type: string
• Required: true
• Default: undefined

The id of the layer

metadata

• Type: undefined
• Required: false
• Default: undefined

Arbitrary properties useful to track with the layer, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'maplibre:'.

minzoom

• Type: number
• Required: false
• Default: undefined

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

maxzoom

• Type: number
• Required: false
• Default: undefined

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

before

• Type: string
• Required: false
• Default: undefined

The ID of an existing layer to insert the new layer before, resulting in the new layer appearing visually beneath the existing layer. If this argument is not specified, the layer will be appended to the end of the layers array and appear visually above all other layers.

layout

• Type: BackgroundLayerSpecification["layout"]
• Required: false
• Default: undefined

Layout properties for the layer. See https://maplibre.org/maplibre-style-spec/layers/#background

paint

• Type: BackgroundLayerSpecification["paint"]
• Required: false
• Default: undefined

Default paint properties for this layer. See https://maplibre.org/maplibre-style-spec/layers/#background

Source

See source.