# Leaflet.functionaltilelayer

**Repository Path**: opengis-leaflet/Leaflet.functionaltilelayer

## Basic Information

- **Project Name**: Leaflet.functionaltilelayer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: gh-pages
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-30
- **Last Updated**: 2021-06-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Leaflet.functionaltilelayer
===========================

Leaflet tile layer with functionally defined URL and support for promises.

A typical use case is fetching tiles asynchronously, with an ajax request or 
IndexedDB query.

> This project is looking for a maintainer. Interested? Open an issue.

## Usage
Use it like any other tile layer, but instead of providing a `urlTemplate` as 
the first argument, provide a function. The function should return either the 
tile URL as a string, or a promise which resolves to a string.

```javascript
var funcLayer = new L.TileLayer.Functional(function (view) {
    var url = 'http://otile{3}.mqcdn.com/tiles/1.0.0/map/{0}/{1}/{2}.jpg'
        .replace('{0}', view.zoom)
        .replace('{1}', view.tile.row)
        .replace('{2}', view.tile.column)
        .replace('{3}', view.subdomain);
    
    return url;
});
```

The function is given a view object with the following properties:

```javascript
view = {
  bbox,
  width,
  height,
  zoom,
  tile: {
    row,
    column
  },
  subdomain
};
```

For an example of the code above, see the [basic example]
(http://ismyrnow.github.com/Leaflet.functionaltilelayer/example/basic.html).

For an example of using promises, see the [promise example]
(http://ismyrnow.github.com/Leaflet.functionaltilelayer/example/promise.html).

## Thanks

Thanks to @ryanttb and [jQuery Geo](http://jquerygeo.com/)'s service objects, 
which were the inspiration for this plugin.

## License

Leaflet.functionaltilelayer is free software, and may be redistributed under 
the MIT-LICENSE.