maptalks.maptool.identifytool
v0.1.0-alpha.1
Published
A IdentifyTool to identify geos within a circular range with variable radius
Downloads
1
Maintainers
cxiaofReadme
maptalks.maptool.identifytool
A IdentifyTool to identify geos within a circular range with variable radius.
Examples
DEMO
Install
- Install with npm:
npm install maptalks.maptool.identifytool. - Install with yarn:
yarn add maptalks.maptool.identifytool. - Download from dist directory.
- Use unpkg CDN:
https://cdn.jsdelivr.net/npm/maptalks.maptool.identifytool/dist/maptalks.maptool.identifytool.min.js
Usage
As a plugin, maptalks.maptool.identifytool must be loaded after maptalks.js in browsers. You can also use 'import { Identifytool } from "maptalks.maptool.identifytool" when developing with webpack.
<!-- ... -->
<script src="https://cdn.jsdelivr.net/npm/maptalks.maptool.identifytool/dist/maptalks.maptool.identifytool.min.js"></script>
<!-- ... -->// new IdentifyTool
const identifyTool = new maptalks.IdentifyTool({ layers: [layers] })
// add to map
identifyTool.addTo(map)
// listening identify event
identifyTool.on('identify', (e) => {
// render identify result
renderData(e.data)
})
// listening rangechange event
identifyTool.on('rangechange', (e) => {
// commit after each range change if you want
identifyTool.submit()
})API Reference
new maptalks.IdentifyTool(options)- options Object options
- layers Array the layers to perform identify on.
- filter Function filter function of the result geometries, return false to exclude.
- count Number limit of the result count.
- includeInternals Boolean whether to identify internal layers.
- includeInvisible Boolean whether to identify invisible layers.
setCenter(coordinate) set center, map center by default.
setRadius(radius) set radius of range, options.radiusDefault by default.
submit() trigger once identify.
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