Variable label placement
Use text-variable-anchor to allow high priority labels to shift position to stay on the map.
Referencing images in a style's sprite
This example uses the Mapbox Light style. The icon-image used in this example comes from the Mapbox Light style's sprite.
To view all available images in a style's sprite or add additional images, open the style in Mapbox Studio and click the Images tab. To add a new image to the style at runtime see the Add an icon to the map example.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Variable label placement</title>
<meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
<link href="https://api.mapbox.com/mapbox-gl-js/v3.9.0/mapbox-gl.css" rel="stylesheet">
<script src="https://api.mapbox.com/mapbox-gl-js/v3.9.0/mapbox-gl.js"></script>
<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_MAPBOX_ACCESS_TOKEN';
const map = new mapboxgl.Map({
container: 'map',
// Choose from Mapbox's core styles, or make your own style with Mapbox Studio
style: 'mapbox://styles/mapbox/light-v11',
center: [-77.04, 38.907],
zoom: 11.15
});
// This GeoJSON contains features that include an "icon"
// property. The value of the "icon" property corresponds
// to an image in the Mapbox Light style's sprite.
const places = {
'type': 'FeatureCollection',
'features': [
{
'type': 'Feature',
'properties': {
'description': "Ford's Theater",
'icon': 'theatre'
},
'geometry': {
'type': 'Point',
'coordinates': [-77.038659, 38.931567]
}
},
{
'type': 'Feature',
'properties': {
'description': 'The Gaslight',
'icon': 'theatre'
},
'geometry': {
'type': 'Point',
'coordinates': [-77.003168, 38.894651]
}
},
{
'type': 'Feature',
'properties': {
'description': "Horrible Harry's",
'icon': 'bar'
},
'geometry': {
'type': 'Point',
'coordinates': [-77.090372, 38.881189]
}
},
{
'type': 'Feature',
'properties': {
'description': 'Bike Party',
'icon': 'bicycle'
},
'geometry': {
'type': 'Point',
'coordinates': [-77.052477, 38.943951]
}
},
{
'type': 'Feature',
'properties': {
'description': 'Rockabilly Rockstars',
'icon': 'music'
},
'geometry': {
'type': 'Point',
'coordinates': [-77.031706, 38.914581]
}
},
{
'type': 'Feature',
'properties': {
'description': 'District Drum Tribe',
'icon': 'music'
},
'geometry': {
'type': 'Point',
'coordinates': [-77.020945, 38.878241]
}
},
{
'type': 'Feature',
'properties': {
'description': 'Motown Memories',
'icon': 'music'
},
'geometry': {
'type': 'Point',
'coordinates': [-77.007481, 38.876516]
}
}
]
};
map.on('load', () => {
// Add a GeoJSON source containing place coordinates and information.
map.addSource('places', {
'type': 'geojson',
'data': places
});
map.addLayer({
'id': 'poi-labels',
'type': 'symbol',
'source': 'places',
'layout': {
'text-field': ['get', 'description'],
'text-variable-anchor': ['top', 'bottom', 'left', 'right'],
'text-radial-offset': 0.5,
'text-justify': 'auto',
'icon-image': ['get', 'icon']
}
});
map.rotateTo(180, { duration: 10000 });
});
</script>
</body>
</html>
This code snippet will not work as expected until you replace
YOUR_MAPBOX_ACCESS_TOKEN with an access token from your Mapbox account.import React, { useEffect, useRef } from 'react';
import mapboxgl from 'mapbox-gl';
import 'mapbox-gl/dist/mapbox-gl.css';
const MapboxExample = () => {
const mapContainerRef = useRef();
const mapRef = useRef();
useEffect(() => {
// TO MAKE THE MAP APPEAR YOU MUST
// ADD YOUR ACCESS TOKEN FROM
// https://account.mapbox.com
mapboxgl.accessToken = 'YOUR_MAPBOX_ACCESS_TOKEN';
mapRef.current = new mapboxgl.Map({
container: mapContainerRef.current,
style: 'mapbox://styles/mapbox/light-v11',
center: [-77.04, 38.907],
zoom: 11.15
});
const places = {
type: 'FeatureCollection',
features: [
{
type: 'Feature',
properties: {
description: "Ford's Theater",
icon: 'theatre'
},
geometry: {
type: 'Point',
coordinates: [-77.038659, 38.931567]
}
},
{
type: 'Feature',
properties: {
description: 'The Gaslight',
icon: 'theatre'
},
geometry: {
type: 'Point',
coordinates: [-77.003168, 38.894651]
}
},
{
type: 'Feature',
properties: {
description: "Horrible Harry's",
icon: 'bar'
},
geometry: {
type: 'Point',
coordinates: [-77.090372, 38.881189]
}
},
{
type: 'Feature',
properties: {
description: 'Bike Party',
icon: 'bicycle'
},
geometry: {
type: 'Point',
coordinates: [-77.052477, 38.943951]
}
},
{
type: 'Feature',
properties: {
description: 'Rockabilly Rockstars',
icon: 'music'
},
geometry: {
type: 'Point',
coordinates: [-77.031706, 38.914581]
}
},
{
type: 'Feature',
properties: {
description: 'District Drum Tribe',
icon: 'music'
},
geometry: {
type: 'Point',
coordinates: [-77.020945, 38.878241]
}
},
{
type: 'Feature',
properties: {
description: 'Motown Memories',
icon: 'music'
},
geometry: {
type: 'Point',
coordinates: [-77.007481, 38.876516]
}
}
]
};
mapRef.current.on('load', () => {
mapRef.current.addSource('places', {
type: 'geojson',
data: places
});
mapRef.current.addLayer({
id: 'poi-labels',
type: 'symbol',
source: 'places',
layout: {
'text-field': ['get', 'description'],
'text-variable-anchor': ['top', 'bottom', 'left', 'right'],
'text-radial-offset': 0.5,
'text-justify': 'auto',
'icon-image': ['get', 'icon']
}
});
mapRef.current.rotateTo(180, { duration: 10000 });
});
return () => mapRef.current.remove();
}, []); // Empty dependency array to run only once
return <div ref={mapContainerRef} style={{ height: '100%' }}></div>;
};
export default MapboxExample;
This code snippet will not work as expected until you replace
YOUR_MAPBOX_ACCESS_TOKEN with an access token from your Mapbox account.Was this example helpful?