<title>QWC Legend Service</title>

QWC Legend Service

Type: object

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

Service name

Type: const
Specific value: "legend"

Config options

Type: object

Type: string

Default base URL for forwarding WMS GetLegendGraphics requests. Default: http://localhost:8001/ows/

Type: number

Default font size for GetLegendGraphic request. Default: null

Type: string

Path to legend images (required if using legend_image). Default: /legends/

Type: array of string

Login verification URL for requests with basic auth. Example: http://qwc-auth-service:9090/verify_login. Default: null

No Additional Items

Each item of this array must be:

Resources

Type: object

WMS services

Type: array of object
No Additional Items

Each item of this array must be:

WMS service

Type: object

WMS service with nested layers and group layers

Type: string

WMS service name


Root layer of WMS (layer or group layer)

Layer

Type: object

Single layer

No Additional Properties

Type: string

WMS layer name

Type: const

Layer type

Specific value: "layer"

Type: string

Legend image path relative to 'legendimagespath'

Type: string

Legend image in Base64 encoding

Group Layer

Type: object

Group layer with nested sublayers

No Additional Properties

Type: string

WMS group layer name

Type: const

Layer type

Specific value: "layergroup"

Type: array

Sublayers of this group layer (layers or group layers)

No Additional Items

Each item of this array must be:

Type: boolean

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

Type: string

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

Type: string

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