Package Exports

wmts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wmts) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WMTS

Flexible WMTS scheme for Javascript applications.

Install

npm

$ yarn add wmts

web browser (ES5)

<script src="https://unpkg.com/wmts/docs/wmts.min.js"></script>

Quickstart

const xml = wmts.getCapabilities({
  url: 'http://localhost:5000/WMTS',
  title: 'Tile Service XYZ',
  format: 'png',
})
//=xml

<declaration version="1.0" encoding="utf-8"/>
<Capabilities xmlns="http://www.opengis.net/wmts/1.0" xmlns:ows="http://www.opengis.net/ows/1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:gml="http://www.opengis.net/gml" xsi:schemaLocation="http://www.opengis.net/wmts/1.0 http://schemas.opengis.net/wmts/1.0/wmtsGetCapabilities_response.xsd" version="1.0.0">
  <ServiceMetadataURL xlink:href="http://localhost:80/WMTS/1.0.0/WMTSCapabilities.xml"/>
  <ows:ServiceIdentification>
    <ows:ServiceTypeVersion>1.0.0</ows:ServiceTypeVersion>
    <ows:ServiceType>OGC WMTS</ows:ServiceType>
...

API

getCapabilities

Get Capabilities

Parameters

options Options Options
- options.url string URL of WMTS service
- options.title string Title of service
- options.format string Format 'png' | 'jpeg' | 'jpg'
- options.minzoom number? Minimum zoom level (optional, default 0)
- options.maxzoom number? Maximum zoom level (optional, default 22)
- options.accessConstraints string? Access Constraints
- options.fees string? Fees
- options.abstract string? Abstract
- options.identifier string? Identifier
- options.keywords Array<string>? Keywords
- options.bbox BBox? BBox [west, south, east, north]
- options.spaces number? Spaces created for XML output (optional, default 2)

Examples

const xml = wmts.getCapabilities({
  url: 'http://localhost:5000/WMTS',
  title: 'Tile Service XYZ',
  identifier: 'service-123',
  abstract: '© OSM data',
  keyword: ['world', 'imagery', 'wmts'],
  format: 'png',
  minzoom: 10,
  maxzoom: 18,
  bbox: [-180, -85, 180, 85]
})

Returns string XML string