# tileset-thumb

**Repository Path**: mirrors_mapbox/tileset-thumb

## Basic Information

- **Project Name**: tileset-thumb
- **Description**: Generate a thumbnail from a tileset via its tilelive stream
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![travis](https://travis-ci.org/mapbox/tileset-thumb.svg?branch=master)

Maintainer: @yhahn

tileset-thumb
-------------
Pipe a tileset's [tilelive](https://github.com/mapbox/tilelive) stream into `tileset-thumb` to generate a PNG thumbnail summarizing coverage of that tileset's tiles.

Example usage:

```js
const Mbtiles = require('mbtiles');
const createThumb = require('tileset-thumb').createThumb;
const fs = require('fs');

new Mbtiles('./some.mbtiles', (err, source) => {
  if (err) throw err;
  // Create a ZXY stream from an mbtiles file
  source.createZXYStream()
    // Pipe the stream to tileset-thumb
    .pipe(createThumb({ zxy: true }))
    // Pipe the resulting PNG to a file
    .pipe(fs.createWriteStream('./some.thumb.png'));
});
```