Add a stretchable image to the map
This example uses a stretchable image as a background for text. Stretchable images allow some parts of the image to stretch while keeping other parts, such as corners, at a constant size. Set the layout property 'icon-text-fit': 'both' to use the image as background for the text.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Add a stretchable image to the map</title>
<meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
<link href="https://api.mapbox.com/mapbox-gl-js/v3.8.0/mapbox-gl.css" rel="stylesheet">
<script src="https://api.mapbox.com/mapbox-gl-js/v3.8.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/streets-v12',
zoom: 0.5,
projection: 'winkelTripel'
});
const images = {
'popup': 'https://docs.mapbox.com/mapbox-gl-js/assets/popup.png',
'popup-debug':
'https://docs.mapbox.com/mapbox-gl-js/assets/popup_debug.png'
};
loadImages(images, (loadedImages) => {
map.on('load', () => {
map.addImage('popup-debug', loadedImages['popup-debug'], {
// The two (blue) columns of pixels that can be stretched horizontally:
// - the pixels between x: 25 and x: 55 can be stretched
// - the pixels between x: 85 and x: 115 can be stretched.
stretchX: [
[25, 55],
[85, 115]
],
// The one (red) row of pixels that can be stretched vertically:
// - the pixels between y: 25 and y: 100 can be stretched
stretchY: [[25, 100]],
// This part of the image that can contain text ([x1, y1, x2, y2]):
content: [25, 25, 115, 100],
// This is a high-dpi image:
pixelRatio: 2
});
map.addImage('popup', loadedImages['popup'], {
stretchX: [
[25, 55],
[85, 115]
],
stretchY: [[25, 100]],
content: [25, 25, 115, 100],
pixelRatio: 2
});
map.addSource('points', {
'type': 'geojson',
'data': {
'type': 'FeatureCollection',
'features': [
{
'type': 'Feature',
'geometry': {
'type': 'Point',
'coordinates': [40, -10]
},
'properties': {
'image-name': 'popup-debug',
'name': 'Line 1\nLine 2\nLine 3'
}
},
{
'type': 'Feature',
'geometry': {
'type': 'Point',
'coordinates': [40, 50]
},
'properties': {
'image-name': 'popup',
'name': 'Line 1\nLine 2\nLine 3'
}
},
{
'type': 'Feature',
'geometry': {
'type': 'Point',
'coordinates': [-40, -10]
},
'properties': {
'image-name': 'popup-debug',
'name': 'One longer line'
}
},
{
'type': 'Feature',
'geometry': {
'type': 'Point',
'coordinates': [-40, 50]
},
'properties': {
'image-name': 'popup',
'name': 'One longer line'
}
}
]
}
});
map.addLayer({
'id': 'points',
'type': 'symbol',
'source': 'points',
'layout': {
'text-field': ['get', 'name'],
'icon-text-fit': 'both',
'icon-image': ['get', 'image-name'],
'icon-allow-overlap': true,
'text-allow-overlap': true
}
});
// the original, unstretched image for comparison
map.addSource('original', {
'type': 'geojson',
'data': {
'type': 'FeatureCollection',
'features': [
{
'type': 'Feature',
'geometry': {
'type': 'Point',
'coordinates': [0, -50]
}
}
]
}
});
map.addLayer({
'id': 'original',
'type': 'symbol',
'source': 'original',
'layout': {
'text-field': 'unstretched image',
'icon-image': 'popup-debug',
'icon-allow-overlap': true,
'text-allow-overlap': true
}
});
});
});
function loadImages(urls, callback) {
const results = {};
for (const name in urls) {
map.loadImage(urls[name], makeCallback(name));
}
function makeCallback(name) {
return (err, image) => {
results[name] = err ? null : image;
// if all images are loaded, call the callback
if (Object.keys(results).length === Object.keys(urls).length) {
callback(results);
}
};
}
}
</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: 'map',
style: 'mapbox://styles/mapbox/streets-v12',
zoom: 0.5,
projection: 'winkelTripel'
});
const images = {
popup: 'https://docs.mapbox.com/mapbox-gl-js/assets/popup.png',
'popup-debug':
'https://docs.mapbox.com/mapbox-gl-js/assets/popup_debug.png'
};
loadImages(images, (loadedImages) => {
mapRef.current.on('load', () => {
mapRef.current.addImage('popup-debug', loadedImages['popup-debug'], {
// The two (blue) columns of pixels that can be stretched horizontally:
// - the pixels between x: 25 and x: 55 can be stretched
// - the pixels between x: 85 and x: 115 can be stretched.
stretchX: [
[25, 55],
[85, 115]
],
// The one (red) row of pixels that can be stretched vertically:
// - the pixels between y: 25 and y: 100 can be stretched
stretchY: [[25, 100]],
// This part of the image that can contain text ([x1, y1, x2, y2]):
content: [25, 25, 115, 100],
// This is a high-dpi image:
pixelRatio: 2
});
mapRef.current.addImage('popup', loadedImages['popup'], {
stretchX: [
[25, 55],
[85, 115]
],
stretchY: [[25, 100]],
content: [25, 25, 115, 100],
pixelRatio: 2
});
mapRef.current.addSource('points', {
type: 'geojson',
data: {
type: 'FeatureCollection',
features: [
{
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [40, -10]
},
properties: {
'image-name': 'popup-debug',
name: 'Line 1\nLine 2\nLine 3'
}
},
{
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [40, 50]
},
properties: {
'image-name': 'popup',
name: 'Line 1\nLine 2\nLine 3'
}
},
{
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [-40, -10]
},
properties: {
'image-name': 'popup-debug',
name: 'One longer line'
}
},
{
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [-40, 50]
},
properties: {
'image-name': 'popup',
name: 'One longer line'
}
}
]
}
});
mapRef.current.addLayer({
id: 'points',
type: 'symbol',
source: 'points',
layout: {
'text-field': ['get', 'name'],
'icon-text-fit': 'both',
'icon-image': ['get', 'image-name'],
'icon-allow-overlap': true,
'text-allow-overlap': true
}
});
// the original, unstretched image for comparison
mapRef.current.addSource('original', {
type: 'geojson',
data: {
type: 'FeatureCollection',
features: [
{
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [0, -50]
}
}
]
}
});
mapRef.current.addLayer({
id: 'original',
type: 'symbol',
source: 'original',
layout: {
'text-field': 'unstretched image',
'icon-image': 'popup-debug',
'icon-allow-overlap': true,
'text-allow-overlap': true
}
});
});
});
function loadImages(urls, callback) {
const results = {};
for (const name in urls) {
mapRef.current.loadImage(urls[name], makeCallback(name));
}
function makeCallback(name) {
return (err, image) => {
results[name] = err ? null : image;
if (Object.keys(results).length === Object.keys(urls).length) {
callback(results);
}
};
}
}
}, []);
return <div id="map" ref={mapContainerRef} style={{ height: '100%' }} />;
};
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?