maptalks.geometryselection
v0.1.0-beta.1
Published
A tool to select geometries on layers.
Downloads
5
Maintainers
Readme
maptalks.geometryselection
A tool to select geometries on layers.
Examples
DEMO
Install
- Install with npm:
npm install maptalks.geometryselection
. - Install with yarn:
yarn add maptalks.geometryselection
. - Download from dist directory.
- Use jsdelivr CDN:
https://cdn.jsdelivr.net/npm/maptalks.geometryselection/dist/maptalks.geometryselection.min.js
Usage
As a plugin, maptalks.geometryselection
must be loaded after maptalks.js
in browsers. You can also use 'import { GeometrySelection } from "maptalks.geometryselection"
when developing with webpack.
<!-- ... -->
<script src="https://cdn.jsdelivr.net/npm/maptalks.geometryselection/dist/maptalks.geometryselection.min.js"></script>
<!-- ... -->
const gs = new maptalks.GeometrySelection({
layers: ['v1', 'v2', 'v3']
}).addTo(map)
API Reference
new maptalks.GeometrySelection(options, defaultChosenGeos)
options Object
- layers Array names array of layers which choose geometry on
- availTypes Array or String which types geometry can be chosen. If availTypes equal ' * ', all types is available.
- colorHit String the color of symbol when geo hit
- colorChosen String the color of symbol when geo chosen
defaultChosenGeos Array
addTo()
set map
getMap()
get map
enable()
disable()
toggleEnable()
enable <=> disable
isEnabled()
get enable status
getGeometries()
get all geos chosen
forEach()
filter()
clear()
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
- Package and generate minified bundles to dist directory
$ gulp minify
- Lint
$ npm run lint