pmtiles 2.0.0

A library for parsing Protomaps PMTiles files. A single file archive format for storing raster or vector map tiles.

pmtiles

by Andrew Brampton (bramp.net)

Read PMTiles v3 archives stored locally or remotely.

GitHub | Package | API Docs

Usage

import 'package:pmtiles/pmtiles.dart';

/// A simple example of reading a PmTiles archive.
Future<int> main() async {
  // Open the archive from a file. HTTP URLs are also acceptable.
  final archive = await PmTilesArchive.from("/path/to/file.pmtiles");
  try {
    // # Metadata
    // Information about the archive is available in the header and metadata.
    print("Header:");
    print(archive.header);

    // Some interesting fields are also on the main tiles archive object.
    print("Type: ${archive.tileType}"); // e.g  mvt, png, jpg, etc.
    print("Compression: ${archive.tileCompression}"); // e.g gzip, brotli, etc.

    // The metadata is a embedded JSON object, as described here:
    // https://github.com/protomaps/PMTiles/blob/main/spec/v3/spec.md#5-json-metadata
    print("Metadata:");
    final prettyJson = JsonEncoder.withIndent('  ') // for clarity pretty print
        .convert(await archive.metadata);
    print(prettyJson);

    // # Tiles
    // To extract a tiles from the archive, you index them by a tile ID (which
    // can be converted to/from a ZXY coordinate).
    final int tileId = ZXY(4, 3, 2).toTileId();

    // To extract a single tile:
    final Tile t = await archive.tile(tileId);
    t.type; // e.g. mvt, png, jpg, etc.

    // The uncompressed bytes of the tile is available as a List<int>.
    t.bytes();

    // Equally if the tile is going to be reserved, you may leave it compressed
    // in the format that was used in the archive. See tiles.tileCompression above.
    t.compressedBytes();

    // To extract multiple tiles:
    final tiles = archive.tiles([tileId, tileId + 1, tileId + 2]);

    // This returns a Stream<Tiles> and Tiles will be returned as they become
    // available from the archive. This is optimised to reduce the requests
    // to the archive's backing store, leading to faster extraction.
    await for (final tile in tiles) {
      print("${tile.id} is available");

      // Again the bytes are available via:
      tile.bytes();
    }
  } finally {
    // Don't forget the close the archive once you are done.
    await archive.close();
  }

  return 0;
}

Support Matrix

Some effort has been made to ensure this library works correctly on the native Dart VM, as well as when dart2js is used to compiled to JavaScript (e.g. for use with Node.js or Chrome). The following table shows the support matrix.

Feature	Dart VM	Node.js	Browsers (e.g Chrome)
	Native	dart2js	dart2js
File	Yes	No	No
HTTP	Yes	No	Yes

If the library is used in an UnsupportedError exception will be thrown.

Development

This project uses Dart workspaces and a Makefile for common tasks.

Setup

dart pub get           # Install dependencies for all packages
npm install http-server # Needed for integration tests

The integration tests also require the official pmtiles CLI to be installed.

Common commands

Command	Description
make all	Format, analyze, and run all tests
make format	Format all Dart code
make analyze	Run the Dart analyzer across all packages
make test	Run all tests (dart, flutter, node, chrome)
make test-dart	Run native Dart VM tests
make test-flutter	Run Flutter tests
make test-node	Run Node.js tests (dart2js)
make test-chrome	Run Chrome tests (dart2js)
make fix	Apply auto-fixes
make clean	Delete build artifacts

Packages

The repository is broken up into three packages:

• pmtiles — the core library, published to pub.dev.

• pmtiles_cli — a simple command line tool, mainly used for testing. Not published to pub.dev.

• pmtiles_tests — integration tests and sample files. Kept separate from pmtiles so the published library remains small.

Publishing

To publish a new version to pub.dev:

1. Update the version in packages/pmtiles/pubspec.yaml.
2. Update packages/pmtiles/CHANGELOG.md.
3. Verify the package is ready to publish:

   cd packages/pmtiles && dart pub publish --dry-run
   

4. Commit and push to main.
5. Tag the commit and push the tag:

   git tag pmtiles-v<version>
   git push origin pmtiles-v<version>
   

Pushing a tag matching pmtiles-v* triggers the publish workflow, which automatically publishes to pub.dev via OIDC.

Additional information

The specification is here https://github.com/protomaps/PMTiles/tree/main/spec/v3

LICENSE

BSD 2-Clause License

Copyright (c) 2023-2024, Andrew Brampton

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.