Mapbox GL JS
API Reference
Examples
Plugins
Style Specification
Getting started (1)Display a mapStyles (11)Add an animated icon to the mapAdd a generated icon to the mapGenerate and add a missing icon to the mapAdd a stretchable image to the mapAdd a default markerAdd an icon to the mapDisplay a map with a custom styleRender world copiesDisplay a satellite mapChange a map's styleDisplay a mapLayers (40)Add a 3D modelDisplay buildings in 3DAdd an animated icon to the mapExtrude polygons for 3D indoor mappingAdd a generated icon to the mapGenerate and add a missing icon to the mapAdd a stretchable image to the mapAdd an icon to the mapAdjust a layer's opacityAnimate a lineAnimate a series of imagesAnimate a pointChange building color based on zoom levelChange the case of labelsDisplay HTML clusters with custom propertiesCreate and style clustersChange a layer's color with buttonsAdd a custom style layerStyle circles with a data-driven propertyStyle lines with a data-driven propertyDisplay and style rich text labelsAdd a pattern to a polygonAdd a new layer below labelsAdd a GeoJSON lineDraw GeoJSON pointsAdd a GeoJSON polygonCreate a heatmap layerAdd hillshadingAdd an imageDisplay line that crosses 180th meridianCreate a gradient line using an expressionAdd multiple geometries from one GeoJSON sourceStyle ocean depth dataShow and hide layersChange worldview of administrative boundariesUpdate a choropleth layer by zoom levelVariable label placementAdd a videoVisualize population densityUse a fallback imageSources (16)Animate a lineAnimate a series of imagesAnimate a pointAdd a canvas sourceJoin local JSON data with vector tile geometriesAdd hillshadingAdd an imageDisplay line that crosses 180th meridianAdd live realtime dataUpdate a feature in realtimeAdd a raster tile sourceAdd a third party vector tile sourceCreate a time sliderAdd a vector tile sourceAdd a videoAdd a WMS sourceUser interaction (27)Adjust a layer's opacityCustomize camera animationsCenter the map on a clicked symbolChange a layer's color with buttonsAnimate 3D buildings based on ambient soundsDisable map rotationCreate a draggable MarkerFilter features within map viewFilter symbols by text inputFilter symbols by toggling a listCreate a hover effectDisplay a non-interactive mapChange a map's languageMeasure distancesGet coordinates of the mouse pointerHighlight features containing similar dataSelect features around a clicked pointGet features under the mouse pointerRestrict map panning to an areaChange a map's styleCreate a time sliderToggle interactionsChange worldview of administrative boundariesUpdate a choropleth layer by zoom levelHighlight features within a bounding boxFit to the bounds of a LineStringCreate a draggable pointCamera (13)Animate map camera around a pointAnimate a point along a routeCustomize camera animationsCenter the map on a clicked symbolFit a map to a bounding boxSlowly fly to a locationFly to a locationNavigate the map with game-like controlsJump to a series of locationsOffset the vanishing point using paddingPlay map locations as a slideshowFly to a location based on scroll positionSet pitch and bearingControls and overlays (17)Animate a markerChange the default position for attributionAdd custom icons with MarkersDisable scroll zoomView a fullscreen mapLocate the userSwipe between mapsDisplay driving directionsShow drawn polygon areaAdd a geocoderAdd a marker using a place nameDisplay map navigation controlsShow polygon information on clickDisplay a popup on clickDisplay a popup on hoverDisplay a popupAttach a popup to a marker instanceGeocoder (10)Supplement forward geocoding search results from another data sourceAccept coordinates as input to a geocoderUse a custom render function with a geocoderLimit geocoder results to a named regionUse the geocoder without a mapPlace the geocoder input outside the mapUse a custom camera animation with a geocoderLocalize the geocoder to a given languageAdd a geocoderSet a point after Geocoder resultBrowser support (1)Check if Mapbox GL JS is supportedInternationalization support (2)Use locally generated ideographsAdd support for right-to-left scripts

Add an image

Dark vector baselayer with radar weather image overlay.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Add an image</title>
<meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
<script src="https://api.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
<link href="https://api.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />
<style>
	body { margin: 0; padding: 0; }
	#map { position: absolute; top: 0; bottom: 0; width: 100%; }
</style>
</head>
<body>
<div id="map"></div>
<script>
	// TO MAKE THE MAP APPEAR YOU MUST
	// ADD YOUR ACCESS TOKEN FROM
	// https://account.mapbox.com
	mapboxgl.accessToken = '<your access token here>';
var mapStyle = {
'version': 8,
'name': 'Dark',
'sources': {
'mapbox': {
'type': 'vector',
'url': 'mapbox://mapbox.mapbox-streets-v8'
},
'overlay': {
'type': 'image',
'url': 'https://docs.mapbox.com/mapbox-gl-js/assets/radar.gif',
'coordinates': [
[-80.425, 46.437],
[-71.516, 46.437],
[-71.516, 37.936],
[-80.425, 37.936]
]
}
},
'sprite': 'mapbox://sprites/mapbox/dark-v10',
'glyphs': 'mapbox://fonts/mapbox/{fontstack}/{range}.pbf',
'layers': [
{
'id': 'background',
'type': 'background',
'paint': { 'background-color': '#111' }
},
{
'id': 'water',
'source': 'mapbox',
'source-layer': 'water',
'type': 'fill',
'paint': { 'fill-color': '#2c2c2c' }
},
{
'id': 'boundaries',
'source': 'mapbox',
'source-layer': 'admin',
'type': 'line',
'paint': {
'line-color': '#797979',
'line-dasharray': [2, 2, 6, 2]
},
'filter': ['all', ['==', 'maritime', 0]]
},
{
'id': 'overlay',
'source': 'overlay',
'type': 'raster',
'paint': { 'raster-opacity': 0.85 }
},
{
'id': 'cities',
'source': 'mapbox',
'source-layer': 'place_label',
'type': 'symbol',
'layout': {
'text-field': '{name_en}',
'text-font': ['DIN Offc Pro Bold', 'Arial Unicode MS Bold'],
'text-size': [
'interpolate',
['linear'],
['zoom'],
4,
9,
6,
12
]
},
'paint': {
'text-color': '#969696',
'text-halo-width': 2,
'text-halo-color': 'rgba(0, 0, 0, 0.85)'
}
},
{
'id': 'states',
'source': 'mapbox',
'source-layer': 'place_label',
'type': 'symbol',
'layout': {
'text-transform': 'uppercase',
'text-field': '{name_en}',
'text-font': ['DIN Offc Pro Bold', 'Arial Unicode MS Bold'],
'text-letter-spacing': 0.15,
'text-max-width': 7,
'text-size': [
'interpolate',
['linear'],
['zoom'],
4,
10,
6,
14
]
},
'filter': ['==', ['get', 'class'], 'state'],
'paint': {
'text-color': '#969696',
'text-halo-width': 2,
'text-halo-color': 'rgba(0, 0, 0, 0.85)'
}
}
]
};
 
var map = new mapboxgl.Map({
container: 'map',
maxZoom: 5.99,
minZoom: 4,
zoom: 5,
center: [-75.789, 41.874],
style: mapStyle
});
</script>
 
</body>
</html>
Was this example helpful?