maptalks.glowlayer

maptalks.GlowLayer

A plugin used for mouse point to adsorb geometries, based on snap interaction.

Install

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

Usage

As a plugin, maptalks.GlowLayer must be loaded after maptalks.js in browsers. You can also use 'import { GlowLayerol } from "maptalks.GlowLayer" when develope with webpack.

<script type="text/javascript" src="https://unpkg.com/maptalks/dist/maptalks.min.js"></script>
<script type="text/javascript" src="https://unpkg.com/maptalks.GlowLayer/dist/maptalks.GlowLayer.min.js"></script>
<script>
   var layer = new maptalks.GlowLayer({
                color: [255, 0, 0, 0.2],
                lineJoin : 'round'
            }).addTo(map);
</script>

Supported Browsers

IE 9-11, Chrome, Firefox, other modern and mobile browsers.

Examples

• See the demo.

API Reference

setLayer(layer||maptalks.VectorLayer) specify a layer which has geometries to snap to.

setGeometries(geometries||Array<maptalks.Geometry>) specify a geometry collection to snap to.

enable() start snap to.

disable() end snap to.

setMode(mode||String) set the snap strategy, when mode is 'point', it will snap to geometries's end points.When it set to 'line',it will snap a point which is mearest to mouse on a LineString.

...

## 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

$ 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