Skip to content

XMLConfigReference

Jump to bottom
Bush Luo edited this page Apr 4, 2018 · 40 revisions

Mapnik configuration XML

See also a reference PDF created by David Eastcott (written for 0.7)

General

Comments can be placed in the file using the default xml <!-- --> syntax

Basic usage: a Map consists of Styles defined in Rules, and Layers apply those Styles by name to Datasources such as a Shapefile:

<Map background-color="white" srs="+proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 +x_0=400000 +y_0=-100000 +ellps=airy +towgs84=446.448,-125.157,542.06,0.1502,0.247,0.8421,-20.4894 +units=m +no_defs">
  <Style name="TidalWater_FullColour">
    <Rule>
      <MinScaleDenominator>1000</MinScaleDenominator>
      <MaxScaleDenominator>25000</MaxScaleDenominator>
      <PolygonSymbolizer fill="#D5F4F8"/>
    </Rule>
  </Style>
  <Layer>
    <StyleName>TidalWater_FullColour</StyleName>
    <Datasource>
      <Parameter name="file">./OS-VectorMap-District/st/ST_TidalWater.shp</Parameter>
      <Parameter name="type">shape</Parameter>
    </Datasource>
  </Layer>
</Map>

<Map>

  • Element type: The master object of a Mapnik configuration XML. Has map-wide parameters and serves as the container for Styles and Layers.

  • Attributes (in alphabetical order):

    • "background-color"= HTML color code for the background-color of the map (for instance #000000)
      • was "bg-color"= prior to Mapnik2.
      • Opacity is controlled by the last two digits of an 8-digit value. #00000000 means transparent background. The default value is #000000FF.
    • "background-image"= Available in Mapnik2: use an image for the background instead of a color fill.
    • "buffer-size"= Default 0; Good value is usually tile size/2 to help avoid cut labels. This influences envelope used by placement detector ( i.e. 'avoid_edges' parameter). Also set maximum-extent, otherwise you will get problems for bboxes near the borders of your map.
    • "font-directory"= Available in Mapnik2: pass a directory that contains fonts, which will automatically be registered if they end in ttf, otf, ttc, pfa, pfb, ttc, or dfont.
    • "maximum-extent"= Set to maximum extent of (projected) map, ie. in coordinates of result map. For instance "-20037508.34, -20037508.34, 20037508.34, 20037508.34". See also BoundsClipping.
    • "minimum-version"= Declare the minimum version of mapnik to be used with the stylesheet. Example: minimum-version="0.6.1". Will print a notice if you use an older mapnik version.
    • "paths-from-xml"= Check if relative paths should be interpreted as relative to/from XML location (default is true)
    • "srs"= Coordinate system in which the map is rendered (for instance '+proj=latlong+datum=WGS84' for a WGS84 Geographic coordinate system)

  • Children:

    • <Datasource> See also 37f49e2

    • <FileSource>: See 37f49e2

    • <FontSet>: Defines a fontset for fallback fonts (if a character isn't found in the first font, proceed through the list until it is found)

    • <Include>: The container tag used to wrap all context in files included via XInclude

    • <Layer>

    • <Style>

    • xmlcomment: (Ignored by Mapnik)

    • xmlattr: (Ignored by Mapnik)

<Style>

  • Element type: Collection of Rules. Defines the way objects are rendered. A Mapnik configuration file can have an unlimited number of Style objects. Referenced by Layer objects to render geodata.
  • Attributes:
    • "filter-mode"= Whether all rules in the Style should be evaluated (default) or if rendering should stop after the first matching rule. See #706
    • "name"= Name for this Style object. Needs to be unique per configuration file. A Style is referenced by a Layer through the corresponding StyleName parameter. If a name is ommited, what will happen?
    • "opacity"= Style level opacity: 1 is fully opaque while zero is fully transparent and .5 would be 50% transparent. See #314
  • Children:
    • <Rule>
    • xmlcomment: (Ignored by Mapnik)
    • xmlattr: (Ignored by Mapnik)

<Rule>

See SymbologySupport for more info on Symbolizers

v.0.7.1: Please note that some Symbolizers require attributes while others require -elements. Refer to the examples given on the individual pages for the correct syntax. This has been updated in Mapnik 2.0

<Layer>

  • Element type: Applies a Style (StyleName) to a DataSource
  • Attributes:
    • "abstract"= Default ""
    • "cache-features"= Default "off". Setting this to "on" triggers mapnik to attempt to cache features in memory for rendering when (and only when) a layer has multiple styles attached to it. (only available in >mapnik 2 since r2636).
    • "clear-label-cache"= Default "off". Setting this to "on" clears the internal placement detector list, causing the items of this layer, and from this layer on, to be rendered without taking previous rendered items into account ('clear collision avoidance list')
    • "minzoom"= Default 0.0
    • "maxzoom"= Default 1.797693134862316e+308
    • "name"= The name of the layer
    • "srs"= Default inherits from Map.srs; Reference system from the the project Proj.4. e.g. +proj=latlong +datum=WGS84
    • "status"= Default "on"; on or off, "0" or "1"
    • "title"= Default ""
    • "queryable"= Default "false"
  • Children:
    • <Datasource>: The geodata to be rendered.
    • <StyleName>: The name of a defined Style. Must contain the exact same string as in the attribute Style.name.

<Datasource>

  • Element type: References the map data source and parameters.
  • Attributes:
    • "name"= Create a datasource template (37f49e2)
    • "base"= Inherit from a datasource template (37f49e2)
    • Generic Parameters:
      • "type"= The format of the data source
        • Possible values:
          • '''shape''' : ESRI shapefile
          • '''postgis''' : Postgis table or query
          • '''pgraster''' : Postgis table or query (containing or returning raster)
          • '''raster''' : Tiled or stripped TIFF
          • '''gdal''' : GDAL supported raster dataset (not build by default)
          • '''ogr''' : OGR supported vector datasource (not build by default)
          • '''osm''' : OpenStreetMap (not build by default)
      • "estimate_extent"= boolean to tell Mapnik to estimate the extent of the layer (true) or not (false)
      • "extent"= manually enter an extent if estimate_extent is set to false
    • Additional parameters for type postgis see: Parameters on the PostGIS page.
    • Additional parameters for type pgraster see: Parameters on the PgRaster page.
    • Additional parameters for type shape see ShapeFile
    • Additional parameters for type gdal see GDAL.
    • Additional parameters for type ogr see OGR.
    • Additional parameters for type osm see OsmPlugin

See also the Python API docs

<Include>

  • Element type: Provides a container for included XML. Should be used only in included files as the outermost tag.
  • Attributes - None
  • Children:
    • <Style>
    • <Layer>
    • <FileSource>
    • <Datasource> See Datasource
    • <FontSet> Defines a fontset for fallback fonts (if a character isn't found in the first font, proceed through the list until it is found)
Clone this wiki locally