Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Smooth Proj4js integration with Leaflet.
JavaScript CSS
branch: master

This branch is 2 commits ahead, 89 commits behind kartena:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
src
test
LICENSE
README.md

README.md

Proj4Leaflet

This Leaflet plugin adds support for using projections supported by Proj4js.

For more details, see this blog post on tiling and projections.

Example

// RT90 with map's pixel origin at RT90 coordinate (0, 0)
new L.Proj.CRS('EPSG:2400',
  '+lon_0=15.808277777799999 +lat_0=0.0 +k=1.0 +x_0=1500000.0 ' +
  '+y_0=0.0 +proj=tmerc +ellps=bessel +units=m ' +
  '+towgs84=414.1,41.3,603.1,-0.855,2.141,-7.023,0 +no_defs',
  {
    resolutions: [8192, 4096, 2048], // 3 example zoom level resolutions
  }
);

// SWEREF 99 TM with map's pixel origin at (218128.7031, 6126002.9379)
new L.Proj.CRS('EPSG:3006',
  '+proj=utm +zone=33 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs',
  {
    origin: [218128.7031, 6126002.9379],
    resolutions: [8192, 4096, 2048], // 3 example zoom level resolutions
  }
);

// EPSG:102012 served by TMS with bounds (-5401501.0, 4065283.0, 4402101.0, 39905283.0)
new L.Proj.CRS.TMS('EPSG:102012',
    '+proj=lcc +lat_1=30 +lat_2=62 +lat_0=0 +lon_0=105 +x_0=0 +y_0=0 '
    + '+ellps=WGS84 +datum=WGS84 +units=m +no_defs',
    [-5401501.0, 4065283.0, 4402101.0, 39905283.0],
    {
        resolutions: [
           140000.0000000000,
            70000.0000000000,
            35000.0000000000,
            17500.0000000000
        ]
    }
);

Reference

The plugin extends Leaflet with a few classes that helps integrating Proj4's projections into Leaflet's ICRS interface.

L.Proj.CRS

An ICRS implementation that uses a Proj4 definition for the projection. This is likely to be the only class you need to work with in Proj4Leaflet.

Usage example

var map = L.map('map', {
    center: [57.74, 11.94],
    zoom: 13,
    crs: L.Proj.CRS('EPSG:2400',
      '+lon_0=15.808277777799999 +lat_0=0.0 +k=1.0 +x_0=1500000.0 ' +
      '+y_0=0.0 +proj=tmerc +ellps=bessel +units=m ' +
      '+towgs84=414.1,41.3,603.1,-0.855,2.141,-7.023,0 +no_defs',
      {
        resolutions: [8192, 4096, 2048], // 3 example zoom level resolutions
      });
    continuousWorld: true,
    worldCopyJump: false
});

Constructor

L.Proj.CRS(code, proj4def, options)
  • code is the projection's SRS code (only used internally by the Proj4js library).
  • proj4def is the Proj4 definition for the projection to use
  • options is an options object with these possible options:
    • origin: the projected coordinate to use as the map's pixel origin; overrides the transformation option if set
    • transformation: an L.Transformation that is used to transform the projected coordinates to pixel coordinates; default is L.Transformation(1, 0, -1, 0)
    • scales: an array of scales (pixels per projected coordinate unit) for each corresponding zoom level; default is to use Leaflet's native scales. You should use scales or resolutions, not both.
    • resolutions: an array of resolutions (projected coordinate units per pixel) for each corresponding zoom level; default is to use Leaflet's native resolutions. You should use scales or resolutions, not both.

L.Proj.CRS.TMS

ICRS implementation to work with a Proj4 projection that will be used together with a TMS tile server. Since TMS has its y axis in the opposite direction of Leaflet (and OpenStreetMap/Google Maps), this requires some extra work.

Note: To work with a TMS tile server and Proj4Leaflet, you must use L.Proj.TileLayerTMS instead of a standard L.TileLayer; the standard TileLayer can't handle other projections than spherical Mercator together with TMS.

Usage example

var map = new L.Map('map', {
    crs: new L.Proj.CRS.TMS('EPSG:102012',
        '+proj=lcc +lat_1=30 +lat_2=62 +lat_0=0 +lon_0=105 +x_0=0 +y_0=0 '
        + '+ellps=WGS84 +datum=WGS84 +units=m +no_defs',
        [-5401501.0, 4065283.0, 4402101.0, 39905283.0],
        {
            resolutions: [
               140000.0000000000,
                70000.0000000000,
                35000.0000000000,
                17500.0000000000
            ]
        }
    ),
    continuousWorld: true,
    worldCopyJump: false
});

Constructor

L.Proj.CRS.TMS(code, proj4def, projectedBounds, options)
  • code is the projection's SRS code (only used internally by the Proj4js library).
  • proj4def is the Proj4 definition for the projection to use
  • projectedBounds the bounds of the TMS tile grid in projected coordinates. The bounds need to be properly specified and align to the grid on all provided zoom levels, or markers and/or tiles will not align properly with the corresponding WGS84 coordinate.
  • options is an options object with the same keys as L.Proj.CRS.

L.Proj.TileLayer.TMS

Extends L.TileLayer to support TMS when working with Proj4 projections. Note that L.TileLayer will not work with other projections than EPSG:3857 if the option tms is enabled.

Usage example

var crs = new L.Proj.CRS.TMS(...),
    map = new L.Map('map', {
        crs: crs,
        continuousWorld: true,
        worldCopyJump: false
    }),

map.addLayer(new L.Proj.TileLayer.TMS('http://{s}.my-tms-server/{z}/{x}/{y}.png', crs, {
    maxZoom: 17
    ,minZoom: 0
    ,continuousWorld: true
    ,attribution: attrib
}));

Constructor

L.Proj.TileLayer.TMS(tileUrl, crs, options)
  • tileUrl is the URL template to use for tiles (see L.TileLayer)
  • crs is the L.Proj.CRS.TMS ICRS object used for this layer
  • options are the options for this layer, see L.TileLayer
Something went wrong with that request. Please try again.