Coverages¶

Bounding box¶

For simple box coverages.

bbox or datasource:

A simple BBOX as a list of minx, miny, maxx, maxy, e.g: [4, -30, 10, -28] or as a string 4,-30,10,-28.

Polygon file¶

Text files with one WKT polygon or multi-polygon per line. You can create your own files or use one of the files we provide for every country. Read the index to find your country.

datasource:

The path to the polygon file. Should be relative to the proxy configuration or absolute.

GeoJSON¶

You can use GeoJSON files with Polygon and MultiPolygons geometries. FeatureCollections and Features of these geometries are suppored as well. MapProxy uses OGR to read GeoJSON files if you define a where filter.

datasource:

The path to the GeoJSON file. Should be relative to the proxy configuration or absolute.

OGR datasource¶

Any polygon datasource that is supported by OGR (e.g. Shapefile, GeoJSON, PostGIS).

datasource:

The name of the datasource. Refer to the OGR format page for a list of all supported datasources. File paths should be relative to the proxy configuration or absolute.

where:

Restrict which polygons should be loaded from the datasource. Either a simple where statement (e.g. 'CNTRY_NAME="Germany"') or a full select statement. Refer to the OGR SQL support documentation. If this option is unset, the first layer from the datasource will be used.

Expire tiles¶

Text file with webmercator tile coordinates. The tiles should be in z/x/y format (e.g. 14/1283/6201), with one tile coordinate per line. Only tiles in the webmercator grid are supported (origin is always nw).

expire_tiles:

File or directory with expire tile files. Directories are loaded recursive.

Union¶

A union coverage contains the combined coverage of one or more sub-coverages. This can be used to combine multiple coverages a single source. Each sub-coverage can be of any supported type and SRS.

union:

A list of multiple coverages.

Difference¶

A difference coverage subtracts the coverage of other sub-coverages from the first coverage. This can be used to exclude parts from a coverage. Each sub-coverage can be of any supported type and SRS.

difference:

A list of multiple coverages.

Intersection¶

An intersection coverage contains only areas that are covered by all sub-coverages. This can be used to limit a larger coverage to a smaller area. Each sub-coverage can be of any supported type and SRS.

difference:

A list of multiple coverages.

sources¶

Use the coverage option to define a coverage for a WMS or tile source.

sources:
  mywms:
    type: wms
    req:
      url: http://example.com/service?
      layers: base
    coverage:
      bbox: [5, 50, 10, 55]
      srs: 'EPSG:4326'

Example of an intersection coverage with clipping:

sources:
  mywms:
    type: wms
    req:
      url: http://example.com/service?
      layers: base
    coverage:
      clip: true
      intersection:
        - bbox: [5, 50, 10, 55]
          srs: 'EPSG:4326'
        - datasource: coverage.geojson
          srs: 'EPSG:4326'

mapproxy-seed¶

To define a seed-area in the seed.yaml, add the coverage directly to the view.

coverages:
  germany:
    datasource: 'shps/world_boundaries_m.shp'
    where: 'CNTRY_NAME = "Germany"'
    srs: 'EPSG:900913'

Here is the same example with a PostGIS source:

coverages:
  germany:
    datasource: "PG: dbname='db' host='host' user='user'
  password='password'"
    where: "select * from coverages where country='germany'"
    srs: 'EPSG:900913'

And here is an example with a GeoJSON source:

coverages:
  germany:
    datasource: 'boundary.geojson'
    srs: 'EPSG:4326'

See the OGR driver list for all supported formats.