Class Protocol

constructor

• new Protocol(options?): Protocol

• Initialize the MapLibre PMTiles protocol.

  • metadata: also load the metadata section of the PMTiles. required for some "inspect" functionality and to automatically populate the map attribution. Requires an extra HTTP request.

  Parameters

  • Optional options: {
        metadata: boolean;
    }

    • metadata: boolean

  Returns Protocol

metadata

tile

add

• add(p): void

• Add a PMTiles instance to the global protocol instance.

  For remote fetch sources, references in MapLibre styles like pmtiles://http://... will resolve to the same instance if the URLs match.

  Parameters

  • p: PMTiles

  Returns void

get

• get(url): undefined | PMTiles

• Fetch a PMTiles instance by URL, for remote PMTiles instances.

  Parameters

  • url: string

  Returns undefined | PMTiles