mirrors/PMTiles
1
0
Fork 0
mirror of https://github.com/protomaps/PMTiles.git synced 2026-02-04 02:41:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #201 from protomaps/spec-metadata-optional-keys

Browse Source 
Spec: more optional metadata keys that might be read by viewers
This commit is contained in:
Brandon Liu
2023-06-22 14:22:56 +08:00
committed by GitHub
parent 77e6d96aad 005eba513e
commit d718ad1fe4
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
spec/v3/spec.md
View File

@@ -97,6 +97,14 @@ The `Header` is 127 bytes, with little-endian integer values:
The JSON metadata is designed to contain arbitrary, application-specific data. However, if the `TileType` is `mvt`, the metadata should contain `vector_layers` as described in the [TileJSON 3.0 spec](https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#1-purpose).
Other optional keys that may, by convention, be read by viewers (all values should be strings):
* `name`
* `description`
* `attribution`
* `type`: `overlay` or `baselayer`
* `version`, a revision of the tileset e.g. `1.0.0`
### Organization
In most cases, the archive should be in the order `Header`, Root Directory, JSON Metadata, Leaf Directories, Tile Data. It is possible to relocate sections other than `Header` arbitrarily, but no current writers/readers take advantage of this. A future design may allow for reverse-ordered archives to enable single-pass writing.