QWC Legend Service

QWC Legend Service

Type: object

root $schema

JSON Schema

Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-legend-service/v2/schemas/qwc-legend-service.json"

Reference to JSON schema of this config

root service

Service name

Type: const
Specific value: "legend"

root config

Config options

Type: object

root config default_qgis_server_url
Type: string

Default base URL for forwarding WMS GetLegendGraphics requests

root config legend_default_font_size
Type: number

Default font size for GetLegendGraphic request

root config legend_images_path
Type: string

Path to legend images (required if using 'legend_image')

root resources

Resources

Type: object

root resources wms_services

WMS services

Type: array of object
No Additional Items

Each item of this array must be:

root resources wms_services WMS service

WMS service

Type: object

WMS service with nested layers and group layers

root resources wms_services WMS service name
Type: string

WMS service name

root resources wms_services WMS service root_layer

Root layer of WMS (layer or group layer)

root resources wms_services WMS service root_layer oneOf layer
Type: object

Single layer

 No Additional Properties

root resources wms_services WMS service root_layer oneOf Layer name
Type: string

WMS layer name

root resources wms_services WMS service root_layer oneOf Layer type
Type: const

Layer type

Specific value: "layer"

root resources wms_services WMS service root_layer oneOf Layer legend_image
Type: string

Legend image path relative to 'legendimagespath'

root resources wms_services WMS service root_layer oneOf Layer legend_image_base64
Type: string

Legend image in Base64 encoding
root resources wms_services WMS service root_layer oneOf group_layer
Type: object

Group layer with nested sublayers

 No Additional Properties

root resources wms_services WMS service root_layer oneOf Group Layer name
Type: string

WMS group layer name

root resources wms_services WMS service root_layer oneOf Group Layer type
Type: const

Layer type

Specific value: "layergroup"

root resources wms_services WMS service root_layer oneOf Group Layer hide_sublayers
Type: boolean

Hide sublayers of this group layer if set, to make the group layer look like a regular layer (Facade layer)

root resources wms_services WMS service root_layer oneOf Group Layer legend_image
Type: string

Legend image path relative to 'legendimagespath' (only if hide_sublayers is set)

root resources wms_services WMS service root_layer oneOf Group Layer legend_image_base64
Type: string

Legend image in Base64 encoding (only if hide_sublayers is set)