Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

mapbox-animation

0.16.3 • Public • Published

Animate a GeoJSON source easily with Mapbox GL

Live Demo

Mapbox animation features demo

The code of the demo is in the "example" folder.

Installation

Like regular mapbox-gl, either include the source file

<script type="text/javascript" src="http://misterfresh.github.io/mapbox-animation/mapbox-gl.js" charset="utf-8"></script>

or install the npm package

npm install mapbox-animation

Usage

map.getSource('vehicles').animate(1000);  //To activate animation for this source with a delay of 1000ms
var vehiclesPositions = {
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-76.93238901390978, 38.913188059745586]
        },
        "properties": {
            "title": "Bicycle",
            "marker-symbol": "bicycle",
            "nextPosition": [-76.83238901390978, 38.813188059745586]
        }
    }, {
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-77.13238901390978, 38.813188059745586]
        },
        "properties": {
            "title": "Car",
            "marker-symbol": "car",
            "nextPosition": [-76.97238901390978, 38.973188059745586]
        }
    }]
};
 
map.getSource('vehicles').setData(vehiclesPositions);  //markers will animate
 

After running the animate method, set the "nextPosition" property, and the markers will smoothly transition to the specified coordinates.

Mapbox-gl extension

This module is mapbox-gl, extended with a new "animate" method for GeoJSON sources.

GeoJSONSource.animate(delay, transitionStyle);

The delay parameter is the duration of the transition. It is optional and defaults to false (no animation). The transition style parameter is optional, it defaults to "linear". Other available styles are "none", "bezier", "midpoints", and "circle". These other styles will only work if the "previousPosition" property is also set, because they require three points.

Performance

The following layer options seemed to give the best performance:

 map.addLayer({
    "id": "layerId",
    "type": "symbol",
    "source": "sourceId",
    "layout": {
        "icon-allow-overlap": true,
        "icon-ignore-placement": true,
        "text-allow-overlap": true,
        "text-optional": true,
    }
});

Animations were very smooth on iPhone 6S, average on 2 year-old macbook Air, and choppy on the retina macbook pro.

For more information, refer to the official mapbox-gl-js repository.

install

npm i mapbox-animation

Downloadsweekly downloads

12

version

0.16.3

license

BSD-3-Clause

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar