maptalks.multisuite/README.md

An Suite to Combine <-> Decompose, Peel <-> Fill MultiPolygon.

# maptalks.multisuite

An Suite to Combine <-> Decompose, Peel <-> Fill MultiPolygon.

## Examples

### [DEMO](https://cxiaof.github.io/maptalks.multisuite/demo/index.html)

## Tips

Combine <-> Decompose with Circle also has bug of maptalks, see the [issue](https://github.com/maptalks/maptalks.js/issues/725)

## Install

-   Install with npm: `npm install maptalks.multisuite`.
-   Download from [dist directory](https://github.com/cXiaof/maptalks.multisuite/tree/master/dist).
-   Use unpkg CDN: `https://cdn.jsdelivr.net/npm/maptalks.multisuite/dist/maptalks.multisuite.min.js`

## Usage

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

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

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

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

## API Reference

```javascript
new maptalks.MultiSuite()
```

-   options
    -   colorHit **String** the color of symbol when geo hit
    -   colorChosen **String** the color of symbol when geo chosen

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

`decompose(geometry, targets)` same as above

`peel(geometry, targets)` same as above

`fill(geometry, targets, fillAll)` same as above. And if fillAll, the result is An Polygon, else is always MultiPolygon

`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](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
```

## More Things

-   [maptalks.autoadsorb](https://github.com/cXiaof/maptalks.autoadsorb/issues)
-   [maptalks.multisuite](https://github.com/cXiaof/maptalks.multisuite/issues)
-   [maptalks.geosplit](https://github.com/cXiaof/maptalks.geosplit/issues)
-   [maptalks.polygonbool](https://github.com/cXiaof/maptalks.polygonbool/issues)
-   [maptalks.geo2img](https://github.com/cXiaof/maptalks.geo2img/issues)
-   [maptalks.control.compass](https://github.com/cXiaof/maptalks.control.compass/issues)
-   [maptalks.autogradual](https://github.com/cXiaof/maptalks.autogradual/issues)