maptalks.polygonbool

A tool to do boolean operation of Polygon and MultiPolygon.

Examples

DEMO

Install

• Install with npm: npm install maptalks.polygonbool.
• Download from dist directory.
• Use jsdelivr CDN: https://cdn.jsdelivr.net/npm/maptalks.polygonbool/dist/maptalks.polygonbool.min.js

Usage

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

<!-- ... -->
<script src="https://cdn.jsdelivr.net/npm/maptalks.geosplit/dist/maptalks.polygonbool.min.js"></script>
<!-- ... -->

// new PolygonBool and layer
const ms = new maptalks.PolygonBool()
const layer = new maptalks.VectorLayer('v').addTo(map)

// use PolygonBool API, targets is not necessary parameters and if no targets user will choose geometry on the map
// get details in API Reference

API Reference

new maptalks.PolygonBool()
// new maptalks.PolygonBool({ includeSame: false, alterNative: ['foo_layer_id', 'bar_layer_id'] })

• options
  • includeSame boolean decide if exclude geometry with same coordinates, default is true
  • alterNative Array layer names of layer which you need to choose geometry on

intersection(geometry, targets) if no targets, start choose mode on map

union(geometry, targets) same as above

diff(geometry, targets) same as above

xor(geometry, targets) same as above

submit(callback) callback can get three attr, the result, deals(targets or choose-targets) and task name.

cancel()

remove()

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

More Things

• maptalks.autoadsorb
• maptalks.multisuite
• maptalks.geosplit
• maptalks.polygonbool
• maptalks.geo2img
• maptalks.control.compass
• maptalks.autogradual