Skip to content

Commit 0290522

Browse files
manisandromanisandro
committed
More sorting
1 parent be95c8f commit 0290522

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

‎src/configuration/ThemesConfiguration.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -130,34 +130,34 @@ Refer to the [sample `themesConfig.json`](https://github.com/qwc-services/qwc-do
130130

131131
The format of the theme definitions is as follows:
132132
<!-- Important: Use U+00A0 non-breaking spaces ( ) in code blocks -->
133-
| Entry | Description |
134-
|----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
135-
| `"id": "<id>",` | Theme identificator. Autogenerated if not specified. |
136-
| `"url": "<WMS URL>",` | The address of desired WMS served by QGIS Server. |
133+
| Entry | Description |
134+
|------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
135+
| `"id": "<id>",` | Theme identificator. Autogenerated if not specified. |
136+
| `"url": "<WMS URL>",` | The address of desired WMS served by QGIS Server. |
137137
| `"additionalMouseCrs": ["<EPSG code>"],` | Optional, list of additional projections for displaying the mouse position. WGS84 and `mapCrs` are available by default. Additional projections definitions must be added to `config.json`. |
138138
| `"attribution": "<Attribution>",` | Optional, attribution which will be shown in the bottom right corner of the map. |
139139
| `"attributionUrl": "<URL>",` | Optional, link associated to the attribution |
140140
| `"backgroundLayers": [{,` | Optional, list of available background layers, defaults to `defaultBackgroundLayers`. |
141141
| `⁣  "name": "<Background layer name>",` | Name of matching `BackgroundLayerDefinition`, see [below](#background-layers). |
142+
| `⁣  "overview": <boolean>,` | Optional, set the layer as the overview map layer (i.e. this layer will be displayed in the overview map regardless of the background layer visible in the main map). |
142143
| `⁣  "printLayer": "<layer name>"\|[<list>],` | Optional, a QGIS layer name or layer resource string to use as matching background layer when printing. Alternatively, a list `[{"maxScale": <scale>, "name": "<layer name>"}, ..., {"maxScale": null, "name": "<layer name>"}]` can be provided, ordered in ascending order by `maxScale`. The last entry should have `maxScale` `null`, as the layer used for all remaining scales. If omitted, no background is printed, unless layer is of type `wms` and `printExternalLayers` is `true` in the Print plugin configuration. See [Printing](../topics/Printing.md). |
143-
| `⁣  "visibility": <boolean>`, | Optional, initial visibility of the layer when theme is loaded. |
144-
| `⁣  "overview": <boolean>`, | Optional, set the layer as the overview map layer (i.e. this layer will be displayed in the overview map regardless of the background layer visible in the main map). |
144+
| `⁣  "visibility": <boolean>` | Optional, initial visibility of the layer when theme is loaded. |
145145
| `}],` | |
146146
| `"collapseLayerGroupsBelowLevel": <level>,` | Optional, layer tree level below which to initially collapse groups. By default the tree is completely expanded. |
147147
| `"config": {` | Optional, per-theme configuration entries which override the global entries in `config.json`, see [Viewer Configuration](ViewerConfiguration.md).|
148148
| `⁣  "<...>": ...,` | Global config settings overridden in theme, see [`config.json`](ViewerConfiguration.md#theme-overridable-settings). |
149-
| `⁣  "plugins": {...},` | Plugin configuration overridden in theme, See [`config.json`](ViewerConfiguration.md#plugin-configuration). |
150149
| `⁣  "desktop": {...},` | Desktop specific global and plugin configuration overridden in theme. |
151-
| `⁣  "mobile": {...}` | Mobile specific global and plugin configuration overridden in theme. |
150+
| `⁣  "mobile": {...},` | Mobile specific global and plugin configuration overridden in theme. |
151+
| `⁣  "plugins": {...}` | Plugin configuration overridden in theme, See [`config.json`](ViewerConfiguration.md#plugin-configuration). |
152152
| `}` | |
153153
| `"defaultDisplayCrs": "<EPSG code>",` | Optional, defines default measuring CRS for coordinates used in BottomBar and Measure, defaults to mapCrs/project projection. |
154154
| `"defaultPrintLayout": "<name>",` | Optional, name of print layout to select by default. |
155155
| `"description": "<Description>",` | Optional, an additional description to show below the theme title. |
156156
| `"editConfig": {<editConfig>} ` | Optional, object containing the editing configuration for the theme, see [Editing](../topics/Editing.md#edit-config). Usually auto-generated by the ConfigGenerator. |
157157
| `"extent": [<xmin>, <ymin>, <xmax>, <ymax>],` | Optional, override theme extent. In `mapCrs`. |
158158
| `"externalLayers": [{` | Optional, external layers to use as replacements for internal layers. |
159-
| `⁣  "name": "<external_layer_name>",` | Name of the external layer, matching a `ExternalLayerDefinition`, see [below](#external-layers). |
160-
| `⁣  "internalLayer": "<QGis_layer_name>"` | Name of an internal layer, as contained in the QGIS project, to replace with the external layer. |
159+
| `⁣  "internalLayer": "<QGis_layer_name>",` | Name of an internal layer, as contained in the QGIS project, to replace with the external layer. |
160+
| `⁣  "name": "<external_layer_name>"` | Name of the external layer, matching a `ExternalLayerDefinition`, see [below](#external-layers). |
161161
| `}],` | |
162162
| `"extraDxfParameters": "<&KEY=VALUE>",` | Optional, [additional query parameters](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html?highlight=dxf#format-options) to append to DXF export request. |
163163
| `"extraLegendParameters": "<&KEY=VALUE>",` | Optional, [additional query parameters](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html#getlegendgraphics) to append to GetLegendGraphic request. |
@@ -186,18 +186,18 @@ The format of the theme definitions is as follows:
186186
| `"printLabelConfig": {` | Optional, configuration of the text input fields for print layout labels. |
187187
| `⁣  "<LabelId>": {` | |
188188
| `⁣  ⁣  "defaultValue": "<value">,` | Optional, default value. |
189-
| `⁣  ⁣  <textarea config>,` | Optional, additional [`textarea` properties](https://react.dev/reference/react-dom/components/textarea), i.e. `maxLength`, `rows`, `placeholder`, ... |
190-
| `⁣  ⁣  "options": ["<value1>","<value2>",...]` | Optional, to display a ComboBox with the specified options instead of a free-input textfield. |
189+
| `⁣  ⁣  "options": ["<value1>","<value2>",...],` | Optional, to display a ComboBox with the specified options instead of a free-input textfield. |
190+
| `⁣  ⁣  <textarea config>` | Optional, additional [`textarea` properties](https://react.dev/reference/react-dom/components/textarea), i.e. `maxLength`, `rows`, `placeholder`, ... |
191191
| `},` | |
192192
| `"printLabelForAttribution": "<ID>",` | Optional, an ID of a print layout label to which the current attribution text (if any) will be written to when printing. |
193193
| `"printLabelForSearchResult": "<ID>",` | Optional, an ID of a print layout label to which the current search result text (if any) will be written to when printing. |
194194
| `"printResolutions": [<DPIs>],` | List of available print resolutions. If an empty list, resolutions are freely choseable. If omitted, defaults to `defaultPrintResolutions`. |
195195
| `"printScales": [<Scale denominators>],` | List of denominators of allowed print scales. If omitted, defaults to `defaultPrintScales`. |
196196
| `"skipEmptyFeatureAttributes": <boolean>,` | Optional, whether to skip empty attributes in the identify results. Default is `false`. |
197197
| `"themeInfoLinks": {` | Optional, custom links to additional resources, shown as a menu in the theme selector in the theme switcher. |
198+
| `⁣  "entries": ["<link_name>", ...],` | List of theme info link names, see [below](#theme-info-links). |
198199
| `⁣  "title": "<Menu title>",` | An arbitrary string shown as title of the menu. |
199-
| `⁣  "titleMsgId": "<Menu title msgID>",` | Alternative to `title`, a message ID, translated through the translation files. |
200-
| `⁣  "entries": ["<link_name>", ...]` | List of theme info link names, see [below](#theme-info-links). |
200+
| `⁣  "titleMsgId": "<Menu title msgID>"` | Alternative to `title`, a message ID, translated through the translation files. |
201201
| `},` | |
202202
| `"title": "<Custom title>",` | Optional, override WMS title. |
203203
| `"thumbnail": "<Filename>",` | Optional, image file in `assets/img/mapthumbs` (see [Viewer assets](ViewerConfiguration.md#viewer-asset)). If omitted, `<project_basename>.png` will be used if it exists below `assets/img/mapthumbs`, otherwise it is autogenerated via WMS GetMap. |
@@ -210,14 +210,14 @@ The format of the theme definitions is as follows:
210210
| `"searchProviders": ["<Provider>"],` | Optional, list of search providers, see [Search](../topics/Search.md). Defaults to `defaultSearchProviders`. |
211211
| `"visibilityPresetsBlacklist": ["<name>", ...],` | Optional: list of visibility presets (QGIS layer themes) to exclude. You can use`*` as a wildcard character. |
212212
| `"watermark": {` | Optional, configuration of watermark to add to raster export images. |
213-
| `⁣  "text": "<text>",` | Arbitrary text. |
214-
| `⁣  "texpadding": <number>,` | Optional, padding between text and frame, in points. |
215-
| `⁣  "fontsize": <number>,` | Optional, font size. |
216-
| `⁣  "fontfamily": "<Font family>",` | Optional, font family. |
217-
| `⁣  "fontcolor": "#RRGGBB",` | Optional, font color. |
218213
| `⁣  "backgroundcolor": "#RRGGBB",` | Optional, frame background color. |
219214
| `⁣  "framecolor": "#RRGGBB",` | Optional, frame color. |
220215
| `⁣  "framewidth": <number>,` | Optional, frame width. |
216+
| `⁣  "fontcolor": "#RRGGBB",` | Optional, font color. |
217+
| `⁣  "fontfamily": "<Font family>",` | Optional, font family. |
218+
| `⁣  "fontsize": <number>,` | Optional, font size. |
219+
| `⁣  "text": "<text>",` | Arbitrary text. |
220+
| `⁣  "texpadding": <number>` | Optional, padding between text and frame, in points. |
221221
| `},` | |
222222
| `"wmsBasicAuth": "{` | Optional, allows to authenticate to QGIS Server during themes.json generation. NOTE: these credentials will solely be used by `yarn run themesConfig` and won't be stored in `themes.json`.|
223223
| `⁣  "username": <username>,` | Optional: http basic authentication username. |

0 commit comments

Comments
 (0)