Animate a series of images | Mapbox GL JS

Use a series of image sources to create an animation.

JavaScript

React

JavaScript

React


<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Animate a series of images</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.1/mapbox-gl.css" rel="stylesheet">
<script src="https://api.mapbox.com/mapbox-gl-js/v3.9.1/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/dark-v11',
        maxZoom: 5.99,
        minZoom: 4,
        zoom: 5,
        center: [-75, 44]
    });

    const frameCount = 5;
    let currentImage = 0;

    function getPath() {
        return `https://docs.mapbox.com/mapbox-gl-js/assets/radar${currentImage}.gif`;
    }

    map.on('load', () => {
        map.addSource('radar', {
            type: 'image',
            url: getPath(),
            coordinates: [
                [-80.425, 46.437],
                [-71.516, 46.437],
                [-71.516, 37.936],
                [-80.425, 37.936]
            ]
        });
        map.addLayer({
            id: 'radar-layer',
            'type': 'raster',
            'source': 'radar',
            'paint': {
                'raster-fade-duration': 0
            }
        });

        setInterval(() => {
            currentImage = (currentImage + 1) % frameCount;
            map.getSource('radar').updateImage({ url: getPath() });
        }, 200);
    });
</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.

JavaScript

React


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',
      // Choose from Mapbox's core styles, or make your own style with Mapbox Studio
      style: 'mapbox://styles/mapbox/dark-v11',
      maxZoom: 5.99,
      minZoom: 4,
      zoom: 5,
      center: [-75, 44]
    });

    const frameCount = 5;
    let currentImage = 0;

    function getPath() {
      return `https://docs.mapbox.com/mapbox-gl-js/assets/radar${currentImage}.gif`;
    }

    mapRef.current.on('load', () => {
      mapRef.current.addSource('radar', {
        type: 'image',
        url: getPath(),
        coordinates: [
          [-80.425, 46.437],
          [-71.516, 46.437],
          [-71.516, 37.936],
          [-80.425, 37.936]
        ]
      });
      mapRef.current.addLayer({
        id: 'radar-layer',
        type: 'raster',
        source: 'radar',
        paint: {
          'raster-fade-duration': 0
        }
      });

      setInterval(() => {
        currentImage = (currentImage + 1) % frameCount;
        mapRef.current.getSource('radar').updateImage({ url: getPath() });
      }, 200);
    });
  }, []);

  return (
    <div
      id="map"
      ref={mapContainerRef}
      style={{ width: '100%', height: '400px' }}
    ></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.

Additional Developer Resources

Mapbox Developer Discord

Developer Cheatsheet

Mapbox Support

Ask AI

Was this example helpful?