Skip to content

mapbox/tile-cover

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

tile-cover

Build Status

Generate the minimum number of tiles to cover a GeoJSON Geometry.

Install

npm install @mapbox/tile-cover

Usage

var cover = require('@mapbox/tile-cover');
var poly = JSON.parse(fs.readFileSync('./poly.geojson'));
var limits = {
  	min_zoom: 4,
  	max_zoom: 9
};

cover.geojson(poly.geom, limits);
cover.tiles(poly.geom, limits);
cover.indexes(poly.geom, limits);

API

geojson(geom, limits)

Given a geometry, create cells and return them in a format easily readable by any software that reads GeoJSON.

  • geom (Object): GeoJSON geometry
  • limits (Object): an object with min_zoom and max_zoom properties specifying the minimum and maximum level to be tiled.

Returns Object, FeatureCollection of cells formatted as GeoJSON Features

tiles(geom, limits)

Given a geometry, create cells and return them in their raw form, as an array of cell identifiers.

  • geom (Object): GeoJSON geometry
  • limits (Object): an object with min_zoom and max_zoom properties specifying the minimum and maximum level to be tiled.

Returns Array.<Array.<number>>, An array of tiles given as [x, y, z] arrays

indexes(geom, limits)

Given a geometry, create cells and return them as quadkey indexes.

  • geom (Object): GeoJSON geometry
  • limits (Object): an object with min_zoom and max_zoom properties specifying the minimum and maximum level to be tiled.

Returns Array.<String>, An array of tiles given as quadkeys.

Tests

npm test

Benchmarks

node bench.js

Examples

Polygons:

img

Lines:

img

Points:

img

About

Generate the minimum number of tiles to cover a geojson geometry

Resources

License

Stars

Watchers

Forks

Packages

No packages published