WebGL JavaScript library for displaying street level imagery from mapillary.com
TypeScript CSS Other
Latest commit bb86fb5 Jan 9, 2017 @oscarlorentzon oscarlorentzon 2.3.0

README.md

Build Status

MapillaryJS

MapillaryJS is a JavaScript & WebGL library that renders street level photos 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. Then you can use MapillaryJS with a <script> tag.

<!DOCTYPE html>
<html>
<head>
    <script src='https://unpkg.com/mapillary-js@2.3.0/dist/mapillary.min.js'></script>
    <link href='https://unpkg.com/mapillary-js@2.3.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 photo id 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

Documentation

Changelog

Every release is described on the GitHub Releases page.

License

MIT License

Contributing to MapillaryJS

See CONTRIBUTING.md.

Migrating from MapillaryJS 1 to 2

See MIGRATING.md.