Skip to content

Document new WMS Server features #11109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hefniraera wants to merge 2 commits into
base: master
Choose a base branch
from
+70 −0
Open

Document new WMS Server features #11109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c35f4e3
Document new WMS Server features for QGIS 4.2
hefniraera Jul 14, 2026
130aef3
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/server_manual/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1042,6 +1042,11 @@ To configure metadata for a group of layers:
* a :guilabel:`Metadata URL`: the URL of a metadata document for the layer group.
* a :guilabel:`Legend URL`: the URL of a legend image for the layer group.

#. :guilabel:`Group request mode` controls the visibility of child layers in WMS.
The default value is :guilabel:`Normal`, where child layers are listed and
can be requested individually. If set to :guilabel:`Opaque`, child layers are
hidden and cannot be requested directly, but are still rendered when the
group is requested.
#. Optionally, you can check |checkbox| :guilabel:`Compute TIME dimension from children`
to have QGIS Server compute the TIME dimension for the group
based on the TIME dimensions of its child layers.
Expand Down
Binary file modified docs/server_manual/services/img/server_redlining.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 65 additions & 0 deletions docs/server_manual/services/wms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,55 @@ Available values are:
- ``application/vnd.ogc.gml``
- ``application/json``

When using ``application/vnd.ogc.gml``, NULL field values responses are
returned as ``xsi:nil="true"``.

When using ``application/json`` as the ``INFO_FORMAT`` value, the response
follows the `JSON-FG <https://docs.ogc.org/DRAFTS/21-045.html>`_ specification.
Each feature in the response includes a ``featureType`` member indicating
the name of the source layer:

.. code-block:: json

{
"type": "FeatureCollection",
"features": [
{
"featureType": "continents",
"type": "Feature",
"id": "continents.1646",
"geometry": null,
"properties": {
"NAME_0": "Czech Republic",
"NAME_1": "Stredocesky"
}
}
]
}

If the request targets a layer group instead of an individual layer, an
additional ``qgis:requestedWmsName`` member is included, indicating the
name of the requested group:

.. code-block:: json

{
"type": "FeatureCollection",
"features": [
{
"featureType": "continents",
"qgis:requestedWmsName": "grouptest",
"type": "Feature",
"id": "continents.1646",
"geometry": null,
"properties": {
"NAME_0": "Czech Republic",
"NAME_1": "Stredocesky"
}
}
]
}

.. _wms_querylayers:

QUERY_LAYERS
Expand Down Expand Up @@ -2089,6 +2138,10 @@ The :ref:`GetMap <wms_getmap>` request is in the format:
&HIGHLIGHT_LABELCOLOR=%23000000
&HIGHLIGHT_LABELBUFFERCOLOR=%23FFFFFF
&HIGHLIGHT_LABELBUFFERSIZE=1.5
&HIGHLIGHT_LABELFRAMEBACKGROUNDCOLOR=%23FFFF00
&HIGHLIGHT_LABELFRAMEOUTLINECOLOR=%23FF0000
&HIGHLIGHT_LABELFRAMEOUTLINEWIDTH=2
&HIGHLIGHT_LABELFRAMESIZE=5


The :ref:`GetPrint <wms_getprint>` equivalent is in the format (note that
Expand All @@ -2107,6 +2160,10 @@ The :ref:`GetPrint <wms_getprint>` equivalent is in the format (note that
&map0:HIGHLIGHT_LABELCOLOR=%23000000
&map0:HIGHLIGHT_LABELBUFFERCOLOR=%23FFFFFF
&map0:HIGHLIGHT_LABELBUFFERSIZE=1.5
&map0:HIGHLIGHT_LABELFRAMEBACKGROUNDCOLOR=%23FFFF00
&map0:HIGHLIGHT_LABELFRAMEOUTLINECOLOR=%23FF0000
&map0:HIGHLIGHT_LABELFRAMEOUTLINEWIDTH=2
&map0:HIGHLIGHT_LABELFRAMESIZE=5

Here is the image outputted by the above request in which a polygon and
a label are drawn on top of the normal map:
Expand Down Expand Up @@ -2134,6 +2191,14 @@ the redlining feature. The full list includes:
(e.g. point or line) and the label in mm
* **HIGHLIGHT_LABELFONT**: This parameter controls the font of the
label (e.g. Arial)
* **HIGHLIGHT_LABELFRAMEBACKGROUNDCOLOR**: This parameter controls the
background color of the label frame.
* **HIGHLIGHT_LABELFRAMEOUTLINECOLOR**: This parameter controls the
outline color of the label frame.
* **HIGHLIGHT_LABELFRAMEOUTLINEWIDTH**: This parameter controls the
outline width of the label frame.
* **HIGHLIGHT_LABELFRAMESIZE**: This parameter controls the size of
the label frame. A frame is only drawn if the value is greater than ``0``.
* **HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT**: places the label horizontally
on a point using the specified alignment (e.g. 'left', 'center', 'right')
* **HIGHLIGHT_LABEL_ROTATION**: controls the label rotation in degrees
Expand Down
Loading