Skip to content

Latest commit

 

History

History
107 lines (84 loc) · 4.26 KB

README.md

File metadata and controls

107 lines (84 loc) · 4.26 KB
Raw

Leaflet.Antimeridian

A plugin to allow polygons and polylines to naturally draw across the Antimeridian (or the Internation Date Line) instead of always wrapping across the Greenwich meridian.

Useful when displaying lines that might cross or partially cross the Antimeridian.

Simple polygons/polylines without using Leaflet.Antimeridian
Leaflet
Using Leaflet.Antimeridian
using Leaflet.Antimeridian

Demo

Installation

Requires [email protected].

Usage

This plugin may be downloaded as a single Javascript file and directly included in the project. It may also be downloaded as an NPM project, complete with tests and examples.

Javascript Download

To download the source file and include in the the project, run:

git clone https://github.com/briannaAndCo/Leaflet.Antimeridian.git
cd Leaflet.Antimeridian
git checkout v1.0.0

A folder named dist will appear, with the file leaflet.antimeridian-src.js inside it. Include that folder in your index.html file using the paths below.

<script src="path/to/[email protected]/dist/leaflet.js"></script>
<script src="path/to/leaflet.antimeridian-src.js"></script>

Download Source and Compile

If you would like to download and compile the source, clone the repository as above. Then checkout master instead of v1.0.0.

Then follow the steps below to build the source.

npm install \\Will install the npm dependancies, including leaflet.
jake test \\Run the tests
npm run rollup \\This will generate the leaflet.antimeridian-src.js file

Include the generated file the same way as the above method.

Examples

To run the examples, first download and compile the source.

Then open the example files in your browser. They should be in the form:

file:///path/to/examples/Leaflet.Antimeridian/examples/Wrapped.Polygon.html

Usage

To create a L.Wrapped.Polyline or L.Wrapped.Polygon, simply pass an array of latlngs to the factory function or the constructor as the first argument. The second optional argument is options object.

var mymap = L.map('mapid').setView([51.505, -0.09], 1);
L.tileLayer('http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', {
  maxZoom: 18
}).addTo(mymap);

var pointList = [new L.LatLng(20.00, 140.0), L.LatLng(50.00, -120.0), L.LatLng(70.50, 170.0)];

//Create and display a wrapping polygon.
new L.Wrapped.Polygon(pointList, {
    color: 'red',
    weight: 3,
    opacity: 0.5,
    smoothFactor: 1,
    noWrap:true
  }).addTo(mymap);

//Create and display a wrapping polyline over the same set of points.
  new L.Wrapped.Polyline(pointList, {
    color: 'blue',
    weight: 3,
    opacity: 0.5,
    smoothFactor: 1,
    noWrap:true
    }).addTo(mymap);
});

API reference

Factories

Factory Description
L.Wrapped.Polyline(LatLng[] latlngs, options options?) Create a automatically wrapping polyline that will take all the usual polyline options.
L.wrappedPolyline(LatLng[] latlngs, options options?) Factory method that wraps the L.Wrapped.Polyline constructor.
L.Wrapped.Polygon(LatLng[] latlngs, options options?) Create a automatically wrapping polygon that will take all the usual polygon options.
L.wrappedPolygon(LatLng[] latlngs, options options?) Factory method that wraps the L.Wrapped.Polygon constructor.

Utility Methods

Method Returns Description
L.Wrapped.sign(Number number) Number Returns NaN for non-numbers, 0 for 0, -1 for negative numbers, 1 for positive numbers
L.Wrapped.calculateAntimeridianLat(LatLng latLngA, LatLng latLngB) Number Calculates the latitude at which the two points will cross the Antimeridian. Returns the latitude.
L.Wrapped.isCrossMeridian(LatLng latLngA, LatLng latLngB) boolean Returns true if the line between the two LatLngs crosses either meridian.
L.Wrapped.isBreakRing(LatLng latLngA, LatLng latLngB) boolean Returns true if the line between the two LatLngs should be broken across the meridian.

License