mirror of
https://github.com/mapillary/mapillary-js.git
synced 2026-02-01 14:33:45 +00:00
8d54200d1a
Propagate image fetching errors to ensure that image is loaded. Fallback to empty mesh when loading fails.
MapillaryJS
MapillaryJS is a JavaScript & WebGL library that renders street level photos from Mapillary.
Using MapillaryJS
To use MapillaryJS you must create an account and then obtain a Client ID. Then you can use MapillaryJS with a <script> tag.
<!DOCTYPE html>
<html>
<head>
<script src='https://unpkg.com/mapillary-js@1.7.2/dist/mapillary-js.min.js'></script>
<link href='https://unpkg.com/mapillary-js@1.7.2/dist/mapillary-js.min.css' rel='stylesheet' />
</head>
<body>
<div id='mly' style='width: 640px; height: 480px;' />
<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 module loader or bundler of your choice.
Refer to the Examples and Documentation sections below for more information.
Examples
- Simple MapillaryJS embedding
- Storytelling with MapillaryJS
- Slider displaying difference in two photos
- MapillaryJS + Leaflet - Panorama - Perspective photo
- MapillaryJS + Leaflet + Tangram - Panorama - Perspective photo
- MapillaryJS + Mapbox GL JS - Panorama - Perspective photo
- MapillaryJS + Esri Leaflet - Panorama - Perspective photo
- MapillaryJS + Google Maps - Panorama
- MapillaryJS + Esri JavaScript API 3.x Panorama
Documentation
Changelog
Every release is described on the GitHub Releases page.
License
MIT License
Contributing to MapillaryJS
See CONTRIBUTING.md.