2.0.6 • Published 3 years ago

leaflet-semirings

Licence

ISC

Version

2.0.6

Deps

Size

315 kB

Vulns

Weekly

Summary Dependency Versions

Leaflet-Semicircle.

Allows drawing semicircles on leaflet maps.

It's an extension of Leaflet's L.Circle, and behaves like L.Circle if the a semicircle of almost 360 degrees is displayed.

Updated for use with leaflet 1.1.0.

L.SemiCircle/ L.SemiCircleMarker
factories: L.semiCircle/L.SemiCircleMarker Options:
startAngle: start angle of the semicircle
stopAngle: stop angle of the semicircle
Angles are defined like compass courses: 0 = north, 90 = east, etc.
innerRadius: defines an inner radius to display a ring instead of a circle
ringWidth: set thickness of the ring, if set it overwrites the innerRadius

`L.SemiCircle.setStartAngle(angle)`	Set the start angle of the circle to `angle` and redraw.
`L.Circle.setStopAngle(angle)`	Set the stop angle of the circle to `angle` and redraw.
`L.Circle.setDirection(direction, size)`	Set the `startAngle` to `direction - (0.5 * size)` and the `stopAngle` to `direction + (0.5 * size)` and redraw.

Usage:

The plugin provides two ways to only display a part of the circle:

Use the options map and set startAngle and stopAngle.
Use the options the option innerRadius or ringWidth to draw a ring instead of a circle.
Use setDirection(direction, size) to display a semicircle of size degrees at direction.

Example:

Live demo

Using options.startAngle and options.stopAngle:

L.semiCircle([51.5, -0.09], {
    radius: 500,
	startAngle: 45,
	stopAngle: 135
}).addTo(map);

Draw the same semicircle using setDirection(direction, size):

L.semiCircle([51.5, -0.09], {radius: 500})
	.setDirection(90, 90)
	.addTo(map);

Draw the same semicircle using as a ring:

L.semiCircle([51.5, -0.09], {
    radius: 500,
    innerRadius: 300,
    //// same as:
    // ringWidth: 200,
	startAngle: 45,
	stopAngle: 135
}).addTo(map);