Mapillary-js NPM

MapillaryJS

MapillaryJS is a JavaScript & WebGL library that renders street level imagery from Mapillary.

Using MapillaryJS

To use MapillaryJS you must create an account and obtain a Client ID by registering an application.

You can use MapillaryJS as a <script> tag from a CDN, or as a mapillary-js package on npm.

<!DOCTYPE html>
<html>
<head>
    <script src='https://unpkg.com/mapillary-js@3.1.0/dist/mapillary.min.js'></script>
    <link href='https://unpkg.com/mapillary-js@3.1.0/dist/mapillary.min.css' rel='stylesheet' />
</head>

<body>
    <div id='mly' style='width: 640px; height: 480px;'></div>

    <script>
        var mly = new Mapillary.Viewer({
            apiClient: '<your client id>',
            container: 'mly',
            imageId: '<your image id for initializing the viewer>',
        });
    </script>
</body>
</html>

Refer to the Examples and Documentation sections below for more information.

Examples

Support

Check if MapillaryJS is supported

Viewer

Viewer and map

Components

Marker

Mouse

Activate and deactivate mouse and touch handlers

Keyboard

Activate and deactivate keyboard handlers

Popup

Route

Storytelling

Slider

Compare images

Documentation

API Reference

Migrating

Learn how to migrate between major MapillaryJS releases.

Contribute to MapillaryJS

Learn how to contribute.

Code of Conduct

Facebook has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.