Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clementallen/react-leaflet-semicircle
React wrapper for the leaflet-semicircle plugin
https://github.com/clementallen/react-leaflet-semicircle
Last synced: 2 months ago
JSON representation
React wrapper for the leaflet-semicircle plugin
- Host: GitHub
- URL: https://github.com/clementallen/react-leaflet-semicircle
- Owner: clementallen
- License: mit
- Created: 2019-01-06T18:42:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T04:49:30.000Z (almost 2 years ago)
- Last Synced: 2024-04-29T07:00:29.919Z (8 months ago)
- Language: JavaScript
- Homepage: https://npmjs.com/package/react-leaflet-semicircle
- Size: 1.36 MB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-leaflet-semicircle
[](http://npmjs.com/package/react-leaflet-semicircle)
[](http://npmjs.com/package/react-leaflet-semicircle)
[](https://github.com/clementallen/react-leaflet-semicircle)
[](https://david-dm.org/clementallen/react-leaflet-semicircle)
[](https://david-dm.org/clementallen/react-leaflet-semicircle?type=dev)
[](https://codeclimate.com/github/clementallen/react-leaflet-semicircle)
[](https://codeclimate.com/github/)
React wrapper of [leaflet-semicircle](https://github.com/jieter/Leaflet-semicircle)
for [react-leaflet](https://github.com/PaulLeCam/react-leaflet).
Semicircle vector layers for [Leaflet](https://leafletjs.com) maps. Extends [L.Circle](http://leafletjs.com/reference.html#circle) and [L.CircleMarker](http://leafletjs.com/reference.html#circlemarker).
_Most recently tested with Leaflet 1.7.1 and React-Leaflet 3.1.0_
## Requirements
The current version of this library supports React Leaflet v3.
If you are using React Leaflet v2, please use the v2 version of this library:
https://github.com/clementallen/react-leaflet-semicircle/tree/v2
## Installation
```bash
npm install react-leaflet-semicircle --save
```
## Usage
### Complete example with react-leaflet
```javascript
import { MapContainer, TileLayer } from 'react-leaflet';
import { SemiCircle, SemiCircleMarker } from 'react-leaflet-semicircle';
;
```
### \
```javascript
```
#### Props
| Name | Type | Example | Description |
| ----------------------- | ----------------------------------------- | ----------------- | ----------------------------------------------- |
| position [**required**] | L.LatLng[] **or** Array\[number, number\] | \[51.505, -0.09\] | Latitude and Longitude of the semicircle center |
| radius [**required**] | number | 2000 | Radius of the semicircle in metres |
| startAngle | number | 90 | Starting bearing of the semicircle |
| stopAngle | number | 180 | Ending bearing of the semicircle |
**All other options from L.Circle are also supported. [View them here](https://leafletjs.com/reference#circle)**
### \
```javascript
```
#### Props
| Name | Type | Example | Description |
| ----------------------- | ----------------------------------------- | ----------------- | ----------------------------------------------------- |
| position [**required**] | L.LatLng[] **or** Array\[number, number\] | \[51.505, -0.09\] | Latitude and Longitude of the semicirclemarker center |
| startAngle | number | 90 | Starting bearing of the semicirclemarker |
| stopAngle | number | 180 | Ending bearing of the semicirclemarker |
**All other options from L.CircleMarker are also supported. [View them here](https://leafletjs.com/reference#circlemarker)**
### Additional component methods
Each component comes with additional methods that can be accessed via [React Refs](https://reactjs.org/docs/hooks-reference.html#useref).
#### Setup
```javascript
const semiCircleRef = React.useRef();
// ----
;
```
#### setDirection(direction, size)
Use `setDirection(direction, size)` to display a semicircle of `size` degrees at `direction`.
```javascript
semiCircleRef.current.setDirection(90, 90);
```
#### setStartAngle(angle)
Use `setStartAngle(angle)` to set the start angle of the semicircle to `angle`
```javascript
semiCircleRef.current.setStartAngle(90);
```
#### setStopAngle(angle)
Use `setStopAngle(angle)` to set the stop angle of the semicircle to `angle`
```javascript
semiCircleRef.current.setStopAngle(90);
```