Skip to content

Commit 736844d

Browse files
manisandromanisandro
committed
Sort config options
1 parent 46c488c commit 736844d

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

‎src/configuration/ViewerConfiguration.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,31 +25,31 @@ All settings are optional, with fallback to the default values as documented.
2525

2626
| Setting | Description |
2727
|-------------------------------------|-------------|
28+
|`allowFractionalZoom` | Whether to allow arbitrary scales for viewing the map. Default value: `false`. |
2829
|`assetsPath` | Relative path to the `assets` folder. Default value: `assets`. |
29-
|`translationsPath` | Relative path to the `translations` folder. Default value: `translations`. |
30-
|`loadTranslationOverrides` | Whether to attempt to load tanslation overrides, see [translations](#translations). Default value: `false`. |
31-
|`urlPositionFormat` | How to encode the current map extent in the URL, either `centerAndZoom` or `extent`. See [URL parameters](../topics/Interfacing.md#url-parameters) for details. Default value: `extent`. |
32-
|`urlPositionCrs` | The CRS used to encode the current map extent coordinates in the URL. Default value: the map projection. |
33-
|`omitUrlParameterUpdates` | Whether to omit updating the URL parameters. Default value: `false`. |
30+
|`defaultColorScheme` | The color scheme to use. See [Color schemes](#color-schemes) for details. |
3431
|`defaultFeatureStyle` | The default style to use for selection geometries and other unstyled features. Default value: see `qwc2/utils/FeatureStyles.js`. |
35-
|`defaultMarkerStyle` | The default style to use as marker icon. Default value: see `qwc2/utils/FeatureStyles.js`. |
3632
|`defaultInteractionStyle` | The default style to use on geometries to measure, snap or edit. Default value: see `qwc2/utils/FeatureStyles.js`. |
37-
|`projections` | A list of map projections to register, in the format `{"code": "<code>", "proj": "<proj4def>", "label": "<label>"}`. By default, `EPSG:3857` and `EPSG:4326` are registered. |
38-
|`allowFractionalZoom` | Whether to allow arbitrary scales for viewing the map. Default value: `false`. |
33+
|`defaultMarkerStyle` | The default style to use as marker icon. Default value: see `qwc2/utils/FeatureStyles.js`. |
34+
|`editingAddLinkAnchors` | Whether to automatically insert link anchors in text values when editing. |
35+
|`editServiceCaptchaSiteKey` | ReCAPTCHA public site key for public editing, see [ReCAPTCHA validation](../Topics/Editing.md#recaptcha). |
36+
|`editTextNullValue` | A text value which represents `NULL` when editing. |
37+
|`geodesicMeasurements` | Whether to perform measurements on the geoid. |
38+
|`loadTranslationOverrides` | Whether to attempt to load tanslation overrides, see [translations](#translations). Default value: `false`. |
3939
|`localeAwareNumbers` | Whether to use locale aware numbers throughout. Default value: `false`. |
40-
|`wmsHidpi` | Whether to honour the device pixel ratio for WMS GetMap requests. Default value: `true`. |
41-
|`wmsMaxGetUrlLength` | URL length limit before switching to a POST request for GetMap and GetFeatureInfo. Default: 2048. |
42-
|`wmsWktPrecision` | Precision (as number of decimals) of WKT geometries passed in WMS requests. Default: 4. |
40+
|`omitUrlParameterUpdates` | Whether to omit updating the URL parameters. Default value: `false`. |
41+
|`projections` | A list of map projections to register, in the format `{"code": "<code>", "proj": "<proj4def>", "label": "<label>"}`. By default, `EPSG:3857` and `EPSG:4326` are registered. |
4342
|`qgisServerVersion` | The QGIS Server major version in use, defaults to `3`.|
44-
|`defaultColorScheme` | The color scheme to use. See [Color schemes](#color-schemes) for details. |
4543
|`startupTask` | Task to automatically activate on application start, in the format `{key: "<Task>", "mode": "<Mode>"}`. |
4644
|`storeAllLayersInPermalink` | Whether to store the full layertree in the permalink data, rather than only local (i.e. redlining) layers. If `false`, remote layers are re-queried from the respective services, if `true`, they are statically reloaded (meaning restored layers may be outdated compared to current service capabilities).
47-
|`urlRegEx` | A [JSON-escaped](https://www.freeformatter.com/json-escape.html) regular expression used to match URLs in feature attribute values. Default: see `qwc2/utils/MiscUtils.js`. |
45+
|`translationsPath` | Relative path to the `translations` folder. Default value: `translations`. |
4846
|`trustWmsCapabilityURLs` | Whether to trust the GetMap etc. URLs reported in WMS service capabilities. If not `true`, the protocol, host and pathname portion of the URLs are inherited from the called capabilities URL. |
49-
|`editServiceCaptchaSiteKey` | ReCAPTCHA public site key for public editing, see [ReCAPTCHA validation](../Topics/Editing.md#recaptcha). |
50-
|`editTextNullValue` | A text value which represents `NULL` when editing. |
51-
|`editingAddLinkAnchors` | Whether to automatically insert link anchors in text values when editing. |
52-
|`geodesicMeasurements` | Whether to perform measurements on the geoid. |
47+
|`urlPositionCrs` | The CRS used to encode the current map extent coordinates in the URL. Default value: the map projection. |
48+
|`urlPositionFormat` | How to encode the current map extent in the URL, either `centerAndZoom` or `extent`. See [URL parameters](../topics/Interfacing.md#url-parameters) for details. Default value: `extent`. |
49+
|`urlRegEx` | A [JSON-escaped](https://www.freeformatter.com/json-escape.html) regular expression used to match URLs in feature attribute values. Default: see `qwc2/utils/MiscUtils.js`. |
50+
|`wmsHidpi` | Whether to honour the device pixel ratio for WMS GetMap requests. Default value: `true`. |
51+
|`wmsMaxGetUrlLength` | URL length limit before switching to a POST request for GetMap and GetFeatureInfo. Default: 2048. |
52+
|`wmsWktPrecision` | Precision (as number of decimals) of WKT geometries passed in WMS requests. Default: 4. |
5353

5454
### Global settings, overridable per theme<a name="theme-overridable-settings"></a>
5555

@@ -58,23 +58,23 @@ All settings are optional, with fallback to the default values as documented.
5858

5959
| Setting | Description |
6060
|--------------------------------------|-------------|
61-
|`preserveExtentOnThemeSwitch` | Whether to preserve the current map extent when switching theme, if possible (see below). Default value: `false`. |
62-
|`preserveBackgroundOnThemeSwitch` | Whether to preserve the current background layer when switching theme, if possible. Default value: `false`. |
63-
|`preserveNonThemeLayersOnThemeSwitch` | Whether to preserve non-theme layers when switching theme. Default value: `false`. |
64-
|`allowReorderingLayers` | Whether to allow re-ordering layers in the layer tree. Default value: `false`. |
65-
|`flattenLayerTreeGroups` | Whether to display a flat layer tree, omitting the groups. Default value: `false`. |
61+
|`allowAddingOtherThemes` | Whether to allow adding another theme to a currently loaded theme. Default value: `false`. |
6662
|`allowLayerTreeSeparators` | Allows users to add separator items in a flat layer tree. Default value: `false`. |
67-
|`preventSplittingGroupsWhenReordering`| Whether to prevent splitting sibling groups or the group itself when reordering items. Default value: `false`. |
6863
|`allowRemovingThemeLayers` | Whether to allow removing any theme layers from the layer tree. Default value: `false`. |
69-
|`searchThemes` | Whether to allow searching for themes from the global search field. Default value: `false`. |
70-
|`searchThemeLayers` | Whether to allow searching for theme layers from the global search field. Default value: `false`. |
71-
|`allowAddingOtherThemes` | Whether to allow adding another theme to a currently loaded theme. Default value: `false`. |
64+
|`allowReorderingLayers` | Whether to allow re-ordering layers in the layer tree. Default value: `false`. |
7265
|`disableImportingLocalLayers` | Whether to hide the option to import local layers from the layer tree. Default value: `false`. |
73-
|`importLayerUrlPresets` | A list of predefined URLs from which the user can choose when importing layers from the layer tree. Entries must be strings or objects of the format `{"label": "<Label>", "value": "<URL>"}`. |
74-
|`identifyTool` | The name of the identify plugin to use as default identify tool. If set to an empty string, no identify tool will be active by default. Default value: `Identify`. |
66+
|`flattenLayerTreeGroups` | Whether to display a flat layer tree, omitting the groups. Default value: `false`. |
7567
|`globallyDisableDockableDialogs` | Whether to globally disable the dockable feature of popup dialogs. Default value: `false`. |
7668
|`globallyDisableMaximizeableDialogs` | Whether to globally disable the maximizeable feature of popup dialogs. Default value: `false`. |
69+
|`identifyTool` | The name of the identify plugin to use as default identify tool. If set to an empty string, no identify tool will be active by default. Default value: `Identify`. |
70+
|`importLayerUrlPresets` | A list of predefined URLs from which the user can choose when importing layers from the layer tree. Entries must be strings or objects of the format `{"label": "<Label>", "value": "<URL>"}`. |
71+
|`preserveBackgroundOnThemeSwitch` | Whether to preserve the current background layer when switching theme, if possible. Default value: `false`. |
72+
|`preserveExtentOnThemeSwitch` | Whether to preserve the current map extent when switching theme, if possible (see below). Default value: `false`. |
73+
|`preserveNonThemeLayersOnThemeSwitch` | Whether to preserve non-theme layers when switching theme. Default value: `false`. |
74+
|`preventSplittingGroupsWhenReordering`| Whether to prevent splitting sibling groups or the group itself when reordering items. Default value: `false`. |
7775
|`searchFilterRegions` | List of predefined search filter regions, see [Search filtering](../topics/Search.md#filtering). |
76+
|`searchThemeLayers` | Whether to allow searching for theme layers from the global search field. Default value: `false`. |
77+
|`searchThemes` | Whether to allow searching for themes from the global search field. Default value: `false`. |
7878
|`startupTask` | Task to automatically start when switching to the theme, in the format `{key: "<Task>", "mode": "<Mode>"}`. Takes precedence over the global `startupTask`. Note that the task whenever switching to the theme, not only on application start. |
7979

8080
Note:
@@ -112,10 +112,10 @@ Some plugins require external services (typically part of the `qwc-services` eco
112112
|`authServiceUrl` | Typically the URL of a QWC authentication service like `qwc-db-auth`. |
113113
|`editServiceUrl` | Typically the URL of the `qwc-data-service`. |
114114
|`elevationServiceUrl` | Typically the URL of the `qwc-elevation-service`. |
115+
|`featureReportService`| Typically the URL of the `qwc-document-service`. |
115116
|`mapInfoService` | Typically the URL of the `qwc-map-info-service`. |
116117
|`permalinkServiceUrl` | Typically the URL of the `qwc-permalink-service`. |
117118
|`searchServiceUrl` | Typically the URL of the `qwc-fulltext-search-service`. |
118-
|`featureReportService`| Typically the URL of the `qwc-document-service`. |
119119

120120
### Plugin configuration<a name="plugin-configuration"></a>
121121

0 commit comments

Comments
 (0)