https://github.com/sakitam-gis/maptalks.minedata

maptalks plugin to minedata
https://github.com/sakitam-gis/maptalks.minedata

Last synced: 3 months ago
JSON representation

maptalks plugin to minedata

• Host: GitHub
• URL: https://github.com/sakitam-gis/maptalks.minedata
• Owner: sakitam-gis
• License: other
• Created: 2019-01-10T10:01:44.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-05-17T08:24:24.000Z (over 5 years ago)
• Last Synced: 2024-07-14T05:35:21.491Z (4 months ago)
• Language: JavaScript
• Homepage: https://sakitam-gis.github.io/maptalks.minedata/demo/index.html
• Size: 347 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# maptalks.minedata

A plugin to add [minedata](http://www.minedata.cn/index)

 as a layer for [maptalks.js](https://github.com/maptalks/maptalks.js).

## Examples

* [demo](https://sakitam-gis.github.io/maptalks.minedata/demo/)

## Install

  

* Install with npm: ```npm install @sakitam-gis/maptalks.minedata```. 

* Use unpkg CDN: ```https://unpkg.com/@sakitam-gis/maptalks.minedata/dist/maptalks.minedata.min.js```

## Usage

As a plugin, `maptalks.minedata` must be loaded after `maptalks.js` 

and `minedata` in browsers.

```html



    minemap.accessToken = '25cc55a69ea7422182d00d6b7c0ffa93';

    minemap.solution = 2365;

    var baseLayer = new maptalks.MineLayer('tile',{

        glOptions : {

            'style' : '//minedata.cn/service/solu/style/id/2365'

        }

    }).on('layerload', function () {

        // start();

    });

    var map = new maptalks.Map('map', {

        center: [116.46,39.92],

        zoom: 16,

        baseLayer: baseLayer

    });

```

## Supported Browsers

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

## API Reference

```MineLayer``` is a subclass of [maptalks.Layer](https://maptalks.github.io/docs/api/Layer.html) and inherits all the methods of its parent.

### `Constructor`

```javascript

new maptalks.MineLayer(id, options)

```

* id **String** layer id

* options **Object** options

    * glOptions **Object** MineLayer creation options defined in [minedata](http://www.minedata.cn/develop)

    * other options defined in [maptalks.Layer](https://maptalks.github.io/docs/api/Layer.html)

### `getGlMap()`

get minedata map instance used by the layer

**Returns** `Map`

### `toJSON()`

export the layer's JSON.

```javascript

var json = MineLayer.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](https://babeljs.io/) and tested with [mocha](https://mochajs.org) and [expect.js](https://github.com/Automattic/expect.js).

### Scripts

* Install dependencies

```shell

$ npm install

```

* Watch source changes and generate runnable bundle repeatedly

```shell

$ gulp watch

```

* Tests

```shell

$ npm test

```

* Watch source changes and run tests repeatedly

```shell

$ gulp tdd

```

* Package and generate minified bundles to dist directory

```shell

$ gulp minify

```

* Lint

```shell

$ npm run lint

```