Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 5.54 KB

Documentatie.md

File metadata and controls

103 lines (71 loc) · 5.54 KB
Raw

Documentatie

Het is belangrijk bij het aanleveren van een vector tile set (download of service) om de juiste metadata beschrijvingen en bron beschrijvingen mee te geven. Dit heeft een aantal technische voordelen en tegelijkertijd ook voordelen voor het delen, vinden en hergebruiken van bronnen.

Eis: OGC API Tiles "TileSet" requirement class

_EIS_ Sluit aan bij de OGC API Tiles definitie en de **"TileSet" requirement class** endpoint.

Als de vector tiles via de OGC API Tiles standaard worden aangeboden dan is in de core een "TileSet" requirement class beschreven. Deze bevat de beschrijving van de aangeboden vector tiles set en de bron beschrijving van de vector tiles (ook raster).

The response voorziet in metadata zoals beschreven door [[OGC Two Dimensional Tile Matrix Set and Tile Set Metadata 2.0 Standard]] .

Essentiele elementen van deze metadata zijn:

  • Beschikbare Tilematrixset links
  • De URI van de TileMatrixSet
  • Het Coordinaat Referentie Systeem (een URI heeft de voorkeur).
  • Een dynamische link (URI) naar de inidividuele tiles.
  • Beschrijving van de data types (bestaat deze uit vector, coverage of map tiles).

De metadata kan aanvullende informatie bevatten als:

  • een titel
  • Beschrijving van de dataset
  • De limieten van de tilset wanneer het niet de volledige omvang van de TilMatrixSet beslaat.
  • De geodata bronnen voor het creeëren van de tiles.
  • Een schema van de beschikbare properties van de tiles.
  • De styling die gebruikt wordt
  • Het middenpunt waar een viewer initieel op kan focussen.
  • Bronvermelding (Attribution)

Requirement Class "TileSet" The tileset Requirements Class provides a mechanism to retrieve metadata for a set of tiles of geospatial data tiled according to one specific TileMatrixSet. This Class also provides a mechanism to obtain a templated link to retrieve individual tiles as defined in the core conformance class.

This Class describes the HTTP GET operation for accessing a tileset resource and its response but does not prescribe a specific path. The response provides metadata as per the OGC Two Dimensional Tile Matrix Set and Tile Set Metadata 2.0 Standard.

Minimale aanbevelingen

In deze paragraaf staan meer details voor de verschillende metadata onderdelen die men kan aanleveren bij een vector tile set.

Aanbeveling: Data lagen

_AANBEVELING_ Zorg in een JSON bestand voor een beschrijving van welke data lagen er aanwezig zijn in de vector tile set bij het onderdeel "Layers"

Aanbeveling: Overzooming

De _layer definition_ met `maxTileMatrix` en `minTileMatrix` level definitie zorgt ervoor dat de client kan overzoomen op de vector tiles. Dit houdt in dat, wanneer vector tiles niet beschikbaar zijn op een bepaald zoom level, een client de vector tiles op kan halen van een bovenliggend zoomniveau.

AANBEVELING maxTileMatrix en minTileMatrix definiËren in de data lagen beschrijving.

Aanbeveling: Data Attributen

_AANBEVELING_ Geef aan welke attributen (`properties`) er beschikbaar zijn per data laag.

Aanbeveling: Bron annotatie

_AANBEVELING_ Een JSON bestand kan de bronhouder bevatten, wat soms gewenst of vereist is om op te nemen in een applicatie. Zoals mogelijke copyright annotatie. Gebruik hiervoor 'Attribution'.

Optioneel kan ook een TileJSON worden toegevoegd.

_AANBEVELING_ Lever een TileJSON document aan bij een vector tile set.

In TILEJSON:

Aanbeveling: Data lagen TileJSON

_AANBEVELING_ Zorg in een TileJSON bestand voor een beschrijving van welke data lagen er aanwezig zijn in de vector tile set bij het onderdeel `"Vector Layers"`

Aanbeveling: Overzooming TileJSON

Eén van de voordelen van het gebruik van een TileJSON bestand voor vector tiles is zogenaamde overzooming op lagen.

De layer definition met minzoom en maxzoom level definitie zorgt ervoor dat de client kan overzoomen op de vector tiles. Dit houdt in dat, wanneer vector tiles niet beschikbaar zijn op een bepaald zoom level, een client de vector tiles op kan halen van een bovenliggend zoomniveau.

_AANBEVELING_ `minzoom` en `maxzoom` definiëren in de data lagen beschrijving.

Aanbeveling: Data Attributen TileJSON

_AANBEVELING_ Geef aan welke attributen (`fields`) er beschikbaar zijn per data laag. Een TileJSON bestand bevat verder geen beschrijving van de attributen die beschikbaar zijn per data laag. Wij bevelen aan deze beschrijving los te documenteren of op te nemen als `additionalProperties` of `description` in de data laag beschrijving.

Aanbeveling: Bron annotatie TileJSON

Een TileJSON bestand kan de bronhouder bevatten, wat soms gewenst of vereist is om op te nemen in een applicatie. Zoals mogelijke copyright annotatie.

_AANBEVELING_ Geef de bron `attribution` op in een TileJSON bestand, zodat deze zichtbaar is als annotatie op de kaart in de client.

API design rules Nederlandse Overheid

Verder raden wij aan ook te kijken naar de [[API-Designrules]] voor de Nederlandse overheid. Deze bevatten principes voor het aanbieden van APIs door Nederlandse overheidsorganisaties.

AANBEVELING Volg de aanbevelingen over documentatie uit de [[API-Designrules]] voor de Nederlandse overheid: https://docs.geostandaarden.nl/api/API-Designrules/#documentation