Skip to content
master
Go to file
Code

Latest commit

Adjust docs landing page to include only relevant
parts of readme.
Add favicon and footer legal info.
92686fc

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

yarn workflow GitHub license npm version

MapillaryJS

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

San Francisco on Mapillary.com Frigilana on Mapillary.com

Using MapillaryJS

To use MapillaryJS you must create an account and obtain a Client ID by registering an application. Then you can use MapillaryJS with a <script> tag.

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

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

    <script>
        var mly = new Mapillary.Viewer(
            'mly',
            '<your client id>',
            '<your image key for initializing the viewer>'
        );
    </script>
</body>
</html>

Alternatively, you can npm install mapillary-js to use it with a module loader or bundler of your choice.

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

Examples

Support

Viewer

Viewer and map

Components

Marker

Mouse

Keyboard

Popup

Route

Slider

Tag

Documentation

Migrating

Learn how to migrate between major MapillaryJS releases.

Contribute to MapillaryJS

Learn how to contribute.

Code of Conduct

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

License

MapillaryJS is MIT licensed.

You can’t perform that action at this time.