MapboxglLayer for maptalks.js
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo fix demo May 18, 2018
dist 0.3.1 Mar 15, 2018
test disable test May 2, 2017
.babelrc initial commit Mar 29, 2017
.editorconfig initial commit Mar 29, 2017
.eslintrc initial commit Mar 29, 2017
.gitignore initial commit Mar 29, 2017
.npmignore initial commit Mar 29, 2017
LICENSE initial commit Mar 29, 2017
README.md update api links Jun 2, 2017
circle.yml initial commit Mar 29, 2017
gulpfile.js disable test May 2, 2017
index.js fix zooming offset, close #3 Mar 15, 2018
karma.config.js initial commit Mar 29, 2017
package.json 0.3.1 Mar 15, 2018

README.md

maptalks.mapboxgl

NPM Version

A plugin to add mapbox-gl-js as a layer for maptalks.js.

screenshot

Examples

Install

  • Install with npm: npm install maptalks.mapboxgl.
  • Download from dist directory.
  • Use unpkg CDN: https://unpkg.com/maptalks.mapboxgl/dist/maptalks.mapboxgl.min.js

Usage

As a plugin, maptalks.mapboxgl must be loaded after maptalks.js and mapbox-gl.js in browsers.

<script type="text/javascript" src="https://unpkg.com/maptalks/dist/maptalks.min.js"></script>
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.36.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.36.0/mapbox-gl.css' rel='stylesheet' />
<script type="text/javascript" src="https://unpkg.com/maptalks.mapboxgl/dist/maptalks.mapboxgl.min.js"></script>
<script>
var mapboxglLayer = new maptalks.MapboxglLayer('tile',{
        glOptions : {
            'style' : 'mapbox://styles/mapbox/light-v9'
        }
    }).addTo(map);
</script>

Supported Browsers

IE 11, Chrome, Firefox, other modern and mobile browsers support WebGL.

API Reference

MapboxglLayer is a subclass of maptalks.Layer and inherits all the methods of its parent.

Constructor

new maptalks.MapboxglLayer(id, options)

getGlMap()

get mapbox-gl-js map instance used by the layer

Returns Map

toJSON()

export the layer's JSON.

var json = mapboxglLayer.toJSON();

Returns Object

Contributing

We welcome any kind of contributions including issue reportings, pull requests, documentation corrections, feature requests and any other helps.

Develop

The only source file is index.js.

It is written in ES6, transpiled by babel and tested with mocha and expect.js.

Scripts

  • Install dependencies
$ npm install
  • Watch source changes and generate runnable bundle repeatedly
$ gulp watch
  • Tests
$ npm test
  • Watch source changes and run tests repeatedly
$ gulp tdd
  • Package and generate minified bundles to dist directory
$ gulp minify
  • Lint
$ npm run lint