# leaflet-tilejson

**Repository Path**: opengis-leaflet/leaflet-tilejson

## Basic Information

- **Project Name**: leaflet-tilejson
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-27
- **Last Updated**: 2024-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# leaflet-tilejson [![NPM version](https://badge.fury.io/js/leaflet-tilejson.png)](http://badge.fury.io/js/leaflet-tilejson)

leaflet-tilejson adds support for the 
[TileJSON](https://github.com/mapbox/tilejson-spec) specification 
to the [Leaflet](http://leafletjs.com) map client.

For extra fun and possibility of future profit, leaflet-tilejson 
also supports an 
[extension to the TileJSON specification](https://github.com/perliedman/TileJSON/tree/master/2.0.0), 
which allows other projections than spherical-mercator. This 
extension requires [Proj4Leaflet](https://github.com/kartena/Proj4Leaflet)
and [Proj4js](http://proj4js.org) as extra dependencies.

## Example

```javascript
var osmTileJSON = {
    "tilejson": "2.0.0",
    "name": "OpenStreetMap",
    "description": "A free editable map of the whole world.",
    "version": "1.0.0",
    "attribution": "© OpenStreetMap contributors, CC-BY-SA",
    "scheme": "xyz",
    "tiles": [
        "http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
    ],
    "subdomains": ["a","b","c"],
    "minzoom": 0,
    "maxzoom": 18,
    "bounds": [ -180, -85, 180, 85 ],
    "center": [ 11.9, 57.7, 8 ]
};

var map = L.TileJSON.createMap('map', osmTileJSON);
```

## Limitations

This is, as everything else, a work in progress. Current known limitations are:

 * No support for UTFGrid interaction. Mostly because Leaflet does not currently support UTFGrid.
 * Only the first tile URL specified is used. The method for specifying this in the TileJSON 
   specification and in Leaflet differs in ways that makes it hard to implement in the general case.
 * When using {s}, provide non-default subdomains (Leaflet defaults are abc) as a string or array. This is not in the TileJSON spec, and is only available here due to the previously mentioned limitation.