Skip to content

Latest commit

 

History

History
124 lines (92 loc) · 6.44 KB

README.md

File metadata and controls

124 lines (92 loc) · 6.44 KB

Build Status

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. Then you can use MapillaryJS with a <script> tag.

<!DOCTYPE html>
<html>
<head>
    <script src='https://unpkg.com/[email protected]/dist/mapillary.min.js'></script>
    <link href='https://unpkg.com/[email protected]/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

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.