Layers common Props Props for Mapbox GL source sourceId
Type: String
Required Non-Synced Description: ID of the source to add. Must not conflict with existing sources. See: .addSource()
Map method Props for Mapbox GL layer layerId
Type String
Description: ID of the layer to add. Must not conflict with existing layers. Required Non-Synced See: id
in Mapbox Layer Style Spec Type: Object
Non-Synced Description: Arbitrary properties useful to track with the layer, but do not influence rendering. See: metadata
in Mapbox Layer Style Spec minZoom
Type: Number
Default: undefined
Non-Synced Description: The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. See: minzoom
in Mapbox Layer Style Spec maxZoom
Type: Number
Default: undeined
Non-Synced Description: The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden. See: maxzoom
in Mapbox Layer Style Spec paint
Type: Object
Default: undefined
Non-Synced Description: Default paint properties for this layer. See: paint
in Mapbox Layer Style Spec layout
Type: Object
Default: undefined
Non-Synced Description: Layout properties for the layer. See: layout
in Mapbox Layer Style Spec filter
Type: Object
Default: undefined
Non-Synced Description: A expression specifying conditions on source features. Only features that match the filter are displayed. See: before
in .addLayer()
Map method before
Type: String
Default: undefined
Non-Synced Description: The ID of an existing layer to insert the new layer before. See: metadata
in Mapbox Layer Style Spec Props for Vue-Mapbox component clearSource
Type: Boolean
Default: true
Non-Synced Description: If true
, component will remove layer source from map on component destruction. replaceSource
Type: Boolean
Default: false
Non-Synced Description: If source passed to 'source' prop of layer component already added ot the map, it will generate error event. If replaceSource
is true
source will be replaced with new instead. replace
Type: Boolean
Default: false
Non-Synced Description: If true
, replaces existing layer with same id. Otherwise, error returns. Computed properties sourceLoaded
Type Boolean
Description Flag that indicated if layer source already loaded. mapLayer
Type Object
Description Mapbox GL layer object. See .getLayer()
map method mapSource
Methods .move(beforeId?)
Arguments: beforeId
String
The ID of an existing layer to insert the new layer before. If this argument is omitted, the layer will be appended to the end of the layers array. Description Moves a layer to a different z-position. See .moveLayer()
map method .remove()
Description Removes the layer with and source assosiated with it. See .removeLayer()
map method Events Payload of events contains object with properties:
mapboxEvent
Original Mapbox GL JS event layerId
ID of current layer map
Current map object component
Component that emits event @mousedown
@mouseup
@click
@dblclick
@mousemove
@mouseenter
@mouseleave
@mouseover
@mouseout
@touchstart
@touchend
@touchcancel