Document YAML configuration for sources

[Phocacius]

Currently, there is only documentation available for elements in YAML, not for sources.

WMS

• type: must be wms
• title: The source title as displayed in the layer tree
• version: WMS version (default: 1.1.1)
• url: URL to the service's Get capabilities XML
• format: Mime type for the image format requested (default: image/png)
• info_format: Mime type for the feature info format (default: text/html)
• proxy: Bool value whether the service should be proxied (default: false)
• tiled: Bool value whether the wms data should be requests as tiles (default: false)
• layerorder: "standard" or "reverse" (the latter is used mainly for QGIS Server). (default: parameter wms.default_layer_order which again defaults to "standard")
• isBaseSource: boolean value if the source should be treated as a base source
• transparent: boolean value whether the TRANSPARENT flag should be set (default: true)
• opacity: int 0 (fully transparent)-100 (fully opaque) (default: 100)
• visible: initial selected state of the root layer. (default: true)
• toggle: initial folder state of the root layer in the layer tree (default: true = folder is expanded)
• allowToggle: can the user collapse/expand the root layer? (default: true)
• minScale: minimum scale (1:x) where the root layer is displayed (default: unset)
• maxScale: maximum scale (1:x) where the root layer is displayed (default: unset)
• legendurl: url for the root layer's legend
• layers: optional object to modify individual sublayers. The key is arbitrary, but should be unique. The value is an object with the following settings:
  • name The layer's name, as in the <Name> tag of the layer within the GetCapabilities XML
  • title : The layer title as displayed in the layer tree
  • visible: initial selected state of the layer. (default: true)
  • toggle: initial folder state of the layer in the layer tree (default: false = folder is collapsed)
  • allowToggle: can the user collapse/expand the layer? (default: true)
  • minScale: minimum scale (1:x) where this layer is displayed (default: unset)
  • maxScale: maximum scale (1:x) where this layer is displayed (default: unset)
  • legendurl: url for this layer's legend
  • layers: sublayers, array with the same structure as the layers on the top level

WMTS

The fields available for WMTS are already documented in the github PR.

Vector Tiles

• type: must be vector_tiles
• title: The source title as displayed in the layer tree
• jsonUrl: URL to the Mapbox Style Spec JSON file
• basesource (alias: isBaseSource): boolean value if the source should be treated as a base source
• opacity: int 0 (fully transparent)-100 (fully opaque) (default: 100)
• selected (alias: visible): initial selected state of the layer. (default: true)
• allowSelected: can the user change the selected state? (default: true)
• toggle: initial folder state of the root layer in the layer tree (default: true = folder is expanded)
• allowToggle: can the user collapse/expand the root layer? (default: true)
• minScale: minimum scale (1:x) where the source is displayed (default: unset)
• maxScale: maximum scale (1:x) where the source is displayed (default: unset)
• featureInfo: is featureinfo enabled by default? (default: true)
• featureInfoAllowToggle: can the user toggle the feature info state? (default: true)
• featureInfoPropertyMap: If not empty, only the specified properties will be displayed in the feature info. Specify as YAML array. The key is the name of the field, the optional value is the translation. Example:

- class
- name
- layer: Layer name

• hideIfNoTitle: Hide features with empty title in the featureInfo (default: true)
• featureInfoTitle: Property/Properties of the feature that is/are displayed as title above the table. ${property} will be replaced by the property's value. If not specified, the first non-empty value from "label", "name", and "title" will be used.
• printScaleCorrection: Resolution correction for printing. Default value is 1.0. Higher values result in more details and smaller labels; lower values in less details and larger labels.
• legendEnabled (alias: legend): should a legend be displayed for this source? (default: false)
• legendPropertyMap: If not empty, only the specified layers will be shown in the legend. Specify as a YAML array. The key is the layer ID from the "layers" field in the style JSON; the optional value is the translation. Example:

- City
- Stations
- Transport: Public Transport

• bbox: Bounding box (array xmin, ymin, xmax, ymax) for the source