leaflet.curve.text v1.0.0
Leaflet.curve.text
A Leaflet plugin for drawing Bézier curves with text over it.
Usage
If using directly, include the plugin after Leaflet:
<script src="leaflet.js"></script>
<script src="leaflet.curve.text.js"></script>If using Node.js, install and import:
Curve
Add a path that includes a Bézier curve and straight lines:
var path = L.curve(['M',[50.54136296522163,28.520507812500004],
'C',[52.214338608258224,28.564453125000004],
[48.45835188280866,33.57421875000001],
[50.680797145321655,33.83789062500001],
'V',[48.40003249610685],
'L',[47.45839225859763,31.201171875],
[48.40003249610685,28.564453125000004],'Z'],
{color:'red',fill:true}).addTo(map);Set Text
var path = L.curve(['M',50.54136296522163,28.520507812500004, 'C',52.214338608258224,28.564453125000004, 48.45835188280866,33.57421875000001, 50.680797145321655,33.83789062500001, 'V',48.40003249610685, 'L',47.45839225859763,31.201171875, 48.40003249610685,28.564453125000004,'Z'], {color:'red',fill:true}).setText(' Curve 1',{center:true}).addTo(map);
Notes
- This plugin is based on Leaflet version 1.1.0.
- SVG rendering is best supported.
- Browser and device compatibility testing is very limited.
API
The first argument to L.curve() is an array of path data. This is composed of commands and coordinates. The commands are a subset of the SVG path specification.
| Command | Parameters | Description |
|---|---|---|
| M | lat,lng+ | move to lat,lng |
| L | lat,lng+ | line to lat,lng |
| H | lng+ | horizontal line to lng |
| V | lat+ | vertical line to lat |
| C | (lat1,lng1,lat2,lng2,lat,lng)+ | cubic Bézier curve to lat,lng with control points at lat1,lng1 and lat2,lng2 |
| S | (lat2,lng2,lat,lng)+ | cubic bézier curve to lat,lng with control points at reflection of second control point of previous curve lat1,lng1 and lat2,lng2 |
| Q | (lat1,lng1,lat,lng)+ | quadratic Bézier curve to lat,lng with control point at lat1,lng1 |
| T | (lat,lng)+ | quadratic Bézier curve to lat,lng with control point at reflection of control point of previous curve lat1,lng1 |
| Z | close path (line to M) |
Note that only absolute commands (uppercase) are implemented. It's possible to approximate elliptical arcs (command 'A') with Bézier curves (the elliptical-arc branch implements this command if you're interested).
The L.Curve class extends L.Path so options, events, and methods inherited from L.Path are available. The following new option and methods are introduced by L.Curve.
Options
Curve
|Option|Type|Default|Description|
|------|----|-------|-----------|
|animate|Integer or animate options object|undefined|Animates the curve. It takes a parameter which is the same one provided to the options parameter of Element.animate() method. Note: Web Animations API support varies across browsers.|
setText center : Centers the text according to the polyline's bounding box (Default: true)
below: Show text below the path (Default: false)
offset: Set an offset to position text relative to the polyline (Default:20)
orientation: Rotate text . (Default: 180) e.g. : orientaton:90
attributes Object containing the attributes applied to the text tag. Check valid attributes here (Default: {})
License
MIT
Contributions
- Bug reports and pull requests are welcome!
5 years ago