Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/w8r/L.Control.LineStringSelect
Polyline selection control for Leaflet
https://github.com/w8r/L.Control.LineStringSelect
leaflet leaflet-plugin linestring selection
Last synced: 18 days ago
JSON representation
Polyline selection control for Leaflet
- Host: GitHub
- URL: https://github.com/w8r/L.Control.LineStringSelect
- Owner: w8r
- License: mit
- Created: 2014-12-30T13:10:41.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T22:54:29.000Z (over 1 year ago)
- Last Synced: 2024-10-01T07:27:31.644Z (about 1 month ago)
- Topics: leaflet, leaflet-plugin, linestring, selection
- Language: JavaScript
- Homepage: https://w8r.github.io/L.Control.LineStringSelect
- Size: 3.1 MB
- Stars: 47
- Watchers: 5
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# L.Control.LineStringSelect [](https://badge.fury.io/js/leaflet-linestring-select) [](https://circleci.com/gh/w8r/L.Control.LineStringSelect)
LineString selection tool: you can select a part or a stretch of a polyline on the map. Performance-oriented, uses [rbush](https://github.com/mourner/rbush/) for segment lookup
## [Demo](https://w8r.github.io/L.Control.LineStringSelect)
Look how this thing deals with a coastline polyline consisting of ~500 points
[demo](https://w8r.github.io/L.Control.LineStringSelect)
## Options
| Option | type | default value |
| - | - | - |
| `startMarkerClass` | `string` | 'select-marker select-start-marker' |
| `endMarkerClass` | `string` | 'select-marker select-end-marker' |
| `movingMarkerClass` | `string` | 'select-marker select-moving-marker' |
| `name` | `string` | 'leaflet-linestring-select' |
| `lineWeight` | `number` | 4 |
| `lineTolerance` | `number` | `L.Browser.mobile ? 10 : 5` |
| `movingMarkerStyle` | [`L.CircleMarcerOptions`](https://leafletjs.com/reference-1.6.0.html#circlemarker-option) | {
fillColor: '#fff',
fillOpacity: 1,
weight: 2,
opacity: 0.5,
color: '#000'
} |
| `endpointStyle` | [`L.CircleMarcerOptions`](https://leafletjs.com/reference-1.6.0.html#circlemarker-option) | {
radius: 5,
color: '#111',
fillColor: '#fff',
fillOpacity: 1
} |
| `selectionStyle` | [`L.PolylineOptions`](https://leafletjs.com/reference-1.6.0.html#polyline-option) | {
color: '#0ff',
opacity: 1
} |
| `useTouch` | `boolean` | `L.Browser.mobile` |
| `position` | `'topright'|'topleft'|'bottomleft'|'bottomright'` | `'topright'` |
## API
`.enable({layer: polyline, feature: feature})`
Enables control, initializes it with provided polyline. You can pass GeoJSON object as well, otherwise it will be auto-generated
`.disable()`
Disable control, remove handlers and selection
`.reset()`
Reset selection
`.selectMeters(startMeter, endMeter)`
Select stretch by meter distances from linestring start.
`.toGeoJSON()`
Returns selection GeoJSON
`.getSelection()`
Returns array of selection `L.LatLng`s
### Events
`selection`
Selection changed or finished.
`reset`
Selection cleared
`select:start : {pos: }`
First point set
`select:end : {pos: }`
Second point set
## Usage
```javascript
npm install --save leaflet-linestring-select
...
var Select = require('leaflet-linestring-select');
```
or
```
```
See `/examples/app.js` for initialization and other things
## Requirements
- `leaflet@>=1.x`
- `rbush@>=3.x`
## License
The MIT License (MIT)
Copyright (c) 2019 Alexander Milevski
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.