Skip to main content

Render world copies

Additional Developer Resources

Toggle between rendering a single world and multiple copies of the world using setRenderWorldCopies. If renderWorldCopies is true and the map is using a rectangular projection, multiple copies of the world will be rendered side by side beyond -180 and 180 degrees longitude.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Render world copies</title>
<meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
<link href="https://api.mapbox.com/mapbox-gl-js/v3.12.0/mapbox-gl.css" rel="stylesheet">
<script src="https://api.mapbox.com/mapbox-gl-js/v3.12.0/mapbox-gl.js"></script>
<style>
body { margin: 0; padding: 0; }
#map { position: absolute; top: 0; bottom: 0; width: 100%; }
</style>
</head>
<body>
<style>
    #menu {
        position: absolute;
        background: #fff;
        padding: 10px;
        font-family: 'Open Sans', sans-serif;
    }
</style>

<div id="map"></div>
<div id="menu">
    <div>Set <code>renderWorldCopies</code> to:</div>
    <div>
        <input type="radio" id="true" name="rtoggle" value="true" checked="">
        <label for="true">true</label>
    </div>
    <div>
        <input type="radio" id="false" name="rtoggle" value="false">
        <label for="false">false</label>
    </div>
</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', // container ID
        // Choose from Mapbox's core styles, or make your own style with Mapbox Studio
        style: 'mapbox://styles/mapbox/streets-v12', // style URL
        projection: 'mercator', // Projection needs to be  `mercator' or `equirectangular` to render world copies
        center: [179, 0], // starting position [lng, lat]
        zoom: 0.01 // starting zoom
    });

    const menu = document.getElementById('menu');
    const inputs = menu.getElementsByTagName('input');

    // If input clicked has `id` "true", set renderWorldCopies to true.
    // Otherwise, set to false.
    function switchRenderOption(option) {
        map.setRenderWorldCopies(option.target.id === 'true');
    }

    for (let i = 0; i < inputs.length; i++) {
        inputs[i].onclick = switchRenderOption;
    }
</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.
Additional Developer Resources
Was this example helpful?