WebGL & JavaScript library for displaying street level imagery from Mapillary
TypeScript CSS HTML Other
Latest commit 2f55883 Jun 5, 2018
Permalink
Failed to load latest commit information.
debug feat(tag): allow rects to be created in any direction Sep 24, 2017
scripts Simplify docs script and test command calls. Jul 27, 2016
spec feat: observable for emitting image when changed Jun 4, 2018
src feat: check for blob and url support Jun 4, 2018
styles fix(slider): ensure no overlap with compass indicator Jun 1, 2018
typings/created Install polylabel with mapbox prefix Jun 20, 2017
.editorconfig Add .editorconfig Nov 13, 2015
.gitignore Ignore vagrant files. Jan 10, 2017
.npmignore Add .npmignore Jan 18, 2016
CODE_OF_CONDUCT.md Contributor Code of Conduct Jan 13, 2016
CONTRIBUTING.md docs: add hovered tag example Aug 4, 2017
ISSUE_TEMPLATE.md fix: improve issue template Feb 20, 2018
LICENSE MIT License Jan 13, 2016
MIGRATING.md docs: replace photo with image everywhere Dec 5, 2017
README.md 2.12.1 Jun 5, 2018
circle.yml chore: update ci node version and add package lock Jul 4, 2017
karma.conf.js Set mime type for ts files explicitly. Dec 29, 2016
licenses.csv feat: add more licensing Feb 14, 2018
licenses_decisions.yml feat: add more licensing Feb 14, 2018
package-lock.json 2.12.1 Jun 5, 2018
package.json 2.12.1 Jun 5, 2018
server.js refactor: use package.json browsers list Jun 29, 2017
tsconfig.docs.json docs(slider): add class documentation May 29, 2018
tsconfig.json Use type checking when linting May 29, 2017
tslint.json chore: extend tslint recommended Nov 14, 2017
typings.json Install polylabel with mapbox prefix Jun 20, 2017

README.md

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/mapillary-js@2.12.1/dist/mapillary.min.js'></script>
    <link href='https://unpkg.com/mapillary-js@2.12.1/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.