# slippy-grid > Generates an iterator of TMS tiles from BBox or GeoJSON Latest version **2.3.0** (published 2017-10-24) · MIT license · 0 weekly downloads ## Install ```sh npm install slippy-grid pnpm add slippy-grid yarn add slippy-grid bun add slippy-grid ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.3.0 | | Published | 2017-10-24 | | First published | 2017-02-18 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 5 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 8 | | Author | Denis Carriere | | Maintainers | deniscarriere | | Keywords | gis, geo, geojs, geospatial, geography, geometry, extent, geojson, tile, slippy, map, bbox | ## Links - npm: https://www.npmjs.com/package/slippy-grid - Repository: https://github.com/DenisCarriere/slippy-grid - Homepage: https://github.com/DenisCarriere/slippy-grid#readme - Issues: https://github.com/DenisCarriere/slippy-grid/issues - npm.io page: https://npm.io/package/slippy-grid ## Dependencies (5) - [@turf/bbox](https://npm.io/package/@turf/bbox.md) * - [@turf/meta](https://npm.io/package/@turf/meta.md) * - [@turf/helpers](https://npm.io/package/@turf/helpers.md) * - [global-mercator](https://npm.io/package/global-mercator.md) * - [@mapbox/tile-cover](https://npm.io/package/@mapbox/tile-cover.md) * ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 2.3.0 (latest) — 2017-10-24 - 2.2.1 — 2017-10-24 - 2.2.0 — 2017-10-24 - 2.1.1 — 2017-03-30 - 2.1.0 — 2017-03-20 - 2.0.2 — 2017-03-20 - 2.0.1 — 2017-03-20 - 2.0.0 — 2017-03-13 - 1.2.6 — 2017-03-06 - 1.2.5 — 2017-03-05 - 1.2.4 — 2017-03-05 - 1.2.3 — 2017-03-05 - 1.2.2 — 2017-03-02 - 1.2.1 — 2017-03-02 - 1.2.0 — 2017-02-22 - … 5 more at https://npm.io/package/slippy-grid/versions ## README # Slippy Grid [![Build Status](https://travis-ci.org/DenisCarriere/slippy-grid.svg?branch=master)](https://travis-ci.org/DenisCarriere/slippy-grid) [![npm version](https://badge.fury.io/js/slippy-grid.svg)](https://badge.fury.io/js/slippy-grid) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/DenisCarriere/slippy-grid/master/LICENSE) [![Standard - JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) Create slippy tile grid iterators from BBox. ## Install **npm** ```bash $ npm install --save slippy-grid ``` **web browser [ES6](https://kangax.github.io/compat-table/es6)** ```html ``` ## API #### Table of Contents - [single](#single) - [geojson](#geojson) - [getChildren](#getchildren) - [all](#all) - [bulk](#bulk) - [levels](#levels) - [count](#count) ### single Creates an Iterator of Tiles from a given BBox **Parameters** - `extent` **(BBox | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<BBox> | GeoJSON)** BBox [west, south, east, north] order or GeoJSON Polygon - `minZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Minimum Zoom - `maxZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum Zoom **Examples** ```javascript const grid = slippyGrid.single([-180.0, -90.0, 180, 90], 3, 8) const {value, done} = grid.next() //=value [x, y, z] //=done true/false ``` Returns **Iterator<Tile>** Iterable Grid of Tiles from extent ### geojson Creates an Iterator of Tiles from a given GeoJSON **Parameters** - `extent` **FeatureCollection<(Polygon | MultiPolygon)>** GeoJSON Polygon(s) - `minZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Minimum Zoom - `maxZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum Zoom **Examples** ```javascript const grid = slippyGrid.geojson(poly, 3, 8) const {value, done} = grid.next() // value => [x, y, z] // done => true/false ``` Returns **Iterator<Tile>** Iterable Grid of Tiles from GeoJSON ### getChildren Creates an Iterator of children Tiles from a given parent tile **Parameters** - `parentTile` **GeoJSON** Tile - `maxZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum Zoom **Examples** ```javascript const parentTile = [0, 572, 10] const maxZoom = 12 const grid = slippyGrid.getChildren(parentTile, maxZoom) const {value, done} = grid.next() // value => [x, y, z] // done => true/false ``` Returns **Iterator<Tile>** Iterable of Tiles ### all All Tiles from a given BBox **Parameters** - `extent` **(BBox | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<BBox> | GeoJSON)** BBox [west, south, east, north] order or GeoJSON Polygon - `minZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Minimum Zoom - `maxZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum Zoom **Examples** ```javascript const tiles = slippyGrid.all([-180.0, -90.0, 180, 90], 3, 8) //=tiles ``` Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<Tile>** Tiles from extent ### bulk Creates a bulk Iterator of Tiles from a given BBox **Parameters** - `extent` **(BBox | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<BBox> | GeoJSON)** BBox [west, south, east, north] order or GeoJSON Polygon - `minZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Minimum Zoom - `maxZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum Zoom - `size` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum size for bulk Tiles **Examples** ```javascript const grid = slippyGrid.bulk([-180.0, -90.0, 180, 90], 3, 8, 5000) const {value, done} = grid.next() //=value Array<[x, y, z]> //=done true/false ``` Returns **Iterator<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<Tile>>** Bulk Iterable Grid of Tiles from extent ### levels Creates a grid level pattern of arrays **Parameters** - `extent` **(BBox | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<BBox> | GeoJSON)** BBox [west, south, east, north] order or GeoJSON Polygon - `minZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Minimum Zoom - `maxZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum Zoom **Examples** ```javascript const levels = slippyGrid.levels([-180.0, -90.0, 180, 90], 3, 8) //=levels ``` Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<GridLevel>** Grid Level ### count Counts the total amount of tiles from a given BBox **Parameters** - `extent` **(BBox | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<BBox> | GeoJSON)** BBox [west, south, east, north] order or GeoJSON Polygon - `minZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Minimum Zoom - `maxZoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum Zoom - `quick` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Enable quick count if greater than number (optional, default `1000`) **Examples** ```javascript const count = slippyGrid.count([-180.0, -90.0, 180, 90], 3, 8) //=count 563136 ``` Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total tiles from BBox --- _Source: https://npm.io/package/slippy-grid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._