diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..44391f9a --- /dev/null +++ b/404.html @@ -0,0 +1,157 @@ + + + + + + + + QWC2 - latest + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • +
    • +
+
+
+
+
+ + +

404

+ +

Page not found

+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/FAQ/index.html b/FAQ/index.html new file mode 100644 index 00000000..8f4fa1f4 --- /dev/null +++ b/FAQ/index.html @@ -0,0 +1,169 @@ + + + + + + + + FAQ - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • FAQ
    • +
  • +
    • +
+
+
+
+
+ +

FAQ

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + +
+ + + + + + + + diff --git a/QuickStart/index.html b/QuickStart/index.html new file mode 100644 index 00000000..73f0ec1f --- /dev/null +++ b/QuickStart/index.html @@ -0,0 +1,246 @@ + + + + + + + + Quick start - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Quick start
    • +
  • +
    • +
+
+
+
+
+ +

Quick start

+

Running QWC2 as part of qwc-services

+

qwc-services is a collection of loosely coupled micro-services for extending QWC2. The services communicate with each other via HTTP/Rest, and are mostly written in Python.

+

The easiest way to run qwc-services is to use the readily available docker images, using the sample setup at qwc-docker.

+

To be able to run qwc-docker, first install docker and docker compose:

+ +

Then, follow these steps:

+
    +
  • Clone the qwc-docker sample setup at qwc-docker and copy the docker-compose and api-gateway configuration templates:
    • +
+
git clone https://github.com/qwc-services/qwc-docker.git
+cd qwc-docker
+cp docker-compose-example.yml docker-compose.yml
+cp api-gateway/nginx-example.conf api-gateway/nginx.conf
+
+
    +
  • Create a secret key:
    • +
+
python3 -c 'import secrets; print("JWT_SECRET_KEY=\"%s\"" % secrets.token_hex(48))' >.env
+
+
    +
  • +

    Change the UID/GID which runs the QWC services to match the user/group which owns the shared volumes on the host by setting SERVICE_UID and SERVICE_GID in qwc-docker/docker-compose.yml.

    +
    • +
  • +

    Set permissions for the shared solr data volume:

    +
    • +
+
sudo chown 8983:8983 volumes/solr/data
+
+
    +
  • Start all containers (will download all images from dockerhub when executed the first time):
    • +
+
docker-compose up
+
+

The map viewer will run on http://localhost:8088/.

+

The admin GUI will run on http://localhost:8088/qwc_admin (default admin credentials: username admin, password admin, requires password change on first login).

+

Next steps:

+ +

Running QWC2 as a standalone viewer

+

If you don't need the advanced functionalities provided by qwc-services or want to integrate QWC2 in another environment, you can run QWC2 as a standalone viewer.

+

To work with QWC2, you will need a minimal development environment consisting of git, node and yarn. You will also need a running QGIS Server instance which serves your projects.

+

The fastest way to get started is by cloning the demo application:

+
git clone --recursive https://github.com/qgis/qwc2-demo-app.git
+
+

Next, install all required dependencies:

+
cd qwc2-demo-app
+yarn install
+
+

Then, start a local development application:

+
yarn start
+
+

The development application will run by default on http://localhost:8081.

+

At this point, you can customize and configure the application according to your needs, as described in detail in the following chapters.

+

The final step is to compile a deployable application bundle for production:

+
yarn run prod
+
+

You can then deploy the contents of the prod folder to your web server.

+

Next steps:

+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/ResourcesPermissions/index.html b/configuration/ResourcesPermissions/index.html new file mode 100644 index 00000000..d195ae42 --- /dev/null +++ b/configuration/ResourcesPermissions/index.html @@ -0,0 +1,275 @@ + + + + + + + + Resources and permissions - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • General configuration »
    • +
  • Resources and permissions
    • +
  • +
    • +
+
+
+
+
+ +

Managing Users, Resources and Permissions

+

qwc-docker has a QWC configuration backend. That backend can be reached by default at http://localhost:8088/qwc_admin.

+

The configuration backend allows to assign users and groups to roles. The roles in their turn can receive permissions on resources. These configuration settings will be stored in the configuration database. Out of the box qwc-docker comes with with a container qwc-postgis that contains the configuration database.

+

Users, groups and roles

+

Roles can be given permissions on resources. That means that if you want to give users or groups permissions on resources, then you have to first create a role, configure the permissions that the roles has on some resources, and then assign the role the users or groups.

+

Resources

+

The following resource types are available:

+
    +
  • Map: WMS corresponding to a QGIS Project
    • +
  • Layer: layer of a map
      +
    • Attribute: attribute of a map layer
      • +
    +
    • +
  • Print template: print composer template of a QGIS Project
    • +
  • Data: Data layer for editing
      +
    • Attribute: attribute of a data layer
      • +
    +
    • +
  • Data (create): Data layer for creating features
    • +
  • Data (read): Data layer for reading features
    • +
  • Data (update): Data layer for updating features
    • +
  • Data (delete): Data layer for deleting features
    • +
  • Viewer: custom map viewer configuration
    • +
  • Viewer task: permittable viewer tasks
    • +
  • FeatureInfo service: Feature info service
    • +
  • FeatureInfo layer: Feature info layer
    • +
+

The resource name corresponds to the technical name of its resource (e.g. WMS layer name). Most notably, the name of a map resource corresponds to the relative path to the project below qgs-resources without .qgs extension (so i.e. the resource name for qgs-resources/subfolder/project.qgs will be subfolder/project).

+

Note: If your QGIS project is configured to return the field aliases rather than the field names in GetFeatureInfo, the resource name for layer attribute resources corresponds to the alias of the field.

+

Available map, layer, attribute and print_template resources are determined from WMS GetProjectSettings and the QGIS projects.

+

data and their attribute resources define a data layer for the Data service.

+

For more detailed CRUD permissions data_create, data_read, data_update and data_delete can be used instead of data +(data and write=False is equivalent to data_read; data and write=True is equivalent to all CRUD resources combined).

+

The viewer resource defines a custom viewer configuration for the map viewer (see Custom viewer configurations).

+

The viewer_task resource defines viewer functionalities (e.g. printing or raster export) that can be restricted or permitted. +Their name (e.g. RasterExport) corresponds to the key in menuItems and toolbarItems in the QWC2 config.json. Restricted viewer task items are then removed from the menu and toolbar in the map viewer. Viewer tasks not explicitly added as resources are kept unchanged from the config.json.

+

Note: The resource types, i.e. for custom QWC2 plugins, can be extended by inserting new types into the qwc_config.resource_types table. +These can be queried, e.g. in a custom service, by using PermissionClient::resource_permissions() or +PermissionClient::resource_restrictions() from QWC Services Core.

+

Permissions

+

Permissions are based on roles. Roles can be assigned to groups or users, and users can be members of groups. +A special role is "public". The "public" role applies always, no matter whether a user is signed in or is not signed in.

+

Roles can be assigned permission for resources.

+

The write flag is only used for data resources and determines whether a data layer is read-only.

+

Based on the user's identity (user name and/or group name), all corresponding roles and their permissions and restrictions are collected. +The service configurations are then modified according to these permissions and restrictions.

+

By using the permissions_default_allow configuration setting in tenantConfig.json, some resources can be set to be permitted or restricted by default if no permissions are set (default: false). Among affected resources are Map, Layer, Print template, Viewer task, FeatureInfo service, FeatureInfo layer. E.g.:

+
    +
  • permissions_default_allow=true: all maps and layers are permitted by default
    • +
  • permissions_default_allow=false: maps and layers are only available if their resources and permissions are explicitly configured
    • +
+

Restricted themes

+

The display behaviour of restricted themes can be configured in the mapViewer service configuration in tenantConfig.json as follows:

+
{
+  "name": "mapViewer",
+  "config": {
+    "show_restricted_themes": false,
+    "show_restricted_themes_whitelist": [],
+    "redirect_restricted_themes_to_auth": false,
+    "internal_permalink_service_url": "http://qwc-permalink-service:9090"
+  }
+}
+
+
    +
  • show_restricted_themes: Whether to show placeholder items for restricted themes. Default: false.
    • +
  • show_restricted_themes_whitelist: Whitelist of restricted theme names to display as placeholders. If empty, all restricted themes are shown. Only used if show_restricted_themes enabled. Default: [].
    • +
  • redirect_restricted_themes_to_auth: Whether to redirect to login on auth service if requesting a restricted theme in URL params, if not currently signed in. Default: false.
    • +
  • internal_permalink_service_url: Internal permalink service URL for getting the theme from a resolved permalink for redirecting to login (default: http://qwc-permalink-service:9090). This is used only if redirect_restricted_themes_to_auth is enabled and permalink_service_url is set.
    • +
+

Permissions file

+

The QWC Config Generator generates a JSON file for all permissions from the QWC ConfigDB. See READMEs of QWC services for service specific contents in permissions.json.

+ + +

Group registration

+

Using the optional Registration GUI allows users to request membership or unsubscribe from registrable groups. These requests can then be accepted or rejected in the Admin GUI.

+

Workflow:

+
    +
  • Admin GUI
    • +
  • admin user creates new groups with assigned roles and permissions on resources
    • +
  • admin user configures registrable groups
    • +
  • Registration GUI
    • +
  • user select desired groups from registrable groups and submits application form
    • +
  • admin users are notified of new registration requests
    • +
  • Admin GUI
    • +
  • admin user selects entry from list of pending registration requests
    • +
  • admin user accepts or rejects registration requests for a user
    • +
  • user is added to or removed from accepted groups
    • +
  • user is notified of registration request updates
    • +
  • Map Viewer
    • +
  • user permissions are updated for new groups
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/ServiceConfiguration/index.html b/configuration/ServiceConfiguration/index.html new file mode 100644 index 00000000..0aec6980 --- /dev/null +++ b/configuration/ServiceConfiguration/index.html @@ -0,0 +1,458 @@ + + + + + + + + Services - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • General configuration »
    • +
  • Services
    • +
  • +
    • +
+
+
+
+
+ +

QWC Services configuration

+

The architecture of qwc-services is as follows:

+

QWC Services Arch

+ +

qwc-docker ships a pre-configured the qwc-services ecosystem as an easy to use application.

+

Service overview

+

Following is an overview of existing qwc-services:

+

Applications:

+ +

REST services:

+ +

Configuration database:

+ +

Configuration generator:

+ +

qwc-docker layout

+

The layout of the qwc-docker tree is as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathDescription
├─ api-gateway/nginx.confAPI gateway configuration.
├─ volumes/Contains folders which are mounted into the various containers.
│ ├─ attachmentsStorage of files uploaded through the QWC2 editing functionality.
│ ├─ config/<tenant>/Service configuration files, generated by qwc-config-generator.
│ ├─ config-in/<tenant>/Input configuration files, processed by the qwc-config-generator.
│ │ ├─ config.jsonMaster configuration for the QWC2 viewer.
│ │ ├─ index.htmlViewer entry point.
│ │ ├─ themesConfig.jsonThemes configuration.
│ │ └─ tenantConfig.jsonMaster configuration file for qwc services.
│ ├─ db/Storage of configuration database (see qwc-config-db).
│ ├─ info-templates/Custom feature-info templates (see qwc-feature-info-service).
│ ├─ jasper-reports/Jasper reports (see qwc-document-service).
│ ├─ legends/Custom legend images (see qwc-legend-service).
│ ├─ qgs-resources/QGIS projects and data referenced by the projects.
│ ├─ qwc2/QWC2 Viewer.
│ └─ solr/Fulltext search index.
├─ docker-compose.ymlContainer configuration file.
├─ pg_service.confDatabase service definitions.
└─ pg_service-write.confDatabase service definitions for write connections.
+

Service configurations

+

The master configuration file for the QWC services is located at qwc-docker/volumes/config-in/<tenant>/tenantConfig.json, where <tenant> is the tenant name, default by default. See Multi Tenancy for more details on tenants.

+

The file is structured as follows:

+
{
+  "$schema": "https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json",
+  "service": "config-generator",
+  "config": {
+    <ConfigGenerator config>
+  },
+  "themesConfig": "./themesConfig.json",
+  "services": [
+    {
+      "name": "<service name",
+      <Service config>
+    },
+    ...
+  ]
+}
+
+

Refer to the qwc-config-generator schema for the available ConfigGenerator config settings.

+

themesConfig is a relative path to the theme configuration file as documented in Theme configuration.

+

Theservices block contains the configuration for the individual QWC services, as documented in the reference.

+

Note: All config settings can also be set as environment variables in capitalized form in docker-compose.yml.

+

Note: Some variables must be set as environment variables in docker-compose.yml:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ENVDefault valueDescription
INPUT_CONFIG_PATHconfig-inBase path for service configuration files
OUTPUT_CONFIG_PATH/tmpBase path for service configuration files
JWT_SECRET_KEY********secret key for JWT token
TENANT_URL_RENoneRegex for tenant extraction from base URL. Example: ^https?://.+?/(.+?)/
TENANT_HEADERNoneTenant Header name. Example: Tenant
+

Enabling additional services

+
    +
  • Add service entry in qwc-services/docker-compose.yml, setting the service mountpoint:
    • +
+
SERVICE_MOUNTPOINT=/<mountpoint>
+
+

Example:

+
  qwc-print-service:
+    image: sourcepole/qwc-print-service:vYYYY.MM.DD
+    environment:
+      <<: *qwc-service-variables
+      SERVICE_MOUNTPOINT: '/api/v1/print'
+    volumes:
+      - ./volumes/config:/srv/qwc_service/config:ro
+    ports:
+      - "127.0.0.1:5020:9090"
+
+
    +
  • Add corresponding entry in api-gateway/nginx.conf, example:
    • +
+
  location /api/v1/print {
+    proxy_pass http://qwc-print-service:9090;
+  }
+
+
    +
  • If necessary, uncomment/add the respective service url (see also the qwc-map-viewer schema reference) in the mapViewer config block of volumes/config-in/default/tenantConfig.json, i.e.
    • +
+
  {
+    "name": "mapViewer",
+    "generator_config": {
+      # ...
+    },
+    "config": {
+      "print_service_url": "/api/v1/print/",
+      # ...
+    }
+  }
+
+
    +
  • Add the service configuration block below services in volumes/config-in/default/tenantConfig.json, according to the service config schema, i.e.
    • +
+
  {
+    "name": "print",
+    "config": {
+      "ogc_service_url": "http://qwc-ogc-service:9090/",
+      "qgis_server_version": "3.16"
+    }
+  }
+
+

Configuration database

+

The Configuration database (ConfigDB) contains the database schema qwc_config for configurations and permissions of QWC services.

+

This database uses the PostgreSQL connection service qwc_configdb by default, which can be setup for the corresponding database in the PostgreSQL connection service file qwc-docker/pg_service.conf.

+

To use an external configuration database, either change the connection definition for qwc_configdb in qwc-docker/pg_service.conf or change the config_db_url in qwc-docker/volumes/config-in/<tenant>/tenantConfig.json.

+

Database migrations

+

An existing ConfigDB can be updated to the latest schema by running the database migrations from the qwc-config-db directory:

+
git clone https://github.com/qwc-services/qwc-config-db.git
+cd qwc-config-db/
+# Install alembic, either globally or activate python virtualenv and run `pip install -r requirements.txt`)
+alembic upgrade head
+
+

Note: The qwc_configdb service definition must exist in the host, for instance:

+
cat $HOME/.pg_service.conf
+[qwc_configdb]
+host=localhost
+port=5439
+dbname=qwc_demo
+user=qwc_admin
+password=qwc_admin
+sslmode=disable
+
+

Keeping QWC services up to date

+

When using qwc-docker, updating the services is a simple as updating the image tags in qwc-docker/docker-compose.yml.

+

Two versioning schemes are available:

+
    +
  • vYYYY-MM-DD: These refer to the latest available version of the respective images (i.e. v2023.05.12).
    • +
  • vYYYY.X-lts: These refer to the long term support version of the respective images (i.e. v2023.1-lts).
    • +
+

You can always check the available tags on dockerhub, for example at https://hub.docker.com/r/sourcepole/qwc-config-generator.

+

The qwc-docker Upgrade Notes documents major changes, and in particular all incompatible changes between releases which require changes to the application specific code and/or configuration.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/ThemesConfiguration/index.html b/configuration/ThemesConfiguration/index.html new file mode 100644 index 00000000..f93c390e --- /dev/null +++ b/configuration/ThemesConfiguration/index.html @@ -0,0 +1,969 @@ + + + + + + + + Themes - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • General configuration »
    • +
  • Themes
    • +
  • +
    • +
+
+
+
+
+ +

Themes configuration

+

A theme corresponds to a QGIS project, published as WMS and served by QGIS Server.

+

The basic steps for configuring a theme are:

+ +

Creating and publishing a QGIS project

+

The first step is to prepare a QGIS project for publishing. Besides the common tasks of adding and styling layers, the following table gives an overview of settings which influence how the theme is displayed in QWC2:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
WhatWhereDescription
Service MetadataProject Properties → QGIS Server → Service capabilitiesShown in the theme info dialog, invokable from the Layer Tree panel titlebar.
Title, keywordsProject Properties → QGIS Server → Service capabilitiesTheme title, displayed in the Theme Switcher, and keywords, useful for filtering.
Map extentProject Properties → QGIS Server → WMS → Advertised extentThe extent used as initial map extent when loading the theme, unless overridden in themesConfig.json.
Queryable layersProject Properties → Data sourcesMark layers as identifyable by the client.
FeatureInfo geometryProject Properties → QGIS Server → WMS Capabilities → Add geometry to feature responseReturn feature geometries with the GetFeatureInfo request. Allows the client to highlight the selected features.
Layer Display FieldVector Layer Properties → DisplayThe field used in the identify results.
Layer Map TipVector Layer Properties → DisplayThe contents of the Map Tip shown when hovering over layers in the client, if displaying Map Tips is enabled in the Layer Tree.
Layer MetadataLayer Properties → QGIS ServerShown in the client Layer Info dialog, invokable from the Layer Tree.
Scale rangeLayer Properties → Rendering → Scale dependent visibilityThe scale range within which a layer is visible, useful to improve rendering performance.
Initial visibilityLayers PanelInitial visibility of layers and groups.
Rendering orderLayer Order Panel or Layers PanelRendering order of the layers. If layer re-ordering is enabled in config.json, the order from the Layer Order Panel is ignored.
Print layoutsLayout managerThe print layouts offered in the Print plugin.
Print layout labelsLayout managerPrint layout labels with an ID will be exposed in the Print plugin. Note: a label ID starting with __ will not be exposed.
Attribute formVector Layer Properties → Attributes FormThe configured attribute form will be displayed when editing in QWC2.
External layersLayer Properties → QGIS Server → Data URLMark the layer as an external layer to avoid cascaded requests. See Configuring external layers.
+

Then, store the project in the publishing directory of your QGIS Server instance. When using qwc-docker, store the project as *.qgs below qwc-docker/volumes/qgs-resources.

+

Alternatively, when using qwc-docker, you can also store the project in a database in QGIS using Project → Save To → PostgreSQL (see Storing projects in database).

+

Ensuring valid datasources

+

A common issue is that the project will reference datasources in locations which cannot be resolved when QGIS Server reads the project, in particular when running QGIS Server inside a docker container. To avoid such issues:

+
    +
  • Make sure that any file-based resources are located on the same level or below the level of the *.qgs project file. Remember to copy all resources along with the *.qgs project file to the server.
    • +
  • Load any PostgreSQL datasource in QGIS using a service, and make sure the service definition exists both in the pg_service.conf on your host system as well as in the qwc_docker/pg_service.conf and qwc_docker/pg_service-write.conf which are mounted inside the docker containers. For instance, to use default qwc-docker database, use the qwc_geodb service and add the service definition to your host pg_service.conf as follows:
    • +
+
[qwc_geodb]
+host=localhost
+port=5439
+dbname=qwc_demo
+user=qwc_service
+password=qwc_service
+sslmode=disable
+
+

Configuring the themes in themesConfig.json

+

The next step is to configure the theme for QWC2. There are two approaches:

+
    +
  • Automatic theme configuration (only when using qwc-docker): Just copy the project file to the designated location and the qwc-config-generator will automatically generate a theme configuration using default parameters.
    • +
  • Manual theme configuration: Manually configure a theme with the full set of configuration options.
    • +
+

Automatic theme configuration

+

When using qwc-docker, save your QGIS projects below qwc-docker/volumes/qgs-resources/scan. Adjust the default settings (defaultMapCrs, defaultBackgroundLayers, etc.) as desired in qwc-docker/volumes/config-in/<tentant>/themesConfig.json. Then generate the theme configuration.

+

You can configure an automatically configured theme as default theme by setting defaultTheme in themesConfig.json to the path to the QGIS project file below qwc-docker/volumes/qgs-resources, without the .qgs extension. For example to set qwc-docker/volumes/qgs-resources/scan/project.qgs as default theme, you'd write

+
...
+"defaultTheme": "scan/project"
+...
+
+

To use a custom thumbnail for an automatically configured theme, place a an image called <project_basename>.png in qwc-docker/volumes/qwc2/assets/img/mapthumbs. For example. if the project is called project_name.qgs, the name thumbnail image would be named project_name.png.

+

Note: The auto-scan directory can be is controlled by qgis_projects_scan_base_dir in qwc-docker/volumes/config-in/<tentant>/themesConfig.json.

+

Manual theme configuration

+

The theme configuration file is located as follows:

+
    +
  • Standalone viewer: qwc2-app/themesConfig.json
    • +
  • qwc-docker: qwc-docker/volumes/config-in/<tentant>/themesConfig.json
    • +
+

Note: when using qwc-docker, the themes configuration may also be embedded as themesConfig directly in qwc-docker/volumes/config-in/<tentant>/tenantConfig.json.

+

The themesConfig.json file contains a list of themes, optionally organized in groups, as well as a list of background layers:

+
{
+  "themes": {
+    "items": [
+      { <ThemeDefinition> },
+      ...
+    ], "groups": [
+      {
+        "title": <Group title>,
+        "items": [{ <ThemeDefinition> }, ...],
+        "groups": [ { <Group> }, ...]
+        },
+        ...
+    ],
+    "externalLayers": [
+      { <ExternalLayerDefinition> },
+      ...
+    ],
+    "themeInfoLinks": [
+      { <ThemeInfoLinkDefinition> },
+      ...
+    ],
+    "backgroundLayers": [
+      { <BackgroundLayerDefinition> },
+      ...
+    ],
+  },
+  "defaultMapCrs": "<Default map crs, defaults to EPSG:3857>",
+  "defaultBackgroundLayers": "<Default background layers, see theme definition below>",
+  "defaultWMSVersion": "<Default WMS version, i.e. 1.3.0>",
+  "defaultScales": [<Scale denominators, see theme definition below>],
+  "defaultPrintScales" [<Scale denominators, see theme definition below>],
+  "defaultPrintResolutions": [<DPIs, see theme definition below>],
+  "defaultSearchProviders": [<Search providers, see theme definition below>],
+  "defaultPrintGrid": [<Print grid, see theme definition below>],
+  "defaultTheme": "<Default theme id>"
+}
+
+

Refer to the sample themesConfig.json for a complete example.

+

The format of the theme definitions is as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EntryDescription
"id": "<id>",Theme identificator. Autogenerated if not specified.
"url": "<WMS URL>",The address of desired WMS served by QGIS Server.
"mapCrs: "<EPSG code>",Optional, map projection, defaults to defaultMapCrs.
"title": "<Custom title>",Optional, override WMS title.
"description": "<Description>",Optional, an additional description to show below the theme title.
"thumbnail": "<Filename>",Optional, image file in assets/img/mapthumbs (see Viewer assets). If omitted, autogenerated via WMS GetMap.
"attribution": "<Attribution>",Optional, attribution which will be shown in the bottom right corner of the map.
"attributionUrl": "<URL>",Optional, link associated to the attribution
"scales": [<Scale denominators>],List of denominators of allowed map scales. If omitted, defaults to defaultScales.
"printScales": [<Scale denominators>],List of denominators of allowed print scales. If omitted, defaults to defaultPrintScales.
"printResolutions": [<DPIs>],List of available print resolutions. If omitted, defaults to defaultPrintResolutions.
"printGrid": [List of grid scale-dependent grid intervals to use when printing. If omitted, defaults to defaultPrintGrid.
⁣  {"s": <Scale1>, "x": <Width1>, "y": <Height1>},Keep this list sorted in descending order by scale denominator.
⁣  {"s": <Scale2>, "x": <Width2>, "y": <Height2>}In this example, {x: <Width2>, y: <Height2>} will be used for <Scale1> > Scale >= <Scale2>.
],
"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.
"printLabelForAttribution": "<ID>",Optional, an ID of a print layout label to which the current attribution text (if any) will be written to when printing.
"printLabelConfig": {Optional, configuration of the text input fields for print layout labels.
⁣  "<LabelId>": {"rows": <n>, "maxLength": <n>},Height of the input field in rows and maximum number of allowed characters.
},
"extent": [<xmin>, <ymin>, <xmax>, <ymax>],Optional, override theme extent. In mapCrs.
"tiled": <boolean>,Optional, use tiled WMS, defaults to false.
"format": "<mimetype>",Optional, the format to use for WMS GetMap. Defaults to image/png.
"externalLayers": [{Optional, external layers to use as replacements for internal layers, see below.
⁣  "name": "<external_layer_name>",Name of the external layer, matching a ExternalLayerDefinition, see below.
⁣  "internalLayer": "<QGis_layer_name>"Name of an internal layer, as contained in the QGIS project, to replace with the external layer.
}],
"themeInfoLinks": {Optional, custom links to additional resources, shown as a menu in the theme selector in the theme switcher.\
⁣  "title": "<Menu title>",An arbitrary string shown as title of the menu.
⁣  "titleMsgId": "<Menu title msgID>",Alternative to title, a message ID, translated through the translation files.
⁣  "entries": [<link_name>, ...]List of theme info link names, see below.
},
"backgroundLayers": [{,Optional, list of available background layers, defaults to defaultBackgroundLayers.
⁣  "name": "<Background layer name>",Name of matching BackgroundLayerDefinition, see below.
⁣  "printLayer": "<QGIS layer name>"\|[<list>],Optional, name of layer to use as matching background layer when printing. Alternatively, a list [{"maxScale": <scale>, "name": "<QGis layer name>"}, ..., {"maxScale": null, "name": "<QGis 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.
⁣  "visibility": <boolean>,Optional, initial visibility of the layer when theme is loaded.
⁣  "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).
}],
"searchProviders": ["<Provider>"],Optional, list of search providers, see Search providers. Defaults to defaultSearchProviders.
"minSearchScaleDenom": <number>,Optional, minimum scale to enforce when zooming to search results. Takes precedence over value in config.json.
"featureReport": {Optional, available feature report templates.
⁣  "<LayerId>": "<TemplateID>"WMS sublayer ID and associated template ID to pass to the featureReportService.
},
"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.
"watermark": {Optional, configuration of watermark to add to raster export images.
⁣  "text": "<text>",Arbitrary text.
⁣  "texpadding": <number>,Optional, padding between text and frame, in points.
⁣  "fontsize": <number>,Optional, font size.
⁣  "fontfamily": "<Font family>",Optional, font family.
⁣  "fontcolor": "#RRGGBB",Optional, font color.
⁣  "backgroundcolor": "#RRGGBB",Optional, frame background color.
⁣  "framecolor": "#RRGGBB",Optional, frame color.
⁣  "framewidth": <number>,Optional, frame width.
},
"collapseLayerGroupsBelowLevel": <level>,Optional, layer tree level below which to initially collapse groups. By default the tree is completely expanded.
"skipEmptyFeatureAttributes": <boolean>,Optional, whether to skip empty attributes in the identify results. Default is false.
"mapTips": <boolean>\|null,Optional, per-theme setting whether map-tips are unavailable (null), disabled by default (false) or enabled by default (true).
"extraLegendParameters": "<&KEY=VALUE>",Optional, additional query parameters to append to GetLegendGraphic request.
"extraDxfParameters": "<&KEY=VALUE>",Optional, additional query parameters to append to DXF export request.
"extraPrintParameters": "<&KEY=VALUE>",Optional, additional query parameters to append to GetPrint request (requires QGIS Server >= 3.32.0).
"printLabelBlacklist": ["<LabelId>", ...]Optional, list of composer label ids to not expose in the print dialog.
"editConfig": "<editConfig.json>"Optional, object or path to a filename containing the editing configuration for the theme, see Editing.
"snapping": {...},Optional, snapping configuration, see Snapping.
"config": {Optional, per-theme configuration entries which override the global entries in config.json, see Viewer Configuration.
⁣  "allowRemovingThemeLayers": <boolean>See config.json for which settings can be specified here.
⁣  ...
}
"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.
⁣  "username": <username>Optional: http basic authentication username.
⁣  "password": <password>Optional: http basic authentication password.
},
+

A bare minimum theme entry might look as follows:

+
{
+  "id": "theme_id",
+  "title": "My theme",
+  "url": "/ows/my_theme",
+  "mapCrs": "EPSG:3857",
+  "backgroundLayers": [{"name": "background_layer_name"}],
+  "searchProviders" ["coordinates"]
+}
+
+

Note:

+
    +
  • The theme identifier id can be freely defined and will appear in the viewer URL as the t query parameter.
    • +
  • When using qwc-docker, the url can be specified as /ows/<relative_path_to_qgs> where relative_path_to_qgs is the path to the QGIS project file below qwc-docker/volumes/qgs-resources, without the .qgs extension. In the above sample, the project file would be located at qwc-docker/volumes/qgs-resources/my_theme.qgs.
    • +
+

External layers

+

External layers can be used to selectively replace layers in a QGIS project with a layer from an external source, for instance in the case of a WMS layer embedded in a QGIS project, to avoid cascading WMS requests. They are handled transparently by QWC2 (they are positioned in the layer tree identically to the internal layer they replace), but the GetMap and GetFeatureInfo requests are sent directly to the specified WMS Service.

+

Configuring external layers via Data Url

+

The simplest way to define an external layer is to set the "Data Url" for a layer in QGIS (Layer Properties → QGIS Server → Data Url) to a string of these forms

+
wms:<service_url>?<options>#<layername>
+wmts:<capabilities_url>?<options>#<layername>
+
+

For instance:

+
wms:http://wms.geo.admin.ch?tiled=false&infoFormat=application/geojson#ch.are.bauzonen
+wmts:https://wmts10.geo.admin.ch/EPSG/2056/1.0.0/WMTSCapabilities.xml#ch.swisstopo.swissboundaries3d-gemeinde-flaeche.fill
+
+

Note: Support for WMTS in Data Url is currently only implemented when using qwc-docker.

+

Note: You can pass parameters which control the behaviour of the WMS client in QGIS Server by prefexing the parameters with extwms. when the layer is requested by QGIS Server, i.e. when printing. Example to override the step width/heigth of the QGIS WMS Client:

+
wms:http://wms.geo.admin.ch?extwms.stepWidth=4096&extwms.stepHeight=4096#ch.swisstopo.pixelkarte-farbe-pk1000.noscale
+
+

Manually configuring external layers

+

Rather than settin the "Data Url", you can provide a manual configuration in externalLayers in themesConfig.json as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EntryDescription
{
⁣  "name": "<external_layer_name>",The name of the external layer, as referenced in the theme definitions.
⁣  "type": "<layer_type>",Layer type, "wms" or "wmts"
⁣  "url": "<wms_baseurl>",The WMS URL or WMTS resource URL for the external layer.
}
+

For external WMS layers, the following additional parameters apply:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EntryDescription
"params": {Parameters for the GetMap request.
⁣  "LAYERS": "<wms_layername>,...",WMS layer names.
⁣  "OPACITIES": "<0-255>,..."Optional, if WMS server supports opacities.
},
"featureInfoUrl": "<wms_featureinfo_baseurl>",Optional, base URL for WMS GetFeatureInfo, if different from url.
"legendUrl": "<wms_legendgraphic_baseurl>" ,Optional, base URL for WMS GetLegendGraphic, if different from url.
"queryLayers": ["<wms_featureinfo_layername>", ...],Optional, list of GetFeatureInfo query layers, if different from params.LAYERS.
"infoFormats": ["<featureinfo_format>", ...]List of GetFeatureInfo query formats which the WMS service supports.
+

For external WMTS layers, the following additional parameters apply (you can use the qwc2/scripts/wmts_config_generator.py script to obtain these values):

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EntryDescription
"tileMatrixSet": "<tile_matrix_set_name>",The name of the tile matrix set.
"originX": <origin_x>,The X origin of the tile matrix.
"originY": <origin_y>,The Y origin of the tile matrix.
"projection": "EPSG:<code>",The layer projection.
"resolutions": [<resolution>, ...],The list of WMTS resolutions.
"tileSize": [<tile_width>, <tile_height>]The tile width and height.
+ +

You can specify links to display in an info-menu next to the respective theme title in the theme switcher entries.

+

The format for the theme info links is as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
EntryDescription
"name": "<link_name>",The name of the link, as referenced in the theme definitions.
"title": "<link_title>",The title for the link, as displayed in the info menu of the theme entry in the theme switcher.
"url": "<link>",A link URL.
"target": "<link_target>"The link target, i.e. _blank.
+

Background layers

+

Background layers are handled completely client-side and do not appear in the layer tree.

+

The format of the background layer definitions is as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EntryDescription
"name": "<Name>",The name of the background layer, used in the theme definitions.
"title": "<Title>",The title of the background layer, as displayed in the background switcher.
"titleMsgId": "<Title msgID>",Alternative to title, a message ID, translated through the translation files.
"thumbnail": "<Filename>",Optional, image file in assets/img/mapthumbs (see Viewer assets). Defaults to default.jpg.
"type": "<Type>",The background layer type, i.e. wms or wmts.
"attribution": "<Attribution>",Optional, attribution which will be shown in the bottom right corner of the map.
"attributionUrl": "<URL>",Optional, link associated to the attribution
"group": "<GroupId>",Optional, a group ID string. Background layers with the same group ID will be grouped together in the background switcher.
"minScale": <min_scale>,Optional, minimum scale denominator from which to render the layer.
"maxScale": <max_scale>,Optional, maximum scale denominator from which to render the layer.
<Layer params>Parameters according to the specified layer type. Refer to the sample themesConfig.json for some examples.
+

Note: You can use the helper python script located at qwc2/scripts/wmts_config_generator.py to easily generate WMTS background layer configurations.

+

Alternatively, WMS and WMTS background layers can also be defined specifiying a resource identifier, which will then be resolved at runtime. For example:

+
{
+    "name":"ch.swisstopo.pixelkarte-grau",
+    "title":"National map (gray)",
+    "resource": "wmts:https://wmts10.geo.admin.ch/EPSG/2056/1.0.0/WMTSCapabilities.xml#ch.swisstopo.pixelkarte-grau",
+    "thumbnail":"img/mapthumbs/default.jpg"
+}
+
+

A background layer definition can also be a group of layers, in the format

+
{
+  "name": "<Name>",
+  "title": "<Title>",
+  "type": "group",
+  "items": [
+    { <BackgroundLayerDefinition> },
+    { <BackgroundLayerDefinition> },
+    ...
+  ]
+}
+
+

Instead of specifiying a full background layer definition in a group, you can also reference an existing one with "ref": "<bg_layer_name>", and selectively override certain properties, such as minScale and maxScale:

+
{
+  ...
+  "items": [
+    {
+      "ref": "<bg_layer_name>",
+      "minScale": <min_scale>,
+      "maxScale": <max_scale>
+    },
+    ...
+  ]
+}
+
+

Generating the themes configuration

+

The file ultimately read by the QWC2 viewer is the themes.json configuration, which includes the contents of themesConfig.json completed with additional data obtained from the QGIS Project.

+
    +
  • +

    When using qwc-docker, you can generate the themes from the qwc-admin-gui administration backend, running on http://localhost:8088/qwc_admin by default. Log in as admin user, then press the green Generate service configuration button. This will invoce theqwc-config-generator, which will generate mapViewerConfig.json located below qwc-docker/volumes/config/<tentant>. You can then inspect the generated themes.json at http://localhost:8088/themes.json.

    +
    • +
  • +

    When using QWC2 as a standalone viewer, the themes.json can be generated by invoking

    +
    • +
+
yarn run themesconfig
+
+

Note: this command is automatically invoked when starting the development server via yarn start.

+

If working in an environment without node, using the equivalent command

+
python3 qwc2/scripts/themesConfig.py
+
+

If you want to manage multiple themesConfig.json files, you can specify which while should be processed by the theme generation script via the QWC2_THEMES_CONFIG environment variable.

+

Storing projects in database

+

When you are using qwc-docker, you can configure QWC to read the QGIS projects directly from the database. To do this, proceed as follows:

+
    +
  • Set up a PostgreSQL database connection in QGIS, checking the "Allow saving/loading QGIS projects in the database" option.
    • +
  • Save the project to the configured database in QGIS using Project → Save To → PostgreSQL.
    • +
  • Add a qgisprojects service definition for the used database to qwc-docker/pg_service.conf.
    • +
  • Write a theme configuration entry in themesConfig.json using with "url": "/ows/pg/<schema>/<projectname>", where schema and projectname as as specified when saving the project in QGIS.
    • +
+

Split categorized layers

+

When using qwc-docker, the qwc-config-generator has the ability to split a layer that has been classified with QGIS into multiple layers and move them into a new group (the group name will be the original layer name). To activate this functionality, follow these steps:

+
    +
  1. +

    Place the projects whose layers you want to split below qwc-docker/volumes/config-in/<tenant>/qgis_projects.

    +
    2. +
  2. +

    In the topolevel config in qwc-docker/volumes/config-in/<tenant>/tenantConfig.json, ensure qgis_projects_gen_base_dir is set and valid, and set "split_categorized_layers": true.

    +
    3. +
  3. +

    For all layers that you want to split, create the variable convert_categorized_layer and set it to true.

    +
    4. +
  4. +

    Generate the themes configuration. The qwc-config-generator will process the projects and write the modified projects to qgis_projects_gen_base_dir.

    +
    5. +
+

Note: Make sure you are using qwc-config-generator:v<version> and not qwc-config-generator:v<version>-noqgis.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/ViewerConfiguration/index.html b/configuration/ViewerConfiguration/index.html new file mode 100644 index 00000000..a64a2399 --- /dev/null +++ b/configuration/ViewerConfiguration/index.html @@ -0,0 +1,843 @@ + + + + + + + + Viewer - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • General configuration »
    • +
  • Viewer
    • +
  • +
    • +
+
+
+
+
+ +

QWC2 Viewer Configuration

+

This chapter describes how to customize the QWC2 viewer.

+

First of all, it is important to keep in mind that the QWC2 Viewer is designed to be a modular and highly customizeable application. Configuration falls into three categories:

+ +

The qwc2-demo-app (and the qwc-map-viewer-demo docker image) serve as a good starting point, and for simple viewers the load-time configuration options are often sufficient to avoid the need of building a customized application.

+

Load-time configuration config.json

+

The load-time configuration config.json configuration file contains global viewer settings as well as the viewer plugin configuration for mobile and desktop devices. It is located as follows:

+
    +
  • qwc-docker: qwc-docker/volumes/config-in/<tentant>/config.json
    • +
  • Standalone viewer: qwc2-app/static/config.json
    • +
+

Refer to the sample config.json for a concrete example.

+

Global settings

+

All settings are optional, with fallback to the default values as documented.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription
assetsPathRelative path to the assets folder. Default value: assets.
translationsPathRelative path to the translations folder. Default value: translations.
loadTranslationOverridesWhether to attempt to load tanslation overrides, see translations. Default value: false.
urlPositionFormatHow to encode the current map extent in the URL, either centerAndZoom or extent. See URL parameters for details. Default value: extent.
urlPositionCrsThe CRS used to encode the current map extent coordinates in the URL. Default value: the map projection.
omitUrlParameterUpdatesWhether to omit updating the URL parameters. Default value: false.
defaultFeatureStyleThe default style to use for selection geometries and other unstyled features. Default value: see qwc2/utils/FeatureStyles.js.
defaultMarkerStyleThe default style to use as marker icon. Default value: see qwc2/utils/FeatureStyles.js.
defaultInteractionStyleThe default style to use on geometries to measure, snap or edit. Default value: see qwc2/utils/FeatureStyles.js.
projectionsA list of map projections to register, in the format {"code": "<code>", "proj": "<proj4def>", "label": "<label>"}. By default, EPSG:3857 and EPSG:4326 are registered.
allowFractionalZoomWhether to allow arbitrary scales for viewing the map. Default value: false.
localeAwareNumbersWhether to use locale aware numbers throughout. Default value: false.
wmsHidpiWhether to honour the device pixel ratio for WMS GetMap requests. Default value: true.
wmsMaxGetUrlLengthURL length limit before switching to a POST request for GetMap and GetFeatureInfo. Default: 2048.
qgisServerVersionThe QGIS Server major version in use, defaults to 3.
defaultColorSchemeThe color scheme to use. See Color schemes for details.
startupTaskTask to automatically aktivate on application start, in the format {key: "<Task>", "mode": "<Mode>"}.
storeAllLayersInPermalinkWhether 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).
+

Global settings, overridable per theme

+

The following options can be specified globally, and also overriden per theme, see themesConfig.json. +All settings are optional, with fallback to the default values as documented.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription
preserveExtentOnThemeSwitchWhether to preserve the current map extent when switching theme, if possible (see below). Default value: false.
preserveBackgroundOnThemeSwitchWhether to preserve the current background layer when switching theme, if possible. Default value: false.
preserveNonThemeLayersOnThemeSwitchWhether to preserve non-theme layers when switching theme. Default value: false.
allowReorderingLayersWhether to allow re-ordering layers in the layer tree. Default value: false.
flattenLayerTreeGroupsWhether to display a flat layer tree, omitting the groups. Default value: false.
allowLayerTreeSeparatorsAllows users to add separator items in a flat layer tree. Default value: false.
preventSplittingGroupsWhenReorderingWhether to prevent splitting sibling groups or the group itself when reordering items. Default value: false.
allowRemovingThemeLayersWhether to allow removing any theme layers from the layer tree. Default value: false.
searchThemesWhether allow searching for themes from the global search field. Default value: false.
allowAddingOtherThemesWhether to allow adding another theme to a currently loaded theme. Default value: false.
disableImportingLocalLayersWhether to hide the option to import local layers from the layer tree. Default value: false.
importLayerUrlPresetsA 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>"}.
identifyToolThe name of the identify plugin to use. It is possible to have multiple identify tools, and i.e. on a per-theme basis select which one is active. Default value: Identify.
globallyDisableDockableDialogsWhether to globally disable the dockable feature of popup dialogs. Default value: false.
globallyDisableMaximizeableDialogsWhether to globally disable the maximizeable feature of popup dialogs. Default value: false.
+

Note:

+
    +
  • The layer tree supports re-ordering layers via drag-and-drop if allowReorderingLayers = true and either preventSplittingGroupsWhenReordering = true or flattenLayerTreeGroups = true.
    • +
  • If preserveExtentOnThemeSwitch = true, the current extent is preserved if it is within the new theme extent and if the current theme map projection is equal to the new theme projection. If preserveExtentOnThemeSwitch = "force", the current extent is preserved regardless of whether it is within the new theme extent, but the current and new theme map projections must still match.
    • +
+

URLs of external services

+

Some plugins require external services (typically part of the qwc-services ecosystem). When using the qwc-docker, these configuration entries will be automatically injected into the config.json for enabled services.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription
authServiceUrlTypically the URL of a QWC authentication service like qwc-db-auth.
editServiceUrlTypically the URL of the qwc-data-service.
elevationServiceUrlTypically the URL of the qwc-elevation-service.
mapInfoServiceTypically the URL of the qwc-map-info-service.
permalinkServiceUrlTypically the URL of the qwc-permalink-service.
searchServiceUrlTypically the URL of the qwc-fulltext-search-service.
featureReportServiceTypically the URL of the qwc-document-service.
+

Plugin configuration

+

The plugin configuration is entered as follows:

+
"plugins": {
+  "common": [{<PluginConfig>}, ...],
+  "mobile": [{<PluginConfig>}, ...],
+  "desktop": [{<PluginConfig>}, ...]
+}
+
+

The final mobile and desktop configurations will be computed by merging the common configuration with the respective specific configuration. Each <PluginConfig> block is of the format

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription
{
⁣  "name": "<name>",The plugin name.
⁣  "cfg": {...},The plugin configuration options, see plugin reference.
⁣  "mapClickAction": <"identify"|"unset"|null>,Optional: in case the plugin activates a viewer task, determines whether a click in the map will result in the identify tool being invoked, the task being unset, or whether no particular action should be performed (default).
}
+

A particularly interesting aspect is the configuration of the entries in the application menu and toolbar, i.e. the entries in menuItems and toolbarItems in the TopBar plugin configuration. The format of these entries is as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription
{
⁣  "key": "<key>",The name of a plugin, i.e. LayerTree. The label for the entry will be looked up from the translations using the appmenu.items.<key> message identifier (see Managing translations).
⁣  "icon": "<icon>",The icon of the entry, either a built-in icon name (see below), or :/<path_to_asset> containing the path relative to assetsPath of an asset image.
⁣  "themeBlacklist": ["<themename>", ...],Optional, allows specifying a blacklist of theme names or titles for which the entry should not be visible.
⁣  "themeWhitelist": ["<themename>", ...],Optional, allows specifying a whitelist of theme names or titles for which the entry should be visible.
⁣  "mode": "<mode>",Optional, depending on the plugin, a mode can be configured to launch the plugin directly in a specific mode. For instance, the Measure plugin supports specifying the measurement mode (Point, LineString, Polygon).
⁣  "requireAuth": "<true|false>",Optional, the entry is only visible when user is logged-in.
⁣  "shortcut": "<shortcut>"Optional, keyboard shortcut which triggers the entry, i.e. "alt+shift+a".
}
+

Note: The built-in icons are those located in qwc2-app/qwc2/icons and in qwc2-app/icons. The built-in icon names are the respective file names, without .svg extension.

+

Opening external websites

+

As a special case, entries for opening external URLs can be defined as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription
{
⁣  "key": "<key>",An arbitrary key (not used by existing plugins), used to lookup the label for the entry from the translations.
⁣  "icon": "<icon>",As above.
⁣  "url": "<url>",The URL to open. Can contain as placeholders the keys listed in URL Parameters, encolsed in $ (i.e. $e$ for the extent). In addition, the placeholders $x$ and $y$ for the individual map center coordinates are also supported.
⁣  "target": "<target>"The target where to open the URL, if empty, _blank is assumed. Can be iframe to open the link in a iframe window inside QWC2.
}
+

In general, the procedure for enabling a plugin is:

+
    +
  • Make sure the plugin is compiled into the application (see Build-time configuration).
    • +
  • In the plugins section of config.json, below common (or mobile and/or desktop), add an entry
    • +
+
{
+    "name": "<Plugin name>",
+    "cfg": {
+      <Plugin configuration props>
+    }
+}
+
+
    +
  • For most plugins (i.e. those which launch as an explicit task in the viewer), add entries in menuItems and/or toolbarItems as desired, i.e.
    • +
+
  "menuItems": [
+    ...
+    {"key": "<Plugin name>", "icon": "<icon name>", ...}
+  ]
+
+

Customizing the viewer assets

+

The viewer assets are located as follows:

+
    +
  • Standalone viewer: qwc2-app/static/assets
    • +
  • qwc-docker: qwc-docker/volumes/qwc2/assets
    • +
+

The default structure of the assets folder is as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathDescription
└─ assets/See Viewer assets
├─ css/Additional style sheets, must be included by index.html.
│ ├─ colorschemes.cssAdditional color schemes.
│ └─ qwc2.cssAdditional style definitions.
├─ img/Application logo etc.
│ ├─ genmapthumbs/Autogenerated map thumbnails.
│ └─ mapthumbs/Map thumbnails.
├─ templates/
│ └─ legendprint.htmlHTML template for the legend print.
├─ help.htmlHelp dialog fragment, see Help dialog.
└─ searchProviders.jsAdditional search providers, see Search providers.
+

Furthermore, the application entry point index.html is located as follows:

+
    +
  • Standalone viewer: qwc2-app/index.html
    • +
  • qwc-docker: qwc-docker/volumes/config-in/<tenant>/index.html
    • +
+

This file noteably specifies the application title, and references many of the assets located below the assets folder.

+

Customizing the color scheme

+

The QWC2 color scheme is fully customizeable via CSS. A default color-scheme is built-in (see DefaultColorScheme.css). To define a custom color scheme, copy the default color scheme to assets/css/colorschemes.css, add an appropriate class name to the :root selector, and modify the colors as desided. Two additional examples (highcontrast and dark) are provided by default inassets/css/colorschemes.css.

+

You can then modify the color scheme which is applied by default by setting defaultColorScheme in config.json to an appropriate class name (i.e. highcontrast or dark).

+

To change the color scheme at runtime in QWC2, make sure the Settings plugin is enabled, and in the Settings plugin configuration block in config.json list the color schemes below colorSchemes. Refer to the sample config.json.

+

Note: When changing the color scheme via Settings dialog in QWC2, the picked color scheme is stored in the browser local storage, and this setting will override the defaultColorScheme setting from config.json. Specifying thestyle` URL-parameter (see URL parameters) will take precedence over all other settings.

+

Note: Make sure that assets/css/colorschemes.css is included in index.html.

+

Overriding component styles

+

Occasionally, it may be desired to customize the styling on the QWC2 components. The recommended approach is to add the corresponding style overrides to assets/css/qwc2.css.

+

Note: Make sure that assets/css/qwc2.css is included in index.html.

+ +

The application logo in its various shapes and sizes are located below assets/img/. In particular, the logo.svg and logo-mobile.svg images are displayed as in the top left corner of QWC2 in desktop and mobile mode respectively. If you'd like to use another format than SVG (while keeping logo and logo-mobile as base name), you can change logoFormat in the TopBar configuration block in config.json.

+

Providing custom map thumbnails

+

By default, when generating the themes configuration (see [ThemesConfiguration.md#generating-theme-configuration]), a default map thumbnail is generating via WMS GetMap, and placed below assets/img/genmapthumbs. You can provide your own thumbnail images instead by placing the corresponding images below assets/img/mapthumbs and referencing these as thumbnail in you theme configuration block in themesConig.json.

+

Personalizing the help dialog

+

You can personalize the help dialog by providing a plain HTML document fragment in static/assets/help.html and configuring the Help plugin accordingly in config.json:

+
{
+  "name": "Help",
+  "cfg": {
+    "bodyContentsFragmentUrl": "assets/help.html"
+  }
+}
+
+

Note: $VERSION$ can be used in the HTML document fragment as a placeholder for the application build date.

+

Personalizing the legend print template

+

The legend print template assets/templates/legendprint.html is used when printing the map legend from the layer tree. The only requirement for this template is that is must contain a <div id="legendcontainer"></div> element.

+

Building a custom viewer

+

QWC2 is divided into two repositories:

+ +

To build a custom viewer, the first step is cloning the demo application:

+
git clone --recursive https://github.com/qgis/qwc2-demo-app.git qwc2-app
+
+

The typical layout of a QWC2 app source tree is as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathDescription
├─ static/
│ ├─ assets/See Viewer assets
│ ├─ translations/Translation files.
│ ├─ config.jsonMaster configuration file.
│ └─ themes.jsonFull theme configuration, autogenerated from themesConfig.json.
├─ js/
│ ├─ app.jsxEntry point of the ReactJS application.
│ ├─ appConfig.jsConfiguration of the qwc2 core modules.
│ ├─ Help.jsxBuilt-in component of custom Help dialog, see Help dialog.
│ └─ SearchProviders.jsBuilt-in custom search providers, see Search providers.
├─ icons/Application icons.
├─ qwc2/Git submodule containing the core qwc2 components.
├─ index.htmlEntry point.
├─ package.jsonNodeJS configuration file.
├─ themesConfig.jsonThemes configuration.
└─ webpack.config.jsWebpack configuration.
+

Application build-time configuration

+

The js/appConfig.js is the the principal build-time configuation file, and defines: +- The default application locale, built into the application. This locale is used if no available locale matches the browser locale. +- Which plugins are built into the application. Plugins left out here will be completely omitted when compiling the application bundle, and will hence also reduce the size of the bundle. +- Various hook functions, as documented in the sample sample js/appConfig.js.

+

Refer to the sample appConfig.js for a concrete example.

+

Overriding icons

+

The common application icons are located in qwc2/icons. They can be overridden by creating an icon with the same filename in the application specific icons folder.

+

Note: The icons in the icons folder are compiled into an icon font. The icons need to be black content on transparent background, and all drawings (including texts) must be converted to paths for the icons to render correctly.

+

Compiling an application bundle

+

After tweaking the source files as desired, compile a deployable application bundle for production running

+
yarn run prod
+
+

When using qwc-docker, copy the contents of the qwc2-app/prod folder to qwc-docker/volumes/qwc2 and edit the qwc-docker/docker-compose.yml to use qwc-map-viewer-base with your custom build:

+
qwc-map-viewer:
+  image: sourcepole/qwc-map-viewer-base:vYYYY.MM.DD
+  environment:
+    <<: *qwc-service-variables
+    SERVICE_MOUNTPOINT: '/'
+  volumes:
+    - ./pg_service.conf:/srv/pg_service.conf:ro
+    - ./volumes/config:/srv/qwc_service/config:ro
+    - ./volumes/qwc2:/qwc2:ro
+
+

Keeping the QWC2 application up to date

+

As mentioned above, QWC2 is split into a common components repository and an application specific repository. The goal of this approach is to cleanly separate user-specific configuration and components which common components which serve as a basis for all QWC2 applications, and to make it as easy as possible to rebase the application onto the latest common QWC2 components.

+

The recommended workflow is to keep the qwc2 folder a submodule referencing the upstream qwc2 repository. To update it, just checkout/update the desired branch:

+
cd qwc2
+git checkout master
+# or
+git checkout YYYY-lts
+git pull
+
+

The QWC2 Upgrade Notes documents major changes, and in particular all incompatible changes between releases which require changes to the application specific code and/or configuration.

+

Translations

+

This section gives an overview of the common tasks related to the QWC2 translations.

+

Switching language

+

By default, QWC2 will attempt to load the translation matching your browser language. Alternatively, you can explicitly specify the language by adding the lang=<lang> query parameter to the application URL, i.e. lang=de-CH.

+

The Settings plugin furthermore allows graphically switching the language within QWC2.

+

Adding and modify translations

+

When working inside a qwc2-app source folder, the translations can be found on two levels:

+
    +
  • At QWC2 components level, in qwc2-app/qwc2/translations.
    • +
  • At application level, in qwc2-app/static/translations.
    • +
+

A script will take care of merging the component translations into the application translations. This way, when updating the QWC2 submodule, new translations are automatically obtained. This script is automatically invoked on yarn start, but can also be manually invoked using

+
yarn run tsupdate
+
+

Translations are stored inside the respective translations folder as regular plain-text JSON files, named <lang>.json and can be freely edited with any text editor.

+

The tsconfig.json files stored inside the respective translations folder contains the list of languages for which translations should be generated and a list of message IDs to include in the translation. The tsupdate script will automatically scan the code for message IDs (looking for static strings passed to LocaleUtils.tr and LocaleUtils.trmsg), store these in tsconfig.json and automatically create resp. update the translation files.

+

In some cases tsconfig.json will not pick up a message ID (for instance, if it is computed at runtime). In these cases, the message IDs can be added manually to the extra_strings section of the tsconfig.json.

+

Also it may be desired to override a translation inherited from the QWC2 components at application level. To prevent tsupdate from continuously reverting the overridden translation, the respective message IDs can be added to the overrides section in the application tsconfig.json file.

+

To add a new language, list it in qwc2-app/qwc2/translations/tsconfig.json and run yarn run tsupdate, then complete the messages taking the english translation file as reference.

+

When adding or modifying translations at QWC2 components level, please contribute them by submitting a pull request to the upstream qwc2 repository.

+

Selectively overriding translation strings

+

Occasionally, it is desireable to selectively override specific translation strinsg. While one can modify the full translation file as described above, especially when using the qwc-map-viewer-demo docker image, it is easier to just selectively override the desired translation strings and leave the original file unchanged and avoid having to compile a custom viewer (or overwriting the entire file with a docker volume mount).

+

To do this:

+
    +
  • Set loadTranslationOverrides to true in config.json.
    • +
  • Create a <lang>_overrides.json containing just the ovverridden strings, for example en-US_overrides.json:
    • +
+
{
+  "messages": {
+    "appmenu": {
+      "items": {
+        "LayerTree": "Layers"
+      }
+    }
+  }
+}
+
+
    +
  • Place this file inside the translations folder of your production build. When using qwc-docker, you can place this file in qwc-docker/volumes/qwc2/translations/ and mount this file inside the container, i.e. :
    • +
+
qwc-map-viewer:
+  image: sourcepole/qwc-map-viewer-demo:vYYYY.MM.DD
+  [...]
+  volumes:
+    - ./volumes/qwc2/translations/en-US_overrides.json:/qwc2/translations/en-US_overrides.json:ro
+
+

Specifying the default fallback translation

+

When no translation exists for the requested language (i.e. the current browser language), QWC2 will fall back to the default translation specified as defaultLocaleData in qwc2-app/js/appConfig.js. For the demo viewer, the default fallback translation is en-US.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/css/custom.css b/css/custom.css new file mode 100644 index 00000000..0b5185ac --- /dev/null +++ b/css/custom.css @@ -0,0 +1,14 @@ +/* Use full available screen width */ +.wy-nav-content { + max-width: initial!important; +} + +/* Normal word-wrapping inside tables to prevent table overflowing screen width */ +.wy-table-responsive table td, .wy-table-responsive table th { + white-space: initial!important; +} + +img[src$="centerme"] { + display:block; + margin: 0 auto; +} diff --git a/css/fonts/Roboto-Slab-Bold.woff b/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/css/fonts/Roboto-Slab-Bold.woff2 b/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/css/fonts/Roboto-Slab-Regular.woff b/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/css/fonts/Roboto-Slab-Regular.woff2 b/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/css/fonts/fontawesome-webfont.eot b/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/css/fonts/fontawesome-webfont.eot differ diff --git a/css/fonts/fontawesome-webfont.svg b/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/css/fonts/fontawesome-webfont.ttf b/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/css/fonts/fontawesome-webfont.ttf differ diff --git a/css/fonts/fontawesome-webfont.woff b/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/css/fonts/fontawesome-webfont.woff differ diff --git a/css/fonts/fontawesome-webfont.woff2 b/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/css/fonts/fontawesome-webfont.woff2 differ diff --git a/css/fonts/lato-bold-italic.woff b/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/css/fonts/lato-bold-italic.woff differ diff --git a/css/fonts/lato-bold-italic.woff2 b/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/css/fonts/lato-bold-italic.woff2 differ diff --git a/css/fonts/lato-bold.woff b/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/css/fonts/lato-bold.woff differ diff --git a/css/fonts/lato-bold.woff2 b/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/css/fonts/lato-bold.woff2 differ diff --git a/css/fonts/lato-normal-italic.woff b/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/css/fonts/lato-normal-italic.woff differ diff --git a/css/fonts/lato-normal-italic.woff2 b/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/css/fonts/lato-normal-italic.woff2 differ diff --git a/css/fonts/lato-normal.woff b/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/css/fonts/lato-normal.woff differ diff --git a/css/fonts/lato-normal.woff2 b/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/css/fonts/lato-normal.woff2 differ diff --git a/css/theme.css b/css/theme.css new file mode 100644 index 00000000..7e03995c --- /dev/null +++ b/css/theme.css @@ -0,0 +1,13 @@ +/* + * This file is copied from the upstream ReadTheDocs Sphinx + * theme. To aid upgradability this file should *not* be edited. + * modifications we need should be included in theme_extra.css. + * + * https://github.com/readthedocs/sphinx_rtd_theme + */ + + /* sphinx_rtd_theme version 1.0.0 | MIT license */ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} diff --git a/css/theme_extra.css b/css/theme_extra.css new file mode 100644 index 00000000..9f4b063c --- /dev/null +++ b/css/theme_extra.css @@ -0,0 +1,191 @@ +/* + * Wrap inline code samples otherwise they shoot of the side and + * can't be read at all. + * + * https://github.com/mkdocs/mkdocs/issues/313 + * https://github.com/mkdocs/mkdocs/issues/233 + * https://github.com/mkdocs/mkdocs/issues/834 + */ +.rst-content code { + white-space: pre-wrap; + word-wrap: break-word; + padding: 2px 5px; +} + +/** + * Make code blocks display as blocks and give them the appropriate + * font size and padding. + * + * https://github.com/mkdocs/mkdocs/issues/855 + * https://github.com/mkdocs/mkdocs/issues/834 + * https://github.com/mkdocs/mkdocs/issues/233 + */ +.rst-content pre code { + white-space: pre; + word-wrap: normal; + display: block; + padding: 12px; + font-size: 12px; +} + +/** + * Fix code colors + * + * https://github.com/mkdocs/mkdocs/issues/2027 + */ +.rst-content code { + color: #E74C3C; +} + +.rst-content pre code { + color: #000; + background: #f8f8f8; +} + +/* + * Fix link colors when the link text is inline code. + * + * https://github.com/mkdocs/mkdocs/issues/718 + */ +a code { + color: #2980B9; +} +a:hover code { + color: #3091d1; +} +a:visited code { + color: #9B59B6; +} + +/* + * The CSS classes from highlight.js seem to clash with the + * ReadTheDocs theme causing some code to be incorrectly made + * bold and italic. + * + * https://github.com/mkdocs/mkdocs/issues/411 + */ +pre .cs, pre .c { + font-weight: inherit; + font-style: inherit; +} + +/* + * Fix some issues with the theme and non-highlighted code + * samples. Without and highlighting styles attached the + * formatting is broken. + * + * https://github.com/mkdocs/mkdocs/issues/319 + */ +.rst-content .no-highlight { + display: block; + padding: 0.5em; + color: #333; +} + + +/* + * Additions specific to the search functionality provided by MkDocs + */ + +.search-results { + margin-top: 23px; +} + +.search-results article { + border-top: 1px solid #E1E4E5; + padding-top: 24px; +} + +.search-results article:first-child { + border-top: none; +} + +form .search-query { + width: 100%; + border-radius: 50px; + padding: 6px 12px; /* csslint allow: box-model */ + border-color: #D1D4D5; +} + +/* + * Improve inline code blocks within admonitions. + * + * https://github.com/mkdocs/mkdocs/issues/656 + */ + .rst-content .admonition code { + color: #404040; + border: 1px solid #c7c9cb; + border: 1px solid rgba(0, 0, 0, 0.2); + background: #f8fbfd; + background: rgba(255, 255, 255, 0.7); +} + +/* + * Account for wide tables which go off the side. + * Override borders to avoid weirdness on narrow tables. + * + * https://github.com/mkdocs/mkdocs/issues/834 + * https://github.com/mkdocs/mkdocs/pull/1034 + */ +.rst-content .section .docutils { + width: 100%; + overflow: auto; + display: block; + border: none; +} + +td, th { + border: 1px solid #e1e4e5 !important; /* csslint allow: important */ + border-collapse: collapse; +} + +/* + * Without the following amendments, the navigation in the theme will be + * slightly cut off. This is due to the fact that the .wy-nav-side has a + * padding-bottom of 2em, which must not necessarily align with the font-size of + * 90 % on the .rst-current-version container, combined with the padding of 12px + * above and below. These amendments fix this in two steps: First, make sure the + * .rst-current-version container has a fixed height of 40px, achieved using + * line-height, and then applying a padding-bottom of 40px to this container. In + * a second step, the items within that container are re-aligned using flexbox. + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ + .wy-nav-side { + padding-bottom: 40px; +} + +/* + * The second step of above amendment: Here we make sure the items are aligned + * correctly within the .rst-current-version container. Using flexbox, we + * achieve it in such a way that it will look like the following: + * + * [No repo_name] + * Next >> // On the first page + * << Previous Next >> // On all subsequent pages + * + * [With repo_name] + * Next >> // On the first page + * << Previous Next >> // On all subsequent pages + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ +.rst-versions .rst-current-version { + padding: 0 12px; + display: flex; + font-size: initial; + justify-content: space-between; + align-items: center; + line-height: 40px; +} + +/* + * Please note that this amendment also involves removing certain inline-styles + * from the file ./mkdocs/themes/readthedocs/versions.html. + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ +.rst-current-version span { + flex: 1; + text-align: center; +} diff --git a/images/overview.png b/images/overview.png new file mode 100644 index 00000000..104754ae Binary files /dev/null and b/images/overview.png differ diff --git a/images/qwc-services-arch.png b/images/qwc-services-arch.png new file mode 100644 index 00000000..17691190 Binary files /dev/null and b/images/qwc-services-arch.png differ diff --git a/images/qwc2.png b/images/qwc2.png new file mode 100644 index 00000000..be3a3ca7 Binary files /dev/null and b/images/qwc2.png differ diff --git a/images/search.png b/images/search.png new file mode 100644 index 00000000..4186f44b Binary files /dev/null and b/images/search.png differ diff --git a/images/timemanager.jpg b/images/timemanager.jpg new file mode 100644 index 00000000..aa52f9e1 Binary files /dev/null and b/images/timemanager.jpg differ diff --git a/images/viewer.jpg b/images/viewer.jpg new file mode 100644 index 00000000..49165bb5 Binary files /dev/null and b/images/viewer.jpg differ diff --git a/img/favicon.ico b/img/favicon.ico new file mode 100644 index 00000000..e85006a3 Binary files /dev/null and b/img/favicon.ico differ diff --git a/index.html b/index.html new file mode 100644 index 00000000..be059c62 --- /dev/null +++ b/index.html @@ -0,0 +1,231 @@ + + + + + + + + Home - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Home
    • +
  • +
    • +
+
+
+
+
+ +

QWC2 / QWC Services

+

QWC2

+

QGIS Web Client 2 (QWC2) is a modular next generation responsive web client for QGIS Server, built with ReactJS and OpenLayers.

+

Overview

+

The core concept of QWC2 is to display QGIS Projects which are published by QGIS Server via WMS.

+

There are two ways to run QWC2:

+
    +
  • As part of the qwc-services ecosystem, includes additional services to which includes additional services to extend the viewer functionality (such as user administration, editing, etc.). This is the recommended approach.
    • +
  • As a standalone viewer (static JS/HTML/CSS web application) on top of QGIS Server.
    • +
+

QWC2 with qwc-servies on the backend provide a complete Web GIS infrastructure.

+

Overview of functionalities

+

Without any additional services, the stock QWC2 offers the following main functionalities:

+
    +
  • Theme switcher (a theme is a published QGIS project)
    • +
  • Switchable background layers
    • +
  • Layer tree
    • +
  • Object information (feature info)
    • +
  • Search with configurable providers
    • +
  • Measurement tools
    • +
  • Redlining (sketching)
    • +
  • URL sharing
    • +
  • Geolocation
    • +
  • PDF printing
    • +
  • Raster and DXF export
    • +
  • Compare layers
    • +
  • Import external layers (WMS, WFS, WMTS, KML, GeoJSON)
    • +
+

When run as part of the qwc-services ecosystem, the following additional viewer functionalities are available:

+
    +
  • User administration
    • +
  • Editing
    • +
  • Fulltext search
    • +
  • Compact permalinks
    • +
  • Height profile
    • +
  • Custom feature info templates
    • +
  • Mapinfo popup
    • +
  • Reports (via Jasper)
    • +
+

qwc-services also provides the following enterprise relevant functionalities:

+
    +
  • Docker/Kubernetes or WSGI deployments
    • +
  • Multi-tenant setup
    • +
  • Custom service integration
    • +
  • Multiple authentication backends
    • +
+

Explore

+ +

Support

+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + + Next » + + +
+ + + + + + + + diff --git a/js/html5shiv.min.js b/js/html5shiv.min.js new file mode 100644 index 00000000..1a01c94b --- /dev/null +++ b/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); diff --git a/js/jquery-3.6.0.min.js b/js/jquery-3.6.0.min.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/js/jquery-3.6.0.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t + + + + + + + References - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • References
    • +
  • +
    • +
+
+
+
+
+ +

References

+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/references/qwc-admin-gui/index.html b/references/qwc-admin-gui/index.html new file mode 100644 index 00000000..f7c2c845 --- /dev/null +++ b/references/qwc-admin-gui/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc admin gui - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc admin gui
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Admin GUI

+

QWC Admin GUI

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-admin-gui/master/schemas/qwc-admin-gui.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "admin-gui"

root config
Type: object

root config db_url
Type: string

DB connection URL

root config config_generator_service_url
Type: string

Config generator URL

root config totp_enabled
Type: boolean

Show TOTP fields for two factor authentication

root config user_info_fields
Type: array of object

Additional user fields

 No Additional Items

Each item of this array must be:

root config user_info_fields user_info_fields items
Type: object

root config proxy_url_whitelist
Type: array of object

List of RegExes for whitelisted URLs

 No Additional Items

Each item of this array must be:

root config proxy_url_whitelist proxy_url_whitelist items
Type: object

root config proxy_timeout
Type: integer

Timeout in seconds for proxy requests

root config admin_gui_title
Type: string

Title displayed in Admin Gui home page

root config admin_gui_subtitle
Type: string

Subtitle displayed in Admin Gui home page

root config solr_service_url
Type: string

Solr Service base URL for collection

root config solr_tenant_dih
Type: string

Solr DataImportHandler for tenant

root config solr_tenant_dih_config_file
Type: string

Path to source DataImportHandler config file for tenant

root config solr_config_path
Type: string

Path to Solr configs

root config solr_update_check_wait
Type: number

Wait time in seconds for checks during Solr index update

root config solr_update_check_max_retries
Type: integer

Max number of retries for checks during Solr index update

root config plugins
Type: array of string

List of plugins to load

 No Additional Items

Each item of this array must be:

root config plugins plugins items
Type: string

root config input_config_path
Type: string

The path to the input configs. Required for 'themes' and 'config_editor' plugin.

root config qwc2_path
Type: string

The path to QWC2 files. Required for 'themes' and 'alkis' plugins.

root config qgs_resources_path
Type: string

The path to the QGIS projects. Required for 'themes' plugin.

root config info_templates_path
Type: string

The path to the html info templates. Required for 'themes' plugin.

root config ows_prefix
Type: string

The OGC service URL path prefix, i.e. /ows. Required for 'themes' plugin.

root config default_qgis_server_url
Type: string

The default Qgis server URL. Required for 'themes' plugin.
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-config-generator/index.html b/references/qwc-config-generator/index.html new file mode 100644 index 00000000..9125112c --- /dev/null +++ b/references/qwc-config-generator/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc config generator - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc config generator
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Config generator

+

QWC Config generator

Type: object

root $schema
Type: stringFormat: uri Default: "https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "config-generator"

root template
Type: string

root themesConfig

root themesConfig oneOf item 0
Type: object

Corresponds to contents of standalone QWC2 themesConfig.json

root themesConfig oneOf item 0 themes
Type: object
root themesConfig oneOf item 1
Type: string

Path to themesConfig.json

root config
Type: object

root config tenant
Type: string

Tenant name. Example: default

root config config_db_url
Type: stringFormat: uri

Connection URL for configuration database. Example: postgresql:///?service=qwc_configdb

root config default_qgis_server_url
Type: stringFormat: uri

Default QGIS Server URL for OGC requests. Example: http://qwc-qgis-server/ows/

root config ows_prefix
Type: string

OWS service path prefix. Defaults to the path component of defaultqgisserverurl. Used to form the urls of autodetected projects below qgisprojectsscanbase_dir. Example: /ows

root config qgis_projects_base_dir
Type: string

Base path for QGIS projects. Example: /data

root config qgis_projects_scan_base_dir
Type: string

Path for QGIS projects, which should be automatically detected. Must be a subdir qgisprojectsbase_dir. Example: /data/scan

root config qgis_projects_gen_base_dir
Type: string

Path for generated QGIS projects, result of preprocessing. Must be a subdir of qgisprojectsbasedir. Can be the same as qgisprojectsscanbase_dir, in which case the theme autodetection will apply to generated QGIS projects. Example: /data/gen

root config permissions_default_allow
Type: boolean

Set whether resources are permitted or restricted by default. Example: true

root config validate_schema
Type: boolean

Validate configuration against schema. Example: true

root config config_path
Type: string

Target path for generated service configs and permissions, if not set by $OUTPUTCONFIGPATH. Example: /config-out

root config qwc2_base_dir
Type: string

Path to the QWC2 directory, which will be used to autodetect thumbnails. If qgisprojectsscanbasedir is not set, then this option will be ignored. Example /qwc2

root config skip_print_layer_groups
Type: boolean

Skip group layers containing print layers

root config layer_opacities
Type: object

Layer opacity values for QGIS <= 3.10

root config split_categorized_layers
Type: boolean

Set to true to activate the categorize groups functionality

root config project_settings_read_timeout
Type: number

Timeout for GetProjectSettings, GetCapabilities and DescribeFeatureType requests. Default: 60sec

root config autogen_keyvaltable_datasets
Type: boolean

Whether to automatically generate data service datasets used for key-value relationships without requiring corresponding data resources to be created. Warning: this will expose the key and value fields of the key-value table as world readable. Default: false

root config generate_wfs_services
Type: boolean

Generate WFS service resources and permissions for the OGC service. Default: false

root services
Type: array

Service specific config options for generating their service configs

 No Additional Items

Each item of this array must be:

root services services items

Generator config for a service

root services services items oneOf common_service
Type: object

Generator config for a QWC service

root services services items oneOf item 0 name
Type: enum (of string)

Service name

Must be one of:

  • "adminGui"
  • "data"
  • "dbAuth"
  • "elevation"
  • "featureInfo"
  • "mapinfo"
  • "permalink"
  • "print"
  • "search"
  • "legend"

root services services items oneOf item 0 config
Type: object

QWC service config options (cf. its JSON schema). This is copied unmodified to the service config.
root services services items oneOf mapViewer
Type: object

Generator config for Map Viewer

root services services items oneOf item 1 name
Type: const

Service name

Specific value: "mapViewer"

root services services items oneOf item 1 generator_config
Type: object

Additional config for generating MapViewer resources

root services services items oneOf item 1 generator_config qwc2_config
Type: object

Additional config for QWC2 application configuration

root services services items oneOf item 1 generator_config qwc2_config qwc2_config_file
Type: string

Path to QWC2 config.json file. Example: /qwc2/config.json

root services services items oneOf item 1 generator_config qwc2_config qwc2_index_file
Type: string

Path to QWC2 index.html file. Example: /qwc2/index.html

root services services items oneOf item 1 config
Type: object

Map Viewer config options (cf. JSON schema qwc-map-viewer.json). This is copied unmodified to the service config.
root services services items oneOf ogc
Type: object

Generator config for OGC service

root services services items oneOf item 2 name
Type: const

Service name

Specific value: "ogc"

root services services items oneOf item 2 generator_config
Type: object

Additional config for generating OGC service resources

root services services items oneOf item 2 generator_config wms_services
Type: object

Additional config for WMS services

root services services items oneOf item 2 generator_config wms_services online_resources
Type: object

Custom OnlineResources shown in GetCapabilities

root services services items oneOf item 2 generator_config wms_services online_resources service
Type: stringFormat: uri

Default public base URL for OnlineResources

root services services items oneOf item 2 generator_config wms_services online_resources feature_info
Type: stringFormat: uri

Public base URL for FeatureInfo OnlineResources

root services services items oneOf item 2 generator_config wms_services online_resources legend
Type: stringFormat: uri

Public base URL for Legend OnlineResources

root services services items oneOf item 2 config
Type: object

OGC service config options (cf. JSON schema qwc-ogc-service.json). This is copied unmodified to the service config.
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-data-service/index.html b/references/qwc-data-service/index.html new file mode 100644 index 00000000..c84c8e47 --- /dev/null +++ b/references/qwc-data-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc data service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc data service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Data Service

+

QWC Data Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://github.com/qwc-services/qwc-data-service/raw/master/schemas/qwc-data-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "data"

root config
Type: object

root config attachments_base_dir
Type: string

Base dir where attachments are stored

root config allowed_attachment_extensions
Type: string

Comma separated list of allowed attachment file extensions, i.e. '.png,.jpg'

root config max_attachment_file_size
Type: number

Maximum attachment file size in bytes

root config clamd_host
Type: string

Hostname of ClamD server listening on TCP port 3310. If set, uploaded files are checked by ClamAV

root config upload_user_field_suffix
Type: string

Field suffix where to log the username who last changed an upload field, i.e. __ for the field . If empty, username is not logged.

root config edit_timestamp_field
Type: string

If specified, the timestamp of the last mutation to a record will be logged to the field of the record.

root config edit_user_field
Type: string

If specified, the username of the last user who performed a mutation to a record with be logged to the field of the record.

root config geometry_default_allow_null
Type: boolean

Whether to allow null geometries by default

root config allowed_extensions_per_dataset
Type: object

Loopup of allowed attachment file extensions per theme, values as comma separated list, i.e. '.png,.jpg'

root config max_attachment_file_size_per_dataset
Type: object

Lookup of maximum attachment file size in bytes per theme

root config attachment_store_pattern
Type: string

The path pattern to use when saving attachments to disk. You can use {random}, {filename}, {ext} and {}, where field refers to the respective field value of the committed feature. Default is '{random}/{filename}'

root resources
Type: object

root resources datasets
Type: array of object
No Additional Items

Each item of this array must be:

root resources datasets Dataset
Type: object

PostgreSQL metadata and field constraints for a dataset

root resources datasets Dataset name
Type: string

Dataset name

root resources datasets Dataset db_url
Type: string

DB connection string for read and write access (or read-only access if dbwriteurl is present)

root resources datasets Dataset db_write_url
Type: string

Optional DB connection string for write access

root resources datasets Dataset schema
Type: string

root resources datasets Dataset fields
Type: array of object

Dataset fields with optional constraints

 No Additional Items

Each item of this array must be:

root resources datasets Dataset fields fields items
Type: object

root resources datasets Dataset fields fields items name
Type: string

Field name

root resources datasets Dataset fields fields items data_type
Type: enum (of string) Default: "text"

Must be one of:

  • "USER-DEFINED"
  • "bigint"
  • "boolean"
  • "character"
  • "character varying"
  • "date"
  • "double precision"
  • "file"
  • "integer"
  • "json"
  • "jsonb"
  • "numeric"
  • "real"
  • "smallint"
  • "text"
  • "time"
  • "timestamp with time zone"
  • "timestamp without time zone"
  • "uuid"

root resources datasets Dataset geometry
Type: object

root resources datasets Dataset geometry geometry_type
Type: enum (of string)

Must be one of:

  • "POINT"
  • "POINTZ"
  • "LINESTRING"
  • "LINESTRINGZ"
  • "POLYGON"
  • "POLYGONZ"
  • "MULTIPOINT"
  • "MULTIPOINTZ"
  • "MULTILINESTRING"
  • "MULTILINESTRINGZ"
  • "MULTIPOLYGON"
  • "MULTIPOLYGONZ"

root resources datasets Dataset geometry srid
Type: integer

Spatial Reference System Identifier (EPSG code)

root resources datasets Dataset geometry allow_null
Type: boolean Default: false

Allow setting geometry values to NULL
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-db-auth/index.html b/references/qwc-db-auth/index.html new file mode 100644 index 00000000..697ccd42 --- /dev/null +++ b/references/qwc-db-auth/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc db auth - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc db auth
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC DB authentication service

+

QWC DB authentication service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-db-auth/master/schemas/qwc-db-auth.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "db-auth"

root config
Type: object

root config db_url
Type: string

DB connection URL

root config password_min_length
Type: integer

Min password length

root config password_max_length
Type: integer

Max password length

root config password_constraints
Type: array of string

List of RegExes for additional password constraints

 No Additional Items

Each item of this array must be:

root config password_constraints password_constraints items
Type: string

root config password_min_constraints
Type: integer

Min number of password_constraints to match for password to be valid

root config password_constraints_message
Type: string

Validation message if password constraints are not met

root config password_expiry
Type: integer

Number of days until password expires, or -1 to disable

root config password_expiry_notice
Type: integer

Show an expiry notice within this number of days before a password expires, or -1 to disable

root config password_update_interval
Type: integer

Min number of seconds before password may be changed again, or -1 to disable

root config password_allow_reuse
Type: boolean

Set whether previous passwords may be reused or not

root config user_info_fields
Type: array of string

List of user info fields to include in JWT identity

 No Additional Items

Each item of this array must be:

root config user_info_fields user_info_fields items
Type: string

root config logo_image_url
Type: string

URL to a logo image to show in the login form

root config background_image_url
Type: string

URL to a background image for the login page

root config customstylesheet
Type: string

Filename of custom stylesheet placed next to regular style.css
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-document-service/index.html b/references/qwc-document-service/index.html new file mode 100644 index 00000000..b1de343f --- /dev/null +++ b/references/qwc-document-service/index.html @@ -0,0 +1,176 @@ + + + + + + + + QWC Document Service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC Document Service
    • +
  • +
    • +
+
+
+
+
+ +

QWC Document Service

+

Properties

+
    +
  • $schema (string): Reference to JSON schema of this config. Default: https://raw.githubusercontent.com/qwc-services/qwc-document-service/master/schemas/qwc-document-service.json.
    • +
  • service (string)
    • +
  • config (object)
    • +
  • jasper_service_url (string): Jasper Reporting service URL for generating reports. Example: http://localhost:8002/reports.
    • +
  • jasper_timeout (integer): Timeout for requests forwarded to Jasper Reporting service. Default: 60.
    • +
  • resources (object)
    • +
  • document_templates (array)
      +
    • Items (object)
      • +
    • template (string)
      • +
    • report_filename (string)
      • +
    +
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-elevation-service/index.html b/references/qwc-elevation-service/index.html new file mode 100644 index 00000000..d1e0430d --- /dev/null +++ b/references/qwc-elevation-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc elevation service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc elevation service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Elevation Service

+

QWC Elevation Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-elevation-service/master/schemas/qwc-elevation-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "elevation"

root config
Type: object

root config elevation_dataset
Type: string

Elevation dataset (file or URL). Example: https://data.sourcepole.com/srtm1km3857.tif
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-ext-service/index.html b/references/qwc-ext-service/index.html new file mode 100644 index 00000000..839e3638 --- /dev/null +++ b/references/qwc-ext-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc ext service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc ext service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC External Link Service

+

QWC External Link Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://github.com/qwc-services/qwc-ext-service/raw/master/schemas/qwc-ext-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "ext"

root config
Type: object

root config post_link_timeout
Type: number

Timeout for post link requests, in seconds. Default: 30.

root resources
Type: object
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-feature-info-service/index.html b/references/qwc-feature-info-service/index.html new file mode 100644 index 00000000..74456f97 --- /dev/null +++ b/references/qwc-feature-info-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc feature info service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc feature info service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC FeatureInfo Service

+

QWC FeatureInfo Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-feature-info-service/master/schemas/qwc-feature-info-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "feature-info"

root config
Type: object

root config default_info_template
Type: string

Default HTML info template

root config default_info_template_path
Type: string

Default HTML info template path

root config default_info_template_base64
Type: string

Default HTML info template in Base64 encoding

root config default_qgis_server_url
Type: string

Default URL for WMS GetFeatureInfo queries

root config data_service_url
Type: string

Data service URL

root config transform_image_urls
Type: boolean

Transform image URLs to inline images

root config skip_empty_attributes
Type: boolean

Whether to skip empty feature attributes in WMS GetFeatureInfo responses (default: false)

root config use_permission_attribute_order
Type: boolean

Whether to order the attributes according to order of the permitted attribute names in WMS GetFeatureInfo responses, rather than the order returned by WMS GetFeatureInfo (default: false)

root resources
Type: object

root resources wms_services
Type: array of object
No Additional Items

Each item of this array must be:

root resources wms_services WMS
Type: object

WMS service with nested layers and group layers

root resources wms_services WMS name
Type: string

WMS service name

root resources wms_services WMS root_layer

Root layer of WMS (layer or group layer)

root resources wms_services WMS root_layer oneOf layer
Type: object

Single layer

 No Additional Properties

root resources wms_services WMS root_layer oneOf Layer name
Type: string

WMS layer name

root resources wms_services WMS root_layer oneOf Layer type
Type: const

Layer type

Specific value: "layer"

root resources wms_services WMS root_layer oneOf Layer title
Type: string

Layer title

root resources wms_services WMS root_layer oneOf Layer attributes
Type: array of object
No Additional Items

Each item of this array must be:

root resources wms_services WMS root_layer oneOf Layer attributes attributes items
Type: object

root resources wms_services WMS root_layer oneOf Layer attributes attributes items format
Type: string

Formatting expression for converting attribute values

root resources wms_services WMS root_layer oneOf Layer attributes attributes items format_base64
Type: string

Formatting expression for converting attribute values, in Base64 encoding

root resources wms_services WMS root_layer oneOf Layer attributes attributes items json_attribute_aliases
Type: array of object

Aliases for attributes in JSON values of type list

 No Additional Items

Each item of this array must be:

root resources wms_services WMS root_layer oneOf Layer attributes attributes items json_attribute_aliases json_attribute_aliases items
Type: object

root resources wms_services WMS root_layer oneOf Layer info_template

root resources wms_services WMS root_layer oneOf Layer info_template oneOf wms_info_template
Type: object

Info template for WMS GetFeatureInfo

 No Additional Properties

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 type
Type: const
Specific value: "wms"

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 wms_url
Type: string

Custom WMS URL if different from defaultqgisserver_url

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 template
Type: string

HTML template for info result

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 template_path
Type: string

Path to HTML template for info result

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 template_base64
Type: string

HTML template for info result, in Base64 encoding
root resources wms_services WMS root_layer oneOf Layer info_template oneOf sql_info_template
Type: object

Info template for DB Query

 No Additional Properties

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 oneOf item 0
Type: object

The following properties are required:

  • type
  • db_url
  • sql
root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 oneOf item 1
Type: object

The following properties are required:

  • type
  • db_url
  • sql_base64

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 type
Type: const
Specific value: "sql"

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 db_url
Type: string

Database connection string

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 sql_base64
Type: string

Query SQL in Base64 encoding

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 template
Type: string

HTML template for info result

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 template_path
Type: string

Path to HTML template for info result

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 template_base64
Type: string

HTML template for info result, in Base64 encoding
root resources wms_services WMS root_layer oneOf Layer info_template oneOf module_info_template
Type: object

Info template using WMS GetFeatureInfo

 No Additional Properties

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 type
Type: const
Specific value: "module"

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 module
Type: string

Custom info module name

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 template
Type: string

HTML template for info result

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 template_path
Type: string

Path to HTML template for info result.

root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 template_base64
Type: string

HTML template for info result, in Base64 encoding

root resources wms_services WMS root_layer oneOf Layer display_field
Type: string

Show value of this attribute in feature result header

root resources wms_services WMS root_layer oneOf Layer feature_report
Type: string

Name of corresponding feature report
root resources wms_services WMS root_layer oneOf group_layer
Type: object

Group layer with nested sublayers

 No Additional Properties

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

WMS group layer name

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

Layer type

Specific value: "layergroup"

root resources wms_services WMS root_layer oneOf Group Layer title
Type: string

Group title

root resources wms_services WMS root_layer oneOf Group Layer layers
Type: array

Sublayers of this group layer (layers or group layers)

 No Additional Items

Each item of this array must be:

root resources wms_services WMS root_layer oneOf Group Layer layers layers items

root resources wms_services WMS 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)
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-legend-service/index.html b/references/qwc-legend-service/index.html new file mode 100644 index 00000000..914c1f15 --- /dev/null +++ b/references/qwc-legend-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc legend service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc legend service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Legend Service

+

QWC Legend Service

Type: object

root $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
Type: const
Specific value: "legend"

root config
Type: object

root config default_qgis_server_url
Type: string

Default base URL for forwarding WMS GetLegendGraphics requests

root config legend_images_path
Type: string

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

root resources
Type: object

root resources wms_services
Type: array of object
No Additional Items

Each item of this array must be:

root resources wms_services 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)
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-map-viewer/index.html b/references/qwc-map-viewer/index.html new file mode 100644 index 00000000..4eabfe5b --- /dev/null +++ b/references/qwc-map-viewer/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc map viewer - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc map viewer
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Map Viewer

+

QWC Map Viewer

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-map-viewer/v2/schemas/qwc-map-viewer.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "map-viewer"

root config
Type: object

root config qwc2_path
Type: string

Path to QWC2 files

root config auth_service_url
Type: string

QWC Auth Service URL

root config ccc_config_service_url
Type: string

CCC Service URL

root config data_service_url
Type: string

QWC Data Service URL

root config dataproduct_service_url
Type: string

DataProduct Service URL

root config document_service_url
Type: string

Document Service URL

root config elevation_service_url
Type: string

QWC Elevation Service URL

root config info_service_url
Type: string

QWC FeatureInfo Service URL

root config landreg_service_url
Type: string

Land Register Extract Service URL

root config legend_service_url
Type: string

QWC Legend Service URL

root config mapinfo_service_url
Type: string

MapInfo Service URL

root config ogc_service_url
Type: string

QWC OGC Service URL

root config plotinfo_service_url
Type: string

PlotInfo Service URL

root config print_service_url
Type: string

QWC Print Service URL

root config proxy_service_url
Type: string

Proxy Service URL

root config search_data_service_url
Type: string

QWC Search Result Service URL

root config search_service_url
Type: string

QWC Search Service URL

root config show_restricted_themes
Type: boolean

Whether to insert placeholder items for restricted themes in themes.json

root config show_restricted_themes_whitelist
Type: array of string

Whitelist of restricted theme names to include in themes.json. If empty, all restricted themes are shown.

 No Additional Items

Each item of this array must be:

root config show_restricted_themes_whitelist show_restricted_themes_whitelist items
Type: string

root config redirect_restricted_themes_to_auth
Type: boolean

Whether to redirect to login on auth service if requesting a restricted theme in URL params

root config user_info_fields
Type: array of string

List of user info fields to read from JWT identity

 No Additional Items

Each item of this array must be:

root config user_info_fields user_info_fields items
Type: string

root config public_paths
Type: array of string

Optional: List of paths that will be accessible without a JWT identity, if AUTH_REQUIRED is set.

 No Additional Items

Each item of this array must be:

root config public_paths public_paths items
Type: string

root resources
Type: object

root resources qwc2_config
Type: object

root resources qwc2_config restricted_viewer_tasks
Type: array of string

Restricted menu items

 No Additional Items

Each item of this array must be:

root resources qwc2_config restricted_viewer_tasks restricted_viewer_tasks items
Type: string

root resources qwc2_config config
Type: object

QWC2 application configuration (config.json)

root resources qwc2_themes
Type: object

QWC2 themes configuration (themes.json)

root resources qwc2_themes themes
Type: object
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-mapinfo-service/index.html b/references/qwc-mapinfo-service/index.html new file mode 100644 index 00000000..e9c20be1 --- /dev/null +++ b/references/qwc-mapinfo-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc mapinfo service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc mapinfo service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Mapinfo Service

+

QWC Mapinfo Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-mapinfo-service/master/schemas/qwc-mapinfo-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "mapinfo"

root config

root config oneOf item 0
Type: object

The following properties are required:

  • db_url
  • info_table
  • info_geom_col
  • info_display_col
  • info_title
root config oneOf item 1
Type: object

The following properties are required:

  • db_url
  • info_sql
  • info_title
root config oneOf item 2
Type: object

The following properties are required:

  • queries

root config db_url
Type: string

DB connection for info queries

root config info_table
Type: string

Table to use

root config info_geom_col
Type: string

Geometry column in table

root config info_display_col
Type: string

Display text column in table

root config info_title
Type: string

Display title

root config info_where
Type: string

Additional WHERE query

root config queries
Type: array of object
No Additional Items

Each item of this array must be:

root config queries Query

root config queries Query oneOf item 0
Type: object

The following properties are required:

  • db_url
  • info_table
  • info_geom_col
  • info_display_col
  • info_title
root config queries Query oneOf item 1
Type: object

The following properties are required:

  • db_url
  • info_sql
  • info_title

root config queries Query db_url
Type: string

DB connection for info queries

root config queries Query info_table
Type: string

Table to use

root config queries Query info_geom_col
Type: string

Geometry column in table

root config queries Query info_display_col
Type: string

Display text column in table

root config queries Query info_title
Type: string

Display title

root config queries Query info_where
Type: string

Additional WHERE query

root config queries Query info_sql
Type: string

SQL query text
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-ogc-service/index.html b/references/qwc-ogc-service/index.html new file mode 100644 index 00000000..9155bc0d --- /dev/null +++ b/references/qwc-ogc-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc ogc service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc ogc service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC OGC Service

+

QWC OGC Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-ogc-service/master/schemas/qwc-ogc-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "ogc"

root config
Type: object

root config default_qgis_server_url
Type: string

Default base URL for WMS/WFS requests

root config public_ogc_url_pattern
Type: string

Regex pattern of the external OGC URL pattern, used to detect EXTERNAL_WMS URLs in print requests which point to the OGC server itself. Can use $origin$, $tenant$ and $mountpoint$ as variables. Default: $origin$/.*/?$mountpoint$

root config basic_auth_login_url
Type: array of string

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

 No Additional Items

Each item of this array must be:

root config basic_auth_login_url basic_auth_login_url items
Type: string

root config qgis_server_identity_parameter
Type: string

Name of the active user parameter for the QGIS Server. Will be set to the name of the logged in user in qwc2

root config public_paths
Type: array of string

Optional: List of paths that will be accessible without a JWT identity, if AUTH_REQUIRED is set.

 No Additional Items

Each item of this array must be:

root config public_paths public_paths items
Type: string

root config marker_params
Type: object

Optional: Marker parameter definitions

root config marker_params default
Type: string

Default value

root config marker_params type
Type: string

Parameter type (number, color, string)

root resources
Type: object

root resources wms_services
Type: array of object
No Additional Items

Each item of this array must be:

root resources wms_services 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 wms_url
Type: string

Custom WMS URL if different from defaultqgisserver_url

root resources wms_services WMS service online_resources
Type: object

Custom OnlineResources shown in GetCapabilities

root resources wms_services WMS service online_resources service
Type: string

Default public base URL for OnlineResources

root resources wms_services WMS service online_resources feature_info
Type: string

Public base URL for FeatureInfo OnlineResources

root resources wms_services WMS service online_resources legend
Type: string

Public base URL for Legend OnlineResources

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 wms_layer
Type: object

Single layer

 No Additional Properties

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

WMS layer name

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

Layer type

Specific value: "layer"

root resources wms_services WMS service root_layer oneOf WMS Layer attributes
Type: array of string

Attributes for GetFeatureInfo

 No Additional Items

Each item of this array must be:

root resources wms_services WMS service root_layer oneOf WMS Layer attributes attributes items
Type: string

root resources wms_services WMS service root_layer oneOf WMS Layer queryable
Type: boolean

Whether this layer is queryable

root resources wms_services WMS service root_layer oneOf WMS Layer opacity
Type: integer

Custom base opacity from 0-100 (Hidden sublayers only)
root resources wms_services WMS service root_layer oneOf wms_group_layer
Type: object

Group layer with nested sublayers

 No Additional Properties

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

WMS group layer name

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

Layer type

Specific value: "layergroup"

root resources wms_services WMS service root_layer oneOf WMS 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 print_url
Type: string

Custom WMS URL for printing, e.g. if using a separate QGIS project.

root resources wms_services WMS service print_templates
Type: array of string

Available print templates

 No Additional Items

Each item of this array must be:

root resources wms_services WMS service print_templates print_templates items
Type: string

root resources wms_services WMS service internal_print_layers
Type: array of string

Internal layer names used for printing and raster export of background and external layers

 No Additional Items

Each item of this array must be:

root resources wms_services WMS service internal_print_layers internal_print_layers items
Type: string

root resources wfs_services
Type: array of object
No Additional Items

Each item of this array must be:

root resources wfs_services WFS service
Type: object

WFS service with list of layers

root resources wfs_services WFS service name
Type: string

WFS service name

root resources wfs_services WFS service wfs_url
Type: string

Custom WFS URL if different from defaultqgisserver_url

root resources wfs_services WFS service online_resource
Type: string

Custom OnlineResource shown in GetCapabilities

root resources wfs_services WFS service layers
Type: array

List of WFS layers

 No Additional Items

Each item of this array must be:

root resources wfs_services WFS service layers wfs_layer
Type: object

Single layer

root resources wfs_services WFS service layers WFS Layer name
Type: string

WFS layer name

root resources wfs_services WFS service layers WFS Layer attributes
Type: array of string

Attributes for GetFeature and DescribeFeatureType

 No Additional Items

Each item of this array must be:

root resources wfs_services WFS service layers WFS Layer attributes attributes items
Type: string
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-permalink-service/index.html b/references/qwc-permalink-service/index.html new file mode 100644 index 00000000..7c0ce40a --- /dev/null +++ b/references/qwc-permalink-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc permalink service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc permalink service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Permalink Service

+

QWC Permalink Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-permalink-service/master/schemas/qwc-permalink-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "permalink"

root config
Type: object

root config db_url
Type: string

DB connection URL. Defaults to postgresql:///?service=qwc_configdb.

root config user_bookmark_table
Type: string

User bookmarks table. Defaults to qwcconfig.userbookmarks.

root config bookmarks_sort_order
Type: string

Bookmarks sort order, defaults to "date, description".
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-print-service/index.html b/references/qwc-print-service/index.html new file mode 100644 index 00000000..35d2800a --- /dev/null +++ b/references/qwc-print-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc print service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc print service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Print Service

+

QWC Print Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-print-service/master/schemas/qwc-print-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "print"

root config
Type: object

root config ogc_service_url
Type: string

OGC Service URL (internal)

root config qgis_server_version
Type: string

QGIS Server version (e.g. 2.18.19, 3.4.1)

root config qgs_postfix
Type: string

optional postfix to QGS name for printing

root config print_pdf_filename
Type: string

optional filename for returned PDF (default: .pdf)

root config label_values
Type: array of object
No Additional Items

Each item of this array must be:

root config label_values label_values items
Type: object

root config label_queries
Type: array of object
No Additional Items

Each item of this array must be:

root config label_queries label_queries items
Type: object

root config label_queries label_queries items params
Type: array of string
No Additional Items

Each item of this array must be:

root config label_queries label_queries items params params items
Type: string

root resources
Type: object

root resources print_templates
Type: array of object
No Additional Items

Each item of this array must be:

root resources print_templates print_templates items
Type: object

+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-search-service/index.html b/references/qwc-search-service/index.html new file mode 100644 index 00000000..c1682e83 --- /dev/null +++ b/references/qwc-search-service/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc search service - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc search service
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Fulltext Search Service

+

QWC Fulltext Search Service

Type: object

root $schema
Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-fulltext-search-service/master/schemas/qwc-search-service.json"

Reference to JSON schema of this config

root service
Type: const
Specific value: "search"

root config
Type: object

root config solr_service_url
Type: string

SOLR service URL

root config word_split_re
Type: string Default: "[\\s,.:;\"]+"

Word split Regex

root config search_result_limit
Type: integer Default: 50

Result count limit per search

root config db_url
Type: string

Default DB connection for geometry result query

root resources
Type: object

root resources facets
Type: array of object
No Additional Items

Each item of this array must be:

root resources facets Facet
Type: object

root resources facets Facet name
Type: string

Facet name

root resources facets Facet filter_word
Type: string

root resources facets Facet table_name
Type: string Default: "search_v"

Table/View for search result geometries

root resources facets Facet geometry_column
Type: string Default: "geom"

Geometry column in search result table

root resources facets Facet facet_column
Type: string Default: "subclass"

Facet name column in search result table

root resources facets Facet db_url
Type: string

DB connection for geometry result query
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc-services-permissions/index.html b/references/qwc-services-permissions/index.html new file mode 100644 index 00000000..d7dd325f --- /dev/null +++ b/references/qwc-services-permissions/index.html @@ -0,0 +1,171 @@ + + + + + + + + Qwc services permissions - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc services permissions
    • +
  • +
    • +
+
+
+
+
+ + +

+

+

+

+

+

+ +

QWC Services Permissions

+

QWC Services Permissions

Type: object

root $schema
Type: stringFormat: uri Default: "https://github.com/qwc-services/qwc-services-core/raw/master/schemas/qwc-services-permissions.json"

Reference to JSON schema of these permissions

root users
Type: array of object
No Additional Items

Each item of this array must be:

root users User
Type: object

root users User name
Type: string

User name

root users User groups
Type: array of string
No Additional Items

Each item of this array must be:

root users User groups groups items
Type: string

root users User roles
Type: array of string
No Additional Items

Each item of this array must be:

root users User roles roles items
Type: string

root groups
Type: array of object
No Additional Items

Each item of this array must be:

root groups Group
Type: object

root groups Group name
Type: string

Group name

root groups Group roles
Type: array of string
No Additional Items

Each item of this array must be:

root groups Group roles roles items
Type: string

root roles
Type: array of object
No Additional Items

Each item of this array must be:

root roles Role
Type: object

root roles Role role
Type: string

Role name

root roles Role permissions
Type: object

root roles Role permissions wms_services
Type: array of object

Permitted WMS services and layers for all QWC services using WMS requests (i.e. OGC, FeatureInfo, Legend, Print service)

 No Additional Items

Each item of this array must be:

root roles Role permissions wms_services WMS permissions
Type: object

root roles Role permissions wms_services WMS permissions name
Type: string

WMS service name

root roles Role permissions wms_services WMS permissions layers
Type: array of object

Flat list of permitted layers and group layers

 No Additional Items

Each item of this array must be:

root roles Role permissions wms_services WMS permissions layers layers items
Type: object

root roles Role permissions wms_services WMS permissions layers layers items attributes
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions wms_services WMS permissions layers layers items attributes attributes items
Type: string

root roles Role permissions wms_services WMS permissions print_templates
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions wms_services WMS permissions print_templates print_templates items
Type: string

root roles Role permissions wfs_services
Type: array of object

Permitted WFS services and layers for OGC service

 No Additional Items

Each item of this array must be:

root roles Role permissions wfs_services WFS permissions
Type: object

root roles Role permissions wfs_services WFS permissions name
Type: string

WFS service name

root roles Role permissions wfs_services WFS permissions layers
Type: array of object

List of permitted layers

 No Additional Items

Each item of this array must be:

root roles Role permissions wfs_services WFS permissions layers layers items
Type: object

root roles Role permissions wfs_services WFS permissions layers layers items attributes
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions wfs_services WFS permissions layers layers items attributes attributes items
Type: string

root roles Role permissions background_layers
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions background_layers background_layers items
Type: string

root roles Role permissions data_datasets
Type: array of object

Permitted datasets for Data service

 No Additional Items

Each item of this array must be:

root roles Role permissions data_datasets Dataset permissions
Type: object

root roles Role permissions data_datasets Dataset permissions attributes
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions data_datasets Dataset permissions attributes attributes items
Type: string

root roles Role permissions viewer_tasks
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions viewer_tasks viewer_tasks items
Type: string

root roles Role permissions plugin_data
Type: array of object

Permitted resources for custom Map viewer plugins

 No Additional Items

Each item of this array must be:

root roles Role permissions plugin_data Plugin permissions
Type: object

root roles Role permissions plugin_data Plugin permissions name
Type: string

Plugin name

root roles Role permissions plugin_data Plugin permissions resources
Type: array of string

Plugin specific resources

 No Additional Items

Each item of this array must be:

root roles Role permissions plugin_data Plugin permissions resources resources items
Type: string

root roles Role permissions dataproducts
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions dataproducts dataproducts items
Type: string

root roles Role permissions document_templates
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions document_templates document_templates items
Type: string

root roles Role permissions search_providers
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions search_providers search_providers items
Type: string

root roles Role permissions solr_facets
Type: array of string
No Additional Items

Each item of this array must be:

root roles Role permissions solr_facets solr_facets items
Type: string
+

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/qwc2_plugins/index.html b/references/qwc2_plugins/index.html new file mode 100644 index 00000000..e3cd4b57 --- /dev/null +++ b/references/qwc2_plugins/index.html @@ -0,0 +1,1902 @@ + + + + + + + + Qwc2 plugins - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • Qwc2 plugins
    • +
  • +
    • +
+
+
+
+
+ +

Plugin reference

+ +
+

API

+

Exposes an API for interacting with QWC2 via window.qwc2.

+

All following action functions are available:

+ +

I.e. setCurrentTask is available via window.qwc2.setCurrentTask.

+

Additionally, the following functions are available:

+
+

window.qwc2.addExternalLayer(resource, beforeLayerName = null)

+

Convenience method for adding an external layer.

+
    +
  • resource: An external resource of the form wms:<service_url>#<layername> or wmts:<capabilities_url>#<layername>.
    • +
  • beforeLayerName: Insert the new layer before the layer with the specified name. If null or the layer does not exist, the layer is inserted on top.
    • +
+
+

window.qwc2.drawScratch(geomType, message, drawMultiple, callback, style = null)

+

Draw scratch geometries, and return these as GeoJSON to the calling application.

+
    +
  • geomType: Point, LineString, Polygon, Circle or Box.
    • +
  • message: A descriptive string to display in the tool taskbar.
    • +
  • drawMultiple: Whether to allow drawing multiple geometries.
    • +
  • callback: A function(result, crs), the result being an array of GeoJSON features, and crs the projection of the feature coordinates.
    • +
  • style: Optional, a custom style object to use for the drawn features, in the same format as DEFAULT_FEATURE_STYLE in qwc2/utils/FeatureStyles.js.
    • +
+
+

window.qwc2.getState()

+

Return the current application state.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
+

AttributeTable

+

Displaying the attribute table of layers in a dialog.

+

To make a layer available in the attribute table, create a a data resource and matching permissions for it in the qwc-admin-gui.

+

The attribute table works for both read-only as well as read-write data resources.

+

This plugin queries the dataset via the editing service specified by +editServiceUrl in config.json (by default the qwc-data-service).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
allowAddForGeometryLayersboolWhether to allow adding records for datasets which have a geometry column.undefined
showEditFormButtonboolWhether to show a button to open the edit form for selected layer. Requires the Editing plugin to be enabled.true
zoomLevelnumberThe zoom level for zooming to point features.1000
+

Authentication

+

Handles authentication

+

Invokes the the authentication service specified by authServiceUrl in config.json.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
clearLayerParamboolWhether to clear the layer parameter from the URL on login.undefined
idleTimeoutnumberAn idle timeout in seconds after which the user is automatically logged of.undefined
logoutTargetUrlstringAn URL to redirect to on logout, instead of the viewer URL.undefined
requireLoginboolWhether authentication is required, i.e. the viewer automatically redirects to the login page if no user is authenticated.undefined
+

BackgroundSwitcher

+

Map button for switching the background layer.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
positionnumberThe position slot index of the map button, from the bottom (0: bottom slot).0
+

Bookmark

+

Allows managing user bookmarks.

+

Bookmarks are only allowed for authenticated users.

+

Requires permalinkServiceUrl to point to a qwc-permalink-service.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
sidestringThe side of the application on which to display the sidebar.'right'
+

BottomBar

+

Bottom bar, displaying mouse coordinate, scale, etc.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
displayCoordinatesboolWhether to display the coordinates in the bottom bar.true
displayScalesboolWhether to display the scale in the bottom bar.true
termsUrlstringThe URL of the terms label anchor.undefined
termsUrlTargetstringThe target where to open the terms URL. If iframe, it will be displayed in an inline window, otherwise in a new tab.undefined
viewertitleUrlstringThe URL of the viewer title label anchor.undefined
viewertitleUrlTargetstringThe target where to open the viewer title URL. If iframe, it will be displayed in an inline window, otherwise in a new tab.undefined
+

Cyclomedia

+

Cyclomedia integration for QWC2.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
apikeystringThe Cyclomedia API keyundefined
clientIdstringOAuth client ID.undefined
cyclomediaVersionstringThe cyclomedia version.'23.6'
displayMeasurementsboolWhether to display Cyclomedia measurement geometries on the map.true
geometry{
initialWidth: number,
initialHeight: number,
initialX: number,
initialY: number,
initiallyDocked: bool,
}		Default window geometry.{
initialWidth: 480,
initialHeight: 640,
initialX: 0,
initialY: 0,
initiallyDocked: true
}
loginRedirectUristringThe relative path to the redirect login handling of oauth.undefined
logoutRedirectUristringThe relative path to the redirect logout handling of oauth.undefined
maxMapScalenumberThe maximum map scale above which the recordings WFS won't be displayed.10000
projectionstringThe projection to use for Cyclomedia.'EPSG:3857'
+

DxfExport

+

Allows exporting a selected extent of the map as DXF.

+

Uses the DXF format support of QGIS Server.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
formatOptionsstringOptional format options to pass to QGIS Server via FORMAT_OPTIONS.undefined
layerOptions[{
label: string,
layers: string,
}]		Optional choice of layer sets to pass to QGIS Server via LAYERS.undefined
serviceUrlstringOptional URL invoked on export instead of the default QGIS Server URL.undefined
+

Editing

+

Allows editing geometries and attributes of datasets.

+

The attribute form is generated from the QGIS attribute form configuration.

+

This plugin queries the dataset via the editing service specified by +editServiceUrl in config.json (by default the qwc-data-service).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
allowCloneGeometryboolWhether to enable the "Clone existing geometry" functionality.true
sidestringThe side of the application on which to display the sidebar.'right'
snappingboolWhether snapping is available when editing.true
snappingActiveboolWhether snapping is enabled by default when editing.true
widthstringThe default width of the editing sidebar, as a CSS width string."30em"
+

FeatureForm

+

Displays queried feature attributes in a form.

+

The attribute form is generated from the QGIS attribute form configuration.

+

If the dataset it editable, allows editing the attributes directly in the +displayed form.

+

This plugin queries the feature via the editing service specified by +editServiceUrl in config.json (by default the qwc-data-service), rather than over WMS +GetFeatureInfo like the Identify plugin.

+

Can be used as default identify tool by setting "identifyTool": "FeatureForm" in config.json.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
initialHeightnumberInitial height of the form window.480
initialWidthnumberInitial width of the form window.320
initialXnumberInitial x position of the form window.0
initialYnumberInitial y position of the form window.0
+

HeightProfile

+

Displays a height profile along a measured line.

+

Triggered automatically when a line is measured via the Measure plugin.

+

Requires elevationServiceUrl in config.json to point to a qwc-elevation-service.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
heighProfilePrecisionnumberThe precision of displayed and exported values (0: no decimals, 0.1: 1 decimal position, etc).0
heightnumberThe height of the height profile widget in pixels.100
samplesnumberThe number of elevation samples to query.500
+

Help

+

Displays a custom help dialog in a sidebar.

+

Define the help contents by specifying the bodyContentsFragmentUrl prop.

+ + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
bodyContentsFragmentUrlstringURL to a document containing a HTML fragment to display in the Help sidebar.undefined
sidestringThe side of the application on which to display the sidebar.'right'
+

HomeButton

+

Map button for reverting to the home extent of the theme.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
positionnumberThe position slot index of the map button, from the bottom (0: bottom slot).5
+

Identify

+

Displays queried feature attributes.

+

Uses WMS GetFeatureInfo to query features and displays the result in +table, as a HTML fragment or as plain text based on the supported GetFeatureInfo +format.

+

Extendable in combination with the qwc-feature-info-service, which provides support +for customized queries and templates for the result presentation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
attributeCalculatorfuncOptional function for computing derived attributes. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section.undefined
attributeTransformfuncOptional function for transforming attribute values. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section.undefined
clearResultsOnCloseboolWhether to clear the identify results when exiting the identify tool.true
customExportersarrayOptional list of custom exporters to offer along with the built-in exporters. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section.[]
displayResultTreeboolWhether to display a tree overview of results (as opposed to a flat list of results).true
enableExportboolWhether to enable the export functionality.true
featureInfoReturnsLayerNameboolWhether to assume that XML GetFeatureInfo responses specify the technical layer name in the name attribute, rather than the layer title.true
initialHeightnumberThe initial height of the identify dialog.320
initialWidthnumberThe initial width of the identify dialog.240
initialXnumberThe initial x coordinate of the identify dialog.0
initialYnumberThe initial y coordinate of the identify dialog.0
initiallyDockedboolWhether the identify dialog should be initially docked.undefined
replaceImageUrlsboolWhether to replace an attribute value containing an URL to an image with an inline image.true
+

LayerCatalog

+

Displays a pre-configured catalog of external layers in a window.

+

Configured through a catalog JSON containing a tree of external layer identifiers.

+

Example:

+
{
+  "catalog": [
+    {
+      "title": "Bauzonen",
+      "resource": "wms:http://wms.geo.admin.ch#ch.are.bauzonen"
+    },
+    {
+      "title": "Gewässerschutz",
+       "resource": "wms:https://geo.so.ch/api/wms#ch.so.afu.gewaesserschutz[50]"
+    },
+    {
+      "title": "Landeskarten",
+      "sublayers": [
+        {
+          "title": "Landeskarte 1:1 Million | LK1000",
+          "resource": "wms:http://wms.geo.admin.ch#ch.swisstopo.pixelkarte-farbe-pk1000.noscale"
+        },
+        {
+          "title": "Landeskarte 1:100`000 | LK100",
+          "resource": "wms:http://wms.geo.admin.ch#ch.swisstopo.pixelkarte-farbe-pk100.noscale"
+        }
+      ]
+    }
+  ]
+}
+
+ + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
catalogUrlstringThe URL to the catalog JSON file.undefined
windowSize{
width: number,
height: number,
}		The default window size.{width: 320, height: 320}
+

LayerTree

+

Displays the map layer tree in a sidebar.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
addLayerSeparatorfuncWhether to allow adding separator entries in the layer tree, useful for organizing the tree.undefined
allowCompareboolWhether to enable the compare function. Requires the MapCompare plugin.true
allowImportboolWhether to allow importing external layers.true
allowMapTipsboolWhether to allow enabling map tips.true
bboxDependentLegend{bool, string}Whether to display a BBOX dependent legend. Can be true|false|"theme", latter means only for theme layers.false
enableLegendPrintboolWhether to enable the legend print functionality.true
enableServiceInfoboolWhether to display a service info button to display the WMS service metadata.true
enableVisibleFilterboolWhether to display a button to filter invisible layers from the layertree.true
extraLegendParametersstringAdditional parameters to pass to the GetLegendGraphics request-undefined
flattenGroupsboolWhether to display a flat layer tree, omitting any groups.false
grayUncheckedboolWhether to display unchecked layers gray in the layertree.true
groupTogglesSublayersboolWhether toggling a group also toggles all sublayers.false
infoInSettingsboolWhether to display the layer info button inside the layer settings menu rather than next to the layer title.true
layerInfoWindowSize{
width: number,
height: number,
}		The initial size of the layer info window.{width: 320, height: 480}
mapTipsEnabledboolWhether map tips are enabled by default.undefined
scaleDependentLegend{bool, string}Whether to display a scale dependent legend. Can be true|false|"theme", latter means only for theme layers.undefined
showLegendIconsboolWhether to display legend icons.true
showQueryableIconboolWhether to display the queryable icon to indicate that a layer is identifyable.true
showRootEntryboolWhether to display the root entry of the layertree.true
showToggleAllLayersCheckboxboolWhether to display a checkbox to toggle all layers.true
sidestringThe side of the application on which to display the sidebar.'right'
widthstringThe initial width of the layertree, as a CSS width string."25em"
+

LocateButton

+

Map button for controling the locate (GPS) state.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
positionnumberThe position slot index of the map button, from the bottom (0: bottom slot).2
+

LoginUser

+

Displays the currently logged in user.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
+

MapPlugin

+

The main map component.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
mapOptions{
zoomDuration: number,
enableRotation: bool,
rotation: number,
panStepSize: number,
panPageSize: number,
}		Zoom duration in ms, rotation in degrees, panStepSize and panPageSize as fraction of map width/height.{}
showLoadingboolWhether to display the loading spinner when layers are loading.true
swipeGeometryTypeBlacklist[string]A list of layer geometry types to ignore when determining the top-most layer to compare.[]
swipeLayerNameBlacklist[string]A list of layer names to ignore when determining the top-most layer to compare. You can use * as a whildcard character.[]
toolsOptionsobjectMap tool configuraiton options. Refer to the sample config.json.{}
+

MapComparePlugin

+

Allows comparing the top layer with the rest of the map.

+

Activated through a checkbox in the LayerTree.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
+

MapCopyright

+

Displays layer attributions in the bottom right corner of the map.

+ + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
prefixCopyrightsWithLayerNamesboolWhether to prepend the layer name to the attribution string.undefined
showThemeCopyrightOnlyboolWhether to only display the attribution of the theme, omitting external layers.undefined
+

MapInfoTooltip

+

Provides map context information when right-clicking on the map.

+

Displays the coordinates at the picked position by default.

+

If elevationServiceUrl in config.json to points to a qwc-elevation-service, +the height at the picked position is also displayed.

+

If mapInfoService in config.json points to a qwc-mapinfo-service, additional +custom information according to the qwc-mapinfo-service configuration is returned.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
cooPrecisionnumberThe number of decimal places to display for metric/imperial coordinates.0
degreeCooPrecisionnumberThe number of decimal places to display for degree coordinates.4
elevationPrecisionnumberThe number of decimal places to display for elevation values.0
+

MapLegend

+

Displays the map legend in a floating dialog.

+

The user can toggle whether to display only layers which are enabled, visible in the current extent and/or visible at the current scale.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
addGroupTitlesboolWhether to add group titles to the legend.false
addLayerTitlesboolWhether to add layer titles to the legend. Note that often the legend image itself already contains the layer title.false
bboxDependentLegendboolWhether to display a BBOX-dependent legend by default.false
extraLegendParametersstringExtra parameters to add to the GetLegendGraphics request.undefined
onlyVisibleLegendboolWhether to only include enabled layers in the legend by default.false
scaleDependentLegendboolWhether to display a scale-dependent legend by default.false
windowSize{
width: number,
height: number,
}		The default window size.{width: 320, height: 320}
+

MapTip

+

Displays maptips by hovering over features on the map.

+

Queries the map tips configured in the QGIS layer properites over GetFeatureInfo.

+

The map tip needs to be configured in QGIS Layer Properties → Display.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
layerFeatureCountnumberThe maximum number of feature maptips to display for a single layer.5
+

Measure

+

Allows measuring points/lines/areas on the map.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
showMeasureModeSwitcherboolWhether to show the widget to switch between measure modes.true
snappingboolWhether snapping is available when editing.true
snappingActiveboolWhether snapping is enabled by default when editing.true
+

NewsPopup

+

Displays a newsletter in a popup dialog.

+

The popup won't be dispayed anymore, if the user chooses so, until a newer +revision is published (specified via newsRev prop).

+ + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
newsDocumentstringURL to the news HTML document to display in the popup.undefined
newsRevstringRevision of the document.undefined
+

Print

+

Invokes QGIS Server WMS GetPrint to print the map to PDF.

+

Uses the print layouts defined in the QGIS project.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
allowGeoPdfExportboolWhether to allow GeoPDF export. Requires QGIS Server 3.32 or newer.undefined
defaultDpinumberThe default print dpi.300
defaultScaleFactornumberThe factor to apply to the map scale to determine the initial print map scale.0.5
displayRotationboolWhether to display the map rotation control.true
gridInitiallyEnabledboolWhether the grid is enabled by default.false
hideAutopopulatedFieldsboolWhether to hide form fields which contain autopopulated values (i.e. search result label).undefined
inlinePrintOutputboolWhether to display the print output in an inline dialog instead triggering a download.false
printExternalLayersboolWhether to print external layers. Requires QGIS Server 3.x!true
scaleFactornumberScale factor to apply to line widths, font sizes, ... of redlining drawings passed to GetPrint.1.9
sidestringThe side of the application on which to display the sidebar.'right'
+

ProcessNotifications

+

Adds support for displaying notifications of background processes.

+

Only useful for third-party plugins which use this functionality.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
+

RasterExport

+

Allows exporting a selected portion of the map to an image ("screenshot").

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
allowedFormats[string]Whitelist of allowed export format mimetypes. If empty, supported formats are listed.undefined
allowedScales[number]List of scales at which to export the map.undefined
defaultFormatstringDefault export format mimetype. If empty, first available format is used.undefined
defaultScaleFactornumberThe factor to apply to the map scale to determine the initial export map scale.0.5
dpis[number]List of dpis at which to export the map. If empty, the default server dpi is used.undefined
exportExternalLayersboolWhether to include external layers in the image. Requires QGIS Server 3.x!true
pageSizes[{
name: string,
width: number,
height: number,
}]		List of image sizes to offer, in addition to the free-hand selection. The width and height are in millimeters.[
{name: '15 x 15 cm', width: 150, height: 150},
{name: '30 x 30 cm', width: 300, height: 300}
]
sidestringThe side of the application on which to display the sidebar.'right'
+

Redlining

+

Allows drawing figures and text labels on the map.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
allowGeometryLabelsboolWhether to allow labeling geometric figures.true
snappingboolWhether snapping is available when editing.true
snappingActiveboolWhether snapping is enabled by default when editing.true
+

Routing

+

Compute routes and isochrones.

+

Requites routingServiceUrl in config.json pointing to a Valhalla routing service.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
enabledModes[string]List of enabled routing modes.["auto", "heavyvehicle", "transit", "bicycle", "pedestrian"]
enabledProviders[string]List of search providers to use for routing location search.["coordinates", "nominatim"]
geometry{
initialWidth: number,
initialHeight: number,
initialX: number,
initialY: number,
initiallyDocked: bool,
}		Default window geometry.{
initialWidth: 320,
initialHeight: 640,
initialX: 0,
initialY: 0,
initiallyDocked: true
}
+

ScratchDrawing

+

Task which which can be invoked by other tools to draw a geometry and pass it to a callback.

+

Only useful for third-party code, i.e. over the JavaScript API.

+

Invoke as setCurrentTask("ScratchDrawing", null, null, {callback: <function(features, crs)>});

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
+

Settings

+

Settings panel.

+

Allows configuring language and color scheme.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
colorSchemes[{
title: string,
titleMsgId: string,
value: string,
}]		List of available color schemes. Value is the css class name, title/titleMsgId the display name.[]
languagesarrayList of available languages. Value is the lang code, title/titleMsgId the display name.[]
sidestringThe side of the application on which to display the sidebar.'right'
+

Share

+

Share the current map as a URL/permalink.

+

Compact permalinks will be generated if permalinkServiceUrl in config.json points to a qwc-permalink-service.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
showLinkboolShow the map URL.true
showQRCodeboolShow the QR code of the map URL.true
showSocials{bool, [string]}Show the social buttons. Either true or falseto enable/disable all, or an array of specific buttons to display (possible choices: email, facebook, twitter, linkedin, whatsapp).true
sidestringThe side of the application on which to display the sidebar.'right'
+

StartupMarker

+

Displays a marker when starting up the viewer.

+

The marked is displayed in the center of the map if c=<x>,<y>&hc=1 is set in the URL.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
removeModestringWhen to remove the marker. Possible choices: onpan, onzoom, onclickonmarker.'onpan'
+

TaskButton

+

Generic map button to launch a task.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
iconstringThe icon name.undefined
modestringThe task mode.undefined
positionnumberThe position slot index of the map button, from the bottom (0: bottom slot).1
taskstringThe task name.undefined
+

ThemeSwitcher

+

Theme switcher panel.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
collapsibleGroupsboolWhether to allow collapsing theme groups.undefined
showLayerAfterChangeThemeboolWhether to show the LayerTree by default after switching the theme.false
sidestringThe side of the application on which to display the sidebar.'right'
themeLayersListWindowSize{
width: number,
height: number,
}		The default window size for the theme layers dialog.{width: 400, height: 300}
widthstringDefault width as a CSS string."50%"
+

TimeManager

+

Allows controling the time dimension of temporal WMS layers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
cursorFormatstringThe format of the time cursor label. Either date, time or datetime."datetime"
dateFormatstringThe date format in the time controls, i.e. YYYY-MM-DD."YYYY-MM-DD[\n]HH:mm:ss"
defaultAnimationIntervalnumberThe default interval for the temporal animation, in seconds.1
defaultEnabledboolDefault for TimeManager enabled when loading application. true or falsefalse
defaultFeatureCountnumberThe default number of features that will be requested.100
defaultStepSizenumberThe default step size for the temporal animation, in step units.1
defaultStepUnitstringThe default step unit for the temporal animation, one of ms, s, m, d, M, y, 10y, 100y"d"
defaultTimelineDisplaystringThe default timeline display mode. One of hidden, minimal, features, layers.undefined
defaultTimelineModestringThe default timeline mode. One of fixed, infinite."fixed"
markerConfiguration{
markersAvailable: bool,
gradient: [string],
markerOffset: array,
markerPins: bool,
}		The feature marker configuration.{
markersAvailable: true,
gradient: ["#f7af7d", "#eacc6e", "#fef89a", "#c5e09b", "#a3d29c", "#7cc096", "#79c8c5", "#34afce"],
markerOffset: [0, 0],
markerPins: true
}
stepUnits[string]The available temporal anumation step units.["s", "m", "h", "d", "M", "y"]
+

TopBar

+

Top bar, containing the logo, searchbar, task buttons and app menu.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
appMenuClearsTaskboolWhether opening the app menu clears the active task.undefined
appMenuFilterFieldboolWhether to display the filter field in the app menu.undefined
appMenuShortcutstringThe shortcut for tiggering the app menu, i.e. alt+shift+m.undefined
appMenuVisibleOnStartupboolWhether to open the app menu on application startup.undefined
logoFormatstringThe logo file format."svg"
logoSrcstringThe logo image URL if a different source than the default assets/img/logo. and assets/img/logo-mobile. is desired.undefined
logoUrlstringThe hyperlink to open when the logo is clicked.undefined
menuItemsarrayThe menu items. Refer to the corresponding chapter of the viewer documentation and the sample config.json.[]
searchOptionsobjectOptions passed down to the search component. See the searchOption propType of the used search component.{}
toolbarItemsarrayThe toolbar. Refer to the corresponding chapter of the viewer documentation and the sample config.json.[]
toolbarItemsShortcutPrefixstringThe keyboard shortcut prefix for triggering toolbar tasks. I.e. alt+shift. The task are then triggered by +{1,2,3,...} for the 1st, 2nd, 3rd... toolbar icon.undefined
+

ZoomButton

+

Map button for zooming the map.

+

Two specific plugins exist: ZoomInPlugin and ZoomOutPlugin, which are instances of ZoomButton for the respective zoom directions.

+ + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionDefault value
positionnumberThe position slot index of the map button, from the bottom (0: bottom slot).undefined
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/references/schema_doc.css b/references/schema_doc.css new file mode 100644 index 00000000..e1f3a511 --- /dev/null +++ b/references/schema_doc.css @@ -0,0 +1,181 @@ +body { + font: 16px/1.5em "Overpass", "Open Sans", Helvetica, sans-serif; + color: #333; + font-weight: 300; + padding: 40px; +} + +.btn.btn-link { + font-size: 18px; + user-select: text; +} + +.jsfh-animated-property { + animation: eclair; + animation-iteration-count: 1; + animation-fill-mode: forwards; + animation-duration: .75s; + +} + +@keyframes eclair { + 0%,100% { + transform: scale(1); + } + 50% { + transform: scale(1.03); + } +} + +.btn.btn-primary { + margin: 10px; +} + +.btn.example-show.collapsed:before { + content: "show" +} + +.btn.example-show:before { + content: "hide" +} + +.description.collapse:not(.show) { + max-height: 100px !important; + overflow: hidden; + + display: -webkit-box; + -webkit-line-clamp: 2; + -webkit-box-orient: vertical; +} + +.description.collapsing { + min-height: 100px !important; +} + +.collapse-description-link.collapsed:after { + content: '+ Read More'; +} + +.collapse-description-link:not(.collapsed):after { + content: '- Read Less'; +} + +.badge { + font-size: 100%; + margin-bottom: 0.5rem; + margin-top: 0.5rem; +} + +.badge.value-type { + font-size: 120%; + margin-right: 5px; + margin-bottom: 10px; +} + + +.badge.default-value { + font-size: 120%; + margin-left: 5px; + margin-bottom: 10px; +} + +.badge.restriction { + display: inline-block; +} + +.badge.required-property,.badge.deprecated-property,.badge.pattern-property,.badge.no-additional { + font-size: 100%; + margin-left: 10px; +} + +.accordion div.card:only-child { + border-bottom: 1px solid rgba(0, 0, 0, 0.125); +} + +.examples { + padding: 1rem !important; +} + +.examples pre { + margin-bottom: 0; +} + +.highlight.jumbotron { + padding: 1rem !important; +} + +.generated-by-footer { + margin-top: 1em; + text-align: right; +} + +/* From https://github.com/richleland/pygments-css/blob/master/friendly.css, see https://github.com/trentm/python-markdown2/wiki/fenced-code-blocks */ +.highlight { background: #e9ecef; } /* Changed from #f0f0f0 in the original style to be the same as bootstrap's jumbotron */ +.highlight .hll { background-color: #ffffcc } +.highlight .c { color: #60a0b0; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #40a070 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #40a070 } /* Literal.Number.Bin */ +.highlight .mf { color: #40a070 } /* Literal.Number.Float */ +.highlight .mh { color: #40a070 } /* Literal.Number.Hex */ +.highlight .mi { color: #40a070 } /* Literal.Number.Integer */ +.highlight .mo { color: #40a070 } /* Literal.Number.Oct */ +.highlight .sa { color: #4070a0 } /* Literal.String.Affix */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #06287e } /* Name.Function.Magic */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ +.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */ diff --git a/references/schema_doc.min.js b/references/schema_doc.min.js new file mode 100644 index 00000000..17eceaf5 --- /dev/null +++ b/references/schema_doc.min.js @@ -0,0 +1 @@ +$(document).on("click",'a[href^="#"]',function(event){event.preventDefault();history.pushState({},"",this.href)});function flashElement(elementId){myElement=document.getElementById(elementId);myElement.classList.add("jsfh-animated-property");setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(anchorLinkDestination){history.pushState({},"",anchorLinkDestination)}function anchorOnLoad(){let linkTarget=decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);if(linkTarget[0]==="#"){linkTarget=linkTarget.substr(1)}if(linkTarget.length>0){anchorLink(linkTarget)}}function anchorLink(linkTarget){const target=$("#"+linkTarget);target.parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(index){if($(this).hasClass("collapse")){$(this).collapse("show")}else if($(this).hasClass("tab-pane")){const tabToShow=$("a[href='#"+$(this).attr("id")+"']");if(tabToShow){tabToShow.tab("show")}}else if($(this).attr("role")==="tab"){$(this).tab("show")}});setTimeout(function(){let targetElement=document.getElementById(linkTarget);if(targetElement){targetElement.scrollIntoView({block:"center",behavior:"smooth"});setTimeout(function(){flashElement(linkTarget)},500)}},1e3)} \ No newline at end of file diff --git a/release_notes/QWC2UpgradeNotes/index.html b/release_notes/QWC2UpgradeNotes/index.html new file mode 100644 index 00000000..61edb17c --- /dev/null +++ b/release_notes/QWC2UpgradeNotes/index.html @@ -0,0 +1,368 @@ + + + + + + + + QWC2 upgrade notes - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Version history »
    • +
  • QWC2 upgrade notes
    • +
  • +
    • +
+
+
+
+
+ +

Upgrade notes

+

This document describes incompatibilites and other aspects which QWC2 applications need to address when updating against the latest qwc2 submodule.

+

When updating the qwc2 submodule, run yarn install to ensure the dependencies are up to date!

+

Update to qwc2 submodule revision 7409372 (23.08.2023)

+

MapInfoToolTip plugin instantation change

+
    +
  • +

    The instantation of the MapInfoToolTip in appConfig.js needs to be changed to

    +

    MapInfoTooltipPlugin: MapInfoTooltipPlugin(),

    +
    • +
+

Note the extra braces at the end. As a new feature, you can pass a list of plugins to the MapInfoTooltipPlugin.

+

Configuration changes

+
    +
  • The window size configuration of various plugins has been uniformized to the geometry config prop (rather than occasionally windowSize before). Affected plugins are: FeatureForm, Identify, LayerCatalog, LayerTree, MapLegend. Please check the respective plugin reference for more details on the new format.
    • +
+

Update to qwc2 submodule revision 96aaa51 (09.02.2023)

+

Config setting change

+
    +
  • Geodesic measurement mode is now configured at toplevel in config.json via geodesicMeasurements: true|false rather than below Map -> cfg -> toolsOptions -> MeasurementSupport.
    • +
+

Update to qwc2 submodule revision 7a474e3 (23.01.2023)

+

Dependency update

+

Most dependencies have been updated to the latest version. The following adjustments need to be performed by hand:

+
    +
  • Use createRoot in app.jsx, see the demo app.jsx.
    • +
  • +

    Update uuid imports in external components, examples:

    +

    import {v1 as uuidv1} from 'uuid'; + import {v4 as uuidv4} from 'uuid';

    +
    • +
+

and then instead of uuid.v1() use uuidv1() etc.

+
    +
  • +

    Adjust webpack.config.js from

    +

    { + test: /.mjs$/, + type: 'javascript/auto' + }

    +
    • +
+

to

+
  {
+    test: /(.mjs|.js)$/,
+    type: 'javascript/auto'
+  }
+
+

Update to qwc2 submodule revision fe063b6 (13.01.2023)

+

Reworked search provider support

+

The arguments and expected behaviour of the provider onSearch and getResultGeometry have changed. Please refer to the documentation chapter in the Documentation. Consult js/SearchProviders.js and static/assets/searchProviders.js for full examples.

+

It is now possible to define search providers in a external JS file loaded at runtime rather than compiled into the application bundle. See static/assets/searchProviders.js, which is loaded by index.html.

+

js/SearchProviders.js now only includes coordinates and nominatim as built-in search providers for the demo application.

+

The searchProviderFactory function has been removed from js/SearchProviders.js. Instead, custom parameters to be passed to a provider can be specified directly in the theme item searchProviders entry:

+
{
+  key: "<providerkey2>",
+  params: {...}
+}
+
+

and read from searchParams.cfgParams in the provider onSearch function.

+

Load Help dialog contents from HTML fragment

+

Instead of requiring users to implement the renderHelp function in js/Help.jsx, for simple cases the users can provide a plain HTML fragment which is loaded at runtime from the assets. Consult the Documentation.

+

Update to qwc2 submodule revision 90c613a (28.11.2022)

+

Reworked color scheme support

+

The styleConfig.js file is deprecated and won't be honoured anymore for the styling of core QWC2 components. Instead, base theme colors can be defined via CSS, refer to documentation for details.

+

Renamed config variable +The maxGetUrlLength variable in config.json has been renamed to wmsMaxGetUrlLength.

+

Update to qwc2 submodule revision e357152 (27.06.2022)

+

Reworked interface for handling 1:N relations between qwc2 and qwc-data-service

+

The interface for reading and writing 1:n relations between the qwc2 and the qwc-data-service was reworked. If you are using the qwc-data-service, make sure to update to qwc-data-service-v2022.06.27 or later when updating to qwc2 submodule revision e357152 or later.

+

Update to qwc2 submodule revision 76ec566 (17.06.2022)

+

Refactoring of editing components

+

The editing components have been heavily refactored internally. The changes are mostly transparent, but two points are important:

+
    +
  • The editDataset field of an editConfig entry is now mandatory. editConfigs generated by qwc-config-generator already write this field, so this applies only to manually written editConfigs for use outside of qwc-services.
    • +
  • The changeEditingState action has been replaced by setEditContext (and clearEditContext). This allows for storing and switching between multiple edit contexts in the application state. Custom components interacting with editing also should be changed to verify that the current edit context is the desired one.
    • +
+

Update to qwc2 submodule revision 7929587 (21.04.2022)

+

Format change for external layer resource strings

+

For a short period of time (after submodule revision cb870a1), QWC2 supported external resource strings in the form wms:<service_url>#<layername>?<options>. The format has been changed to

+
wms:<service_url>?<options>#<layername>
+
+

i.e. by moving the query portion before the hash portion, which is inline with the URL scheme format.

+

Update to qwc2 submodule revision eb5e358 (25.10.2021)

+

Update to Webpack 5, React 17

+
    +
  • Synchronize the webpack.config.js and the dependencies and package scripts from the demo app package.json. Note that the build package script is now an alias with the prod script.
    • +
  • Remove the dist/App.js script include from index.html, it is now added automatically by Webpack.
    • +
  • All static files of the app need to be placed below a toplevel static folder, which will contain assets, translations, config.json, themes.json, etc. The themesConfig script will write themes.json to that folder.
    • +
  • +

    In custom components, replace any use of Swipeable from react-swipeable:

    +
      +
    • import {Swipeable} from 'react-swipeable';
      • +
    • import {Swipeable} from 'qwc2/components/Swipeable';
      • +
    +
    • +
+

Update to qwc2 submodule revision e08aed5 (18.05.2021)

+

Reworked Identify plugin

+

The Identify plugin has been completely reworked, and the IdentifyRegion plugin has been merged into the Identify plugin:

+
    +
  • Remove the IdentifyRegion plugin from js/appConfig.js and config.json
    • +
  • +

    Create menu/toolbar entries in config.json for the region identify tool mode by specifying "mode": "Region", i.e.:

    +

    {"key": "Identify", "icon": "identify_region", "mode": "Region"},

    +
    • +
  • +

    The translation message id identifyregion.info has been changed to infotool.clickhelpPolygon (unless the string is overridden, yarn run tsupdate will take care of this automatically).

    +
    • +
  • Note: The identify tool state is now handled internally by the Identify component, it does not store the results in the global application state anymore.
    • +
+

Update to qwc2 submodule revision 317eea3 (03.01.2021)

+

Updated dependencies

+

Many dependencies in the qwc2 submodule have been update, please run yarn install to update them in your application.

+

In the demo app, also many dependencies in the application package.json have been updated. +It's recommended to synchronize the application package.json and webpack.config.js with the ones of the demo app.

+

Plugins do not need to specify the reducers they use anymore

+

Action files register now the reducers they use automatically, so whenever a symbol is imported from an action file, the respective reducer is automatically enabled.

+

If you have a custom action/reducer file outside the qwc2 submodule folder (i.e. js/{actions,reducers}/myfunctionality.js), you should add lines similar to

+
import ReducerIndex from 'qwc2/reducers/index';
+import myfunctionalityReducer from '/reducers/myfunctionality';
+ReducerIndex.register("myfunctionality", myfunctionalityReducer);
+
+

to js/actions/myfunctionality.js.

+

If you have custom QWC2 plugins, remove the reducers field of the plugin export.

+

ES6 imports

+

QWC2 now uses the ES6 import/export syntax throughout. For instance

+
const Icon = require('qwc2/components/Icon');
+const {addLayer} = require('qwc2/actions/layers');
+
+

become

+
import Icon from 'qwc2/components/Icon';
+import {addLayer} from 'qwc2/actions/layers';
+
+

And

+
module.exports = MyClass;
+
+

becomes

+
export default MyClass;
+
+

resp.

+
function foo() {...};
+function bar() {...};
+module.exports = {foo, bar};
+
+

becomes

+
export function foo() {...};
+export function bar() {...};
+
+

In particular, js/appConfig.js needs to be heavily adapted.

+

Update to React 16.14

+

As per React 16.3, various component lifecycle methods have been deprecated. +All qwc2 core components are updated to avoid their use. Custom components should also be updated. +See https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html for details.

+

Reworked localization

+

Localization in QWC2 has been reworked: +- Instead of <Message msgId="<msgid>" /> and LocaleUtils.getMessageById(), use LocaleUtils.tr(<msgid>). +- For message IDs which are not translated directly via LocaleUtils.tr, use LocaleUtils.trmsg to mark the string as a message ID. +- The Message component has been dropped. +- Static message IDs are now picked up automatically by updateTranslations.js (invoked by yarn run tsupdate). +- Message IDs built at runtime will beed to be specified manually in tsconfig.json in the extra_strings section. +- The translation files are now called translations/<lang>-<COUNTRY>.json rather than translations/data.<lang>-<COUNTRY>. The format of the files remains unchanged. +- The supportedLocales section in appConfig.js needs to be dropped. +- Previously, the fallback locale was specified as fallbacklocale in config.json. Now, it must be specified as defaultLocaleData in appConfig.js.

+

Default editing interface now shipped in the qwc2 submodule

+

The js/EditingInterface.js in the demo app has been moved to qwc2/utils/EditingInterface.js. +This is the interface which acts as a counterpart to the QWC data service. +If you want to use a custom editing interface, you can still do so, passing it to the Editing plugin in appConfig.js as before.

+

Assets and translations path now optional

+

Assets and translations path can now be omitted from the config.json, and are resolved to assets resp translations relative to the index.html path of the QWC2 application by default.

+

Use ConfigUtils.getAssetsPath() and ConfigUtils.getTranslationsPath() in your custom components instead of ConfigUtils.getConfigProp.

+

You can still specify assetsPath and translationsPath in config.json to override the default values.

+

Changes to map click point/feature state

+

The previous state.map.clickPoint and state.map.clickFeature have been merged to a single state.map.click. The clickFeatureOnMap action has been removed.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/release_notes/QwcDockerUpgradeNotes/index.html b/release_notes/QwcDockerUpgradeNotes/index.html new file mode 100644 index 00000000..8c4827ba --- /dev/null +++ b/release_notes/QwcDockerUpgradeNotes/index.html @@ -0,0 +1,190 @@ + + + + + + + + qwc-docker upgrade notes - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Version history »
    • +
  • qwc-docker upgrade notes
    • +
  • +
    • +
+
+
+
+
+ +

Upgrading to qwc service images v2022.01.26

+

The qwc-uwsgi-base images have been changed to allow for configurable UID/GID of the uwsgi process. The default is UID=33 and GID=33, you can override it by setting the SERVICE_UID and SERVICE_GID environment variables in docker-compose.yml.

+

As a consequence, /var/www is not necessarily anymore the home directory of the user wich runs uwsgi, and therefore the qwc-uwsgi-base images now set ENV PGSERVICEFILE="/srv/pg_service.conf". You'll therefore need to adapt your pg_service.conf volume mounts in your docker-compose.yml to point to that location, i.e.

+
[...]
+- ./pg_service.conf:/srv/pg_service.conf:ro
+[...]
+
+

Upgrading to qwc-config-generator-v2022.01.12

+
    +
  • scanned_projects_path_prefix has been dropped as a config setting. Instead, qgis_projects_scan_base_dir must be a directory below qgis_projects_base_dir, and the prefix is automatically computed internally.
    • +
  • scanned_projects_path_prefix has been added as a config setting as the output path for preprocessed qgis projects. It must be a directory below qgis_projects_base_dir to which the config service is allowed to write.
    • +
+

Upgrading from qwc service images v2021.x to v2022.01.08 or later

+

Starting with v2022.01.08, the requirements of all services where updated to use Flask-JWT-Extended 4.3.1.

+

Flask-JWT-4.x changes the JWT format (see 4.0.0 Breaking Changes), which can result in QWC Services returning a Missing claim: identity error message.

+

To avoid this: +* Change your JWT secret key in .env. +* Ensure all services are upgraded to v2022.01.12 or later (if such a version exists). Please omit v2022.01.08 and v2022.01.11.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/search.html b/search.html new file mode 100644 index 00000000..648fddf7 --- /dev/null +++ b/search.html @@ -0,0 +1,164 @@ + + + + + + + + QWC2 - latest + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • +
    • +
+
+
+
+
+ + +

Search Results

+ +
+ + +
+ +
+ Searching... +
+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + diff --git a/search/lunr.js b/search/lunr.js new file mode 100644 index 00000000..aca0a167 --- /dev/null +++ b/search/lunr.js @@ -0,0 +1,3475 @@ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ + +;(function(){ + +/** + * A convenience function for configuring and constructing + * a new lunr Index. + * + * A lunr.Builder instance is created and the pipeline setup + * with a trimmer, stop word filter and stemmer. + * + * This builder object is yielded to the configuration function + * that is passed as a parameter, allowing the list of fields + * and other builder parameters to be customised. + * + * All documents _must_ be added within the passed config function. + * + * @example + * var idx = lunr(function () { + * this.field('title') + * this.field('body') + * this.ref('id') + * + * documents.forEach(function (doc) { + * this.add(doc) + * }, this) + * }) + * + * @see {@link lunr.Builder} + * @see {@link lunr.Pipeline} + * @see {@link lunr.trimmer} + * @see {@link lunr.stopWordFilter} + * @see {@link lunr.stemmer} + * @namespace {function} lunr + */ +var lunr = function (config) { + var builder = new lunr.Builder + + builder.pipeline.add( + lunr.trimmer, + lunr.stopWordFilter, + lunr.stemmer + ) + + builder.searchPipeline.add( + lunr.stemmer + ) + + config.call(builder, builder) + return builder.build() +} + +lunr.version = "2.3.9" +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A namespace containing utils for the rest of the lunr library + * @namespace lunr.utils + */ +lunr.utils = {} + +/** + * Print a warning message to the console. + * + * @param {String} message The message to be printed. + * @memberOf lunr.utils + * @function + */ +lunr.utils.warn = (function (global) { + /* eslint-disable no-console */ + return function (message) { + if (global.console && console.warn) { + console.warn(message) + } + } + /* eslint-enable no-console */ +})(this) + +/** + * Convert an object to a string. + * + * In the case of `null` and `undefined` the function returns + * the empty string, in all other cases the result of calling + * `toString` on the passed object is returned. + * + * @param {Any} obj The object to convert to a string. + * @return {String} string representation of the passed object. + * @memberOf lunr.utils + */ +lunr.utils.asString = function (obj) { + if (obj === void 0 || obj === null) { + return "" + } else { + return obj.toString() + } +} + +/** + * Clones an object. + * + * Will create a copy of an existing object such that any mutations + * on the copy cannot affect the original. + * + * Only shallow objects are supported, passing a nested object to this + * function will cause a TypeError. + * + * Objects with primitives, and arrays of primitives are supported. + * + * @param {Object} obj The object to clone. + * @return {Object} a clone of the passed object. + * @throws {TypeError} when a nested object is passed. + * @memberOf Utils + */ +lunr.utils.clone = function (obj) { + if (obj === null || obj === undefined) { + return obj + } + + var clone = Object.create(null), + keys = Object.keys(obj) + + for (var i = 0; i < keys.length; i++) { + var key = keys[i], + val = obj[key] + + if (Array.isArray(val)) { + clone[key] = val.slice() + continue + } + + if (typeof val === 'string' || + typeof val === 'number' || + typeof val === 'boolean') { + clone[key] = val + continue + } + + throw new TypeError("clone is not deep and does not support nested objects") + } + + return clone +} +lunr.FieldRef = function (docRef, fieldName, stringValue) { + this.docRef = docRef + this.fieldName = fieldName + this._stringValue = stringValue +} + +lunr.FieldRef.joiner = "/" + +lunr.FieldRef.fromString = function (s) { + var n = s.indexOf(lunr.FieldRef.joiner) + + if (n === -1) { + throw "malformed field ref string" + } + + var fieldRef = s.slice(0, n), + docRef = s.slice(n + 1) + + return new lunr.FieldRef (docRef, fieldRef, s) +} + +lunr.FieldRef.prototype.toString = function () { + if (this._stringValue == undefined) { + this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef + } + + return this._stringValue +} +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A lunr set. + * + * @constructor + */ +lunr.Set = function (elements) { + this.elements = Object.create(null) + + if (elements) { + this.length = elements.length + + for (var i = 0; i < this.length; i++) { + this.elements[elements[i]] = true + } + } else { + this.length = 0 + } +} + +/** + * A complete set that contains all elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ +lunr.Set.complete = { + intersect: function (other) { + return other + }, + + union: function () { + return this + }, + + contains: function () { + return true + } +} + +/** + * An empty set that contains no elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ +lunr.Set.empty = { + intersect: function () { + return this + }, + + union: function (other) { + return other + }, + + contains: function () { + return false + } +} + +/** + * Returns true if this set contains the specified object. + * + * @param {object} object - Object whose presence in this set is to be tested. + * @returns {boolean} - True if this set contains the specified object. + */ +lunr.Set.prototype.contains = function (object) { + return !!this.elements[object] +} + +/** + * Returns a new set containing only the elements that are present in both + * this set and the specified set. + * + * @param {lunr.Set} other - set to intersect with this set. + * @returns {lunr.Set} a new set that is the intersection of this and the specified set. + */ + +lunr.Set.prototype.intersect = function (other) { + var a, b, elements, intersection = [] + + if (other === lunr.Set.complete) { + return this + } + + if (other === lunr.Set.empty) { + return other + } + + if (this.length < other.length) { + a = this + b = other + } else { + a = other + b = this + } + + elements = Object.keys(a.elements) + + for (var i = 0; i < elements.length; i++) { + var element = elements[i] + if (element in b.elements) { + intersection.push(element) + } + } + + return new lunr.Set (intersection) +} + +/** + * Returns a new set combining the elements of this and the specified set. + * + * @param {lunr.Set} other - set to union with this set. + * @return {lunr.Set} a new set that is the union of this and the specified set. + */ + +lunr.Set.prototype.union = function (other) { + if (other === lunr.Set.complete) { + return lunr.Set.complete + } + + if (other === lunr.Set.empty) { + return this + } + + return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements))) +} +/** + * A function to calculate the inverse document frequency for + * a posting. This is shared between the builder and the index + * + * @private + * @param {object} posting - The posting for a given term + * @param {number} documentCount - The total number of documents. + */ +lunr.idf = function (posting, documentCount) { + var documentsWithTerm = 0 + + for (var fieldName in posting) { + if (fieldName == '_index') continue // Ignore the term index, its not a field + documentsWithTerm += Object.keys(posting[fieldName]).length + } + + var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5) + + return Math.log(1 + Math.abs(x)) +} + +/** + * A token wraps a string representation of a token + * as it is passed through the text processing pipeline. + * + * @constructor + * @param {string} [str=''] - The string token being wrapped. + * @param {object} [metadata={}] - Metadata associated with this token. + */ +lunr.Token = function (str, metadata) { + this.str = str || "" + this.metadata = metadata || {} +} + +/** + * Returns the token string that is being wrapped by this object. + * + * @returns {string} + */ +lunr.Token.prototype.toString = function () { + return this.str +} + +/** + * A token update function is used when updating or optionally + * when cloning a token. + * + * @callback lunr.Token~updateFunction + * @param {string} str - The string representation of the token. + * @param {Object} metadata - All metadata associated with this token. + */ + +/** + * Applies the given function to the wrapped string token. + * + * @example + * token.update(function (str, metadata) { + * return str.toUpperCase() + * }) + * + * @param {lunr.Token~updateFunction} fn - A function to apply to the token string. + * @returns {lunr.Token} + */ +lunr.Token.prototype.update = function (fn) { + this.str = fn(this.str, this.metadata) + return this +} + +/** + * Creates a clone of this token. Optionally a function can be + * applied to the cloned token. + * + * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token. + * @returns {lunr.Token} + */ +lunr.Token.prototype.clone = function (fn) { + fn = fn || function (s) { return s } + return new lunr.Token (fn(this.str, this.metadata), this.metadata) +} +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A function for splitting a string into tokens ready to be inserted into + * the search index. Uses `lunr.tokenizer.separator` to split strings, change + * the value of this property to change how strings are split into tokens. + * + * This tokenizer will convert its parameter to a string by calling `toString` and + * then will split this string on the character in `lunr.tokenizer.separator`. + * Arrays will have their elements converted to strings and wrapped in a lunr.Token. + * + * Optional metadata can be passed to the tokenizer, this metadata will be cloned and + * added as metadata to every token that is created from the object to be tokenized. + * + * @static + * @param {?(string|object|object[])} obj - The object to convert into tokens + * @param {?object} metadata - Optional metadata to associate with every token + * @returns {lunr.Token[]} + * @see {@link lunr.Pipeline} + */ +lunr.tokenizer = function (obj, metadata) { + if (obj == null || obj == undefined) { + return [] + } + + if (Array.isArray(obj)) { + return obj.map(function (t) { + return new lunr.Token( + lunr.utils.asString(t).toLowerCase(), + lunr.utils.clone(metadata) + ) + }) + } + + var str = obj.toString().toLowerCase(), + len = str.length, + tokens = [] + + for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) { + var char = str.charAt(sliceEnd), + sliceLength = sliceEnd - sliceStart + + if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) { + + if (sliceLength > 0) { + var tokenMetadata = lunr.utils.clone(metadata) || {} + tokenMetadata["position"] = [sliceStart, sliceLength] + tokenMetadata["index"] = tokens.length + + tokens.push( + new lunr.Token ( + str.slice(sliceStart, sliceEnd), + tokenMetadata + ) + ) + } + + sliceStart = sliceEnd + 1 + } + + } + + return tokens +} + +/** + * The separator used to split a string into tokens. Override this property to change the behaviour of + * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens. + * + * @static + * @see lunr.tokenizer + */ +lunr.tokenizer.separator = /[\s\-]+/ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.Pipelines maintain an ordered list of functions to be applied to all + * tokens in documents entering the search index and queries being ran against + * the index. + * + * An instance of lunr.Index created with the lunr shortcut will contain a + * pipeline with a stop word filter and an English language stemmer. Extra + * functions can be added before or after either of these functions or these + * default functions can be removed. + * + * When run the pipeline will call each function in turn, passing a token, the + * index of that token in the original list of all tokens and finally a list of + * all the original tokens. + * + * The output of functions in the pipeline will be passed to the next function + * in the pipeline. To exclude a token from entering the index the function + * should return undefined, the rest of the pipeline will not be called with + * this token. + * + * For serialisation of pipelines to work, all functions used in an instance of + * a pipeline should be registered with lunr.Pipeline. Registered functions can + * then be loaded. If trying to load a serialised pipeline that uses functions + * that are not registered an error will be thrown. + * + * If not planning on serialising the pipeline then registering pipeline functions + * is not necessary. + * + * @constructor + */ +lunr.Pipeline = function () { + this._stack = [] +} + +lunr.Pipeline.registeredFunctions = Object.create(null) + +/** + * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token + * string as well as all known metadata. A pipeline function can mutate the token string + * or mutate (or add) metadata for a given token. + * + * A pipeline function can indicate that the passed token should be discarded by returning + * null, undefined or an empty string. This token will not be passed to any downstream pipeline + * functions and will not be added to the index. + * + * Multiple tokens can be returned by returning an array of tokens. Each token will be passed + * to any downstream pipeline functions and all will returned tokens will be added to the index. + * + * Any number of pipeline functions may be chained together using a lunr.Pipeline. + * + * @interface lunr.PipelineFunction + * @param {lunr.Token} token - A token from the document being processed. + * @param {number} i - The index of this token in the complete list of tokens for this document/field. + * @param {lunr.Token[]} tokens - All tokens for this document/field. + * @returns {(?lunr.Token|lunr.Token[])} + */ + +/** + * Register a function with the pipeline. + * + * Functions that are used in the pipeline should be registered if the pipeline + * needs to be serialised, or a serialised pipeline needs to be loaded. + * + * Registering a function does not add it to a pipeline, functions must still be + * added to instances of the pipeline for them to be used when running a pipeline. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @param {String} label - The label to register this function with + */ +lunr.Pipeline.registerFunction = function (fn, label) { + if (label in this.registeredFunctions) { + lunr.utils.warn('Overwriting existing registered function: ' + label) + } + + fn.label = label + lunr.Pipeline.registeredFunctions[fn.label] = fn +} + +/** + * Warns if the function is not registered as a Pipeline function. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @private + */ +lunr.Pipeline.warnIfFunctionNotRegistered = function (fn) { + var isRegistered = fn.label && (fn.label in this.registeredFunctions) + + if (!isRegistered) { + lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\n', fn) + } +} + +/** + * Loads a previously serialised pipeline. + * + * All functions to be loaded must already be registered with lunr.Pipeline. + * If any function from the serialised data has not been registered then an + * error will be thrown. + * + * @param {Object} serialised - The serialised pipeline to load. + * @returns {lunr.Pipeline} + */ +lunr.Pipeline.load = function (serialised) { + var pipeline = new lunr.Pipeline + + serialised.forEach(function (fnName) { + var fn = lunr.Pipeline.registeredFunctions[fnName] + + if (fn) { + pipeline.add(fn) + } else { + throw new Error('Cannot load unregistered function: ' + fnName) + } + }) + + return pipeline +} + +/** + * Adds new functions to the end of the pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline. + */ +lunr.Pipeline.prototype.add = function () { + var fns = Array.prototype.slice.call(arguments) + + fns.forEach(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + this._stack.push(fn) + }, this) +} + +/** + * Adds a single function after a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ +lunr.Pipeline.prototype.after = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + pos = pos + 1 + this._stack.splice(pos, 0, newFn) +} + +/** + * Adds a single function before a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ +lunr.Pipeline.prototype.before = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + this._stack.splice(pos, 0, newFn) +} + +/** + * Removes a function from the pipeline. + * + * @param {lunr.PipelineFunction} fn The function to remove from the pipeline. + */ +lunr.Pipeline.prototype.remove = function (fn) { + var pos = this._stack.indexOf(fn) + if (pos == -1) { + return + } + + this._stack.splice(pos, 1) +} + +/** + * Runs the current list of functions that make up the pipeline against the + * passed tokens. + * + * @param {Array} tokens The tokens to run through the pipeline. + * @returns {Array} + */ +lunr.Pipeline.prototype.run = function (tokens) { + var stackLength = this._stack.length + + for (var i = 0; i < stackLength; i++) { + var fn = this._stack[i] + var memo = [] + + for (var j = 0; j < tokens.length; j++) { + var result = fn(tokens[j], j, tokens) + + if (result === null || result === void 0 || result === '') continue + + if (Array.isArray(result)) { + for (var k = 0; k < result.length; k++) { + memo.push(result[k]) + } + } else { + memo.push(result) + } + } + + tokens = memo + } + + return tokens +} + +/** + * Convenience method for passing a string through a pipeline and getting + * strings out. This method takes care of wrapping the passed string in a + * token and mapping the resulting tokens back to strings. + * + * @param {string} str - The string to pass through the pipeline. + * @param {?object} metadata - Optional metadata to associate with the token + * passed to the pipeline. + * @returns {string[]} + */ +lunr.Pipeline.prototype.runString = function (str, metadata) { + var token = new lunr.Token (str, metadata) + + return this.run([token]).map(function (t) { + return t.toString() + }) +} + +/** + * Resets the pipeline by removing any existing processors. + * + */ +lunr.Pipeline.prototype.reset = function () { + this._stack = [] +} + +/** + * Returns a representation of the pipeline ready for serialisation. + * + * Logs a warning if the function has not been registered. + * + * @returns {Array} + */ +lunr.Pipeline.prototype.toJSON = function () { + return this._stack.map(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + + return fn.label + }) +} +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A vector is used to construct the vector space of documents and queries. These + * vectors support operations to determine the similarity between two documents or + * a document and a query. + * + * Normally no parameters are required for initializing a vector, but in the case of + * loading a previously dumped vector the raw elements can be provided to the constructor. + * + * For performance reasons vectors are implemented with a flat array, where an elements + * index is immediately followed by its value. E.g. [index, value, index, value]. This + * allows the underlying array to be as sparse as possible and still offer decent + * performance when being used for vector calculations. + * + * @constructor + * @param {Number[]} [elements] - The flat list of element index and element value pairs. + */ +lunr.Vector = function (elements) { + this._magnitude = 0 + this.elements = elements || [] +} + + +/** + * Calculates the position within the vector to insert a given index. + * + * This is used internally by insert and upsert. If there are duplicate indexes then + * the position is returned as if the value for that index were to be updated, but it + * is the callers responsibility to check whether there is a duplicate at that index + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @returns {Number} + */ +lunr.Vector.prototype.positionForIndex = function (index) { + // For an empty vector the tuple can be inserted at the beginning + if (this.elements.length == 0) { + return 0 + } + + var start = 0, + end = this.elements.length / 2, + sliceLength = end - start, + pivotPoint = Math.floor(sliceLength / 2), + pivotIndex = this.elements[pivotPoint * 2] + + while (sliceLength > 1) { + if (pivotIndex < index) { + start = pivotPoint + } + + if (pivotIndex > index) { + end = pivotPoint + } + + if (pivotIndex == index) { + break + } + + sliceLength = end - start + pivotPoint = start + Math.floor(sliceLength / 2) + pivotIndex = this.elements[pivotPoint * 2] + } + + if (pivotIndex == index) { + return pivotPoint * 2 + } + + if (pivotIndex > index) { + return pivotPoint * 2 + } + + if (pivotIndex < index) { + return (pivotPoint + 1) * 2 + } +} + +/** + * Inserts an element at an index within the vector. + * + * Does not allow duplicates, will throw an error if there is already an entry + * for this index. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + */ +lunr.Vector.prototype.insert = function (insertIdx, val) { + this.upsert(insertIdx, val, function () { + throw "duplicate index" + }) +} + +/** + * Inserts or updates an existing index within the vector. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + * @param {function} fn - A function that is called for updates, the existing value and the + * requested value are passed as arguments + */ +lunr.Vector.prototype.upsert = function (insertIdx, val, fn) { + this._magnitude = 0 + var position = this.positionForIndex(insertIdx) + + if (this.elements[position] == insertIdx) { + this.elements[position + 1] = fn(this.elements[position + 1], val) + } else { + this.elements.splice(position, 0, insertIdx, val) + } +} + +/** + * Calculates the magnitude of this vector. + * + * @returns {Number} + */ +lunr.Vector.prototype.magnitude = function () { + if (this._magnitude) return this._magnitude + + var sumOfSquares = 0, + elementsLength = this.elements.length + + for (var i = 1; i < elementsLength; i += 2) { + var val = this.elements[i] + sumOfSquares += val * val + } + + return this._magnitude = Math.sqrt(sumOfSquares) +} + +/** + * Calculates the dot product of this vector and another vector. + * + * @param {lunr.Vector} otherVector - The vector to compute the dot product with. + * @returns {Number} + */ +lunr.Vector.prototype.dot = function (otherVector) { + var dotProduct = 0, + a = this.elements, b = otherVector.elements, + aLen = a.length, bLen = b.length, + aVal = 0, bVal = 0, + i = 0, j = 0 + + while (i < aLen && j < bLen) { + aVal = a[i], bVal = b[j] + if (aVal < bVal) { + i += 2 + } else if (aVal > bVal) { + j += 2 + } else if (aVal == bVal) { + dotProduct += a[i + 1] * b[j + 1] + i += 2 + j += 2 + } + } + + return dotProduct +} + +/** + * Calculates the similarity between this vector and another vector. + * + * @param {lunr.Vector} otherVector - The other vector to calculate the + * similarity with. + * @returns {Number} + */ +lunr.Vector.prototype.similarity = function (otherVector) { + return this.dot(otherVector) / this.magnitude() || 0 +} + +/** + * Converts the vector to an array of the elements within the vector. + * + * @returns {Number[]} + */ +lunr.Vector.prototype.toArray = function () { + var output = new Array (this.elements.length / 2) + + for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) { + output[j] = this.elements[i] + } + + return output +} + +/** + * A JSON serializable representation of the vector. + * + * @returns {Number[]} + */ +lunr.Vector.prototype.toJSON = function () { + return this.elements +} +/* eslint-disable */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ + +/** + * lunr.stemmer is an english language stemmer, this is a JavaScript + * implementation of the PorterStemmer taken from http://tartarus.org/~martin + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token - The string to stem + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + * @function + */ +lunr.stemmer = (function(){ + var step2list = { + "ational" : "ate", + "tional" : "tion", + "enci" : "ence", + "anci" : "ance", + "izer" : "ize", + "bli" : "ble", + "alli" : "al", + "entli" : "ent", + "eli" : "e", + "ousli" : "ous", + "ization" : "ize", + "ation" : "ate", + "ator" : "ate", + "alism" : "al", + "iveness" : "ive", + "fulness" : "ful", + "ousness" : "ous", + "aliti" : "al", + "iviti" : "ive", + "biliti" : "ble", + "logi" : "log" + }, + + step3list = { + "icate" : "ic", + "ative" : "", + "alize" : "al", + "iciti" : "ic", + "ical" : "ic", + "ful" : "", + "ness" : "" + }, + + c = "[^aeiou]", // consonant + v = "[aeiouy]", // vowel + C = c + "[^aeiouy]*", // consonant sequence + V = v + "[aeiou]*", // vowel sequence + + mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0 + meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1 + mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1 + s_v = "^(" + C + ")?" + v; // vowel in stem + + var re_mgr0 = new RegExp(mgr0); + var re_mgr1 = new RegExp(mgr1); + var re_meq1 = new RegExp(meq1); + var re_s_v = new RegExp(s_v); + + var re_1a = /^(.+?)(ss|i)es$/; + var re2_1a = /^(.+?)([^s])s$/; + var re_1b = /^(.+?)eed$/; + var re2_1b = /^(.+?)(ed|ing)$/; + var re_1b_2 = /.$/; + var re2_1b_2 = /(at|bl|iz)$/; + var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$"); + var re4_1b_2 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var re_1c = /^(.+?[^aeiou])y$/; + var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + + var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + + var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + var re2_4 = /^(.+?)(s|t)(ion)$/; + + var re_5 = /^(.+?)e$/; + var re_5_1 = /ll$/; + var re3_5 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var porterStemmer = function porterStemmer(w) { + var stem, + suffix, + firstch, + re, + re2, + re3, + re4; + + if (w.length < 3) { return w; } + + firstch = w.substr(0,1); + if (firstch == "y") { + w = firstch.toUpperCase() + w.substr(1); + } + + // Step 1a + re = re_1a + re2 = re2_1a; + + if (re.test(w)) { w = w.replace(re,"$1$2"); } + else if (re2.test(w)) { w = w.replace(re2,"$1$2"); } + + // Step 1b + re = re_1b; + re2 = re2_1b; + if (re.test(w)) { + var fp = re.exec(w); + re = re_mgr0; + if (re.test(fp[1])) { + re = re_1b_2; + w = w.replace(re,""); + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = re_s_v; + if (re2.test(stem)) { + w = stem; + re2 = re2_1b_2; + re3 = re3_1b_2; + re4 = re4_1b_2; + if (re2.test(w)) { w = w + "e"; } + else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,""); } + else if (re4.test(w)) { w = w + "e"; } + } + } + + // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say) + re = re_1c; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + w = stem + "i"; + } + + // Step 2 + re = re_2; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step2list[suffix]; + } + } + + // Step 3 + re = re_3; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step3list[suffix]; + } + } + + // Step 4 + re = re_4; + re2 = re2_4; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + if (re.test(stem)) { + w = stem; + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = re_mgr1; + if (re2.test(stem)) { + w = stem; + } + } + + // Step 5 + re = re_5; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + re2 = re_meq1; + re3 = re3_5; + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) { + w = stem; + } + } + + re = re_5_1; + re2 = re_mgr1; + if (re.test(w) && re2.test(w)) { + re = re_1b_2; + w = w.replace(re,""); + } + + // and turn initial Y back to y + + if (firstch == "y") { + w = firstch.toLowerCase() + w.substr(1); + } + + return w; + }; + + return function (token) { + return token.update(porterStemmer); + } +})(); + +lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer') +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.generateStopWordFilter builds a stopWordFilter function from the provided + * list of stop words. + * + * The built in lunr.stopWordFilter is built using this generator and can be used + * to generate custom stopWordFilters for applications or non English languages. + * + * @function + * @param {Array} token The token to pass through the filter + * @returns {lunr.PipelineFunction} + * @see lunr.Pipeline + * @see lunr.stopWordFilter + */ +lunr.generateStopWordFilter = function (stopWords) { + var words = stopWords.reduce(function (memo, stopWord) { + memo[stopWord] = stopWord + return memo + }, {}) + + return function (token) { + if (token && words[token.toString()] !== token.toString()) return token + } +} + +/** + * lunr.stopWordFilter is an English language stop word list filter, any words + * contained in the list will not be passed through the filter. + * + * This is intended to be used in the Pipeline. If the token does not pass the + * filter then undefined will be returned. + * + * @function + * @implements {lunr.PipelineFunction} + * @params {lunr.Token} token - A token to check for being a stop word. + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + */ +lunr.stopWordFilter = lunr.generateStopWordFilter([ + 'a', + 'able', + 'about', + 'across', + 'after', + 'all', + 'almost', + 'also', + 'am', + 'among', + 'an', + 'and', + 'any', + 'are', + 'as', + 'at', + 'be', + 'because', + 'been', + 'but', + 'by', + 'can', + 'cannot', + 'could', + 'dear', + 'did', + 'do', + 'does', + 'either', + 'else', + 'ever', + 'every', + 'for', + 'from', + 'get', + 'got', + 'had', + 'has', + 'have', + 'he', + 'her', + 'hers', + 'him', + 'his', + 'how', + 'however', + 'i', + 'if', + 'in', + 'into', + 'is', + 'it', + 'its', + 'just', + 'least', + 'let', + 'like', + 'likely', + 'may', + 'me', + 'might', + 'most', + 'must', + 'my', + 'neither', + 'no', + 'nor', + 'not', + 'of', + 'off', + 'often', + 'on', + 'only', + 'or', + 'other', + 'our', + 'own', + 'rather', + 'said', + 'say', + 'says', + 'she', + 'should', + 'since', + 'so', + 'some', + 'than', + 'that', + 'the', + 'their', + 'them', + 'then', + 'there', + 'these', + 'they', + 'this', + 'tis', + 'to', + 'too', + 'twas', + 'us', + 'wants', + 'was', + 'we', + 'were', + 'what', + 'when', + 'where', + 'which', + 'while', + 'who', + 'whom', + 'why', + 'will', + 'with', + 'would', + 'yet', + 'you', + 'your' +]) + +lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter') +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.trimmer is a pipeline function for trimming non word + * characters from the beginning and end of tokens before they + * enter the index. + * + * This implementation may not work correctly for non latin + * characters and should either be removed or adapted for use + * with languages with non-latin characters. + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token The token to pass through the filter + * @returns {lunr.Token} + * @see lunr.Pipeline + */ +lunr.trimmer = function (token) { + return token.update(function (s) { + return s.replace(/^\W+/, '').replace(/\W+$/, '') + }) +} + +lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer') +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A token set is used to store the unique list of all tokens + * within an index. Token sets are also used to represent an + * incoming query to the index, this query token set and index + * token set are then intersected to find which tokens to look + * up in the inverted index. + * + * A token set can hold multiple tokens, as in the case of the + * index token set, or it can hold a single token as in the + * case of a simple query token set. + * + * Additionally token sets are used to perform wildcard matching. + * Leading, contained and trailing wildcards are supported, and + * from this edit distance matching can also be provided. + * + * Token sets are implemented as a minimal finite state automata, + * where both common prefixes and suffixes are shared between tokens. + * This helps to reduce the space used for storing the token set. + * + * @constructor + */ +lunr.TokenSet = function () { + this.final = false + this.edges = {} + this.id = lunr.TokenSet._nextId + lunr.TokenSet._nextId += 1 +} + +/** + * Keeps track of the next, auto increment, identifier to assign + * to a new tokenSet. + * + * TokenSets require a unique identifier to be correctly minimised. + * + * @private + */ +lunr.TokenSet._nextId = 1 + +/** + * Creates a TokenSet instance from the given sorted array of words. + * + * @param {String[]} arr - A sorted array of strings to create the set from. + * @returns {lunr.TokenSet} + * @throws Will throw an error if the input array is not sorted. + */ +lunr.TokenSet.fromArray = function (arr) { + var builder = new lunr.TokenSet.Builder + + for (var i = 0, len = arr.length; i < len; i++) { + builder.insert(arr[i]) + } + + builder.finish() + return builder.root +} + +/** + * Creates a token set from a query clause. + * + * @private + * @param {Object} clause - A single clause from lunr.Query. + * @param {string} clause.term - The query clause term. + * @param {number} [clause.editDistance] - The optional edit distance for the term. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.fromClause = function (clause) { + if ('editDistance' in clause) { + return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance) + } else { + return lunr.TokenSet.fromString(clause.term) + } +} + +/** + * Creates a token set representing a single string with a specified + * edit distance. + * + * Insertions, deletions, substitutions and transpositions are each + * treated as an edit distance of 1. + * + * Increasing the allowed edit distance will have a dramatic impact + * on the performance of both creating and intersecting these TokenSets. + * It is advised to keep the edit distance less than 3. + * + * @param {string} str - The string to create the token set from. + * @param {number} editDistance - The allowed edit distance to match. + * @returns {lunr.Vector} + */ +lunr.TokenSet.fromFuzzyString = function (str, editDistance) { + var root = new lunr.TokenSet + + var stack = [{ + node: root, + editsRemaining: editDistance, + str: str + }] + + while (stack.length) { + var frame = stack.pop() + + // no edit + if (frame.str.length > 0) { + var char = frame.str.charAt(0), + noEditNode + + if (char in frame.node.edges) { + noEditNode = frame.node.edges[char] + } else { + noEditNode = new lunr.TokenSet + frame.node.edges[char] = noEditNode + } + + if (frame.str.length == 1) { + noEditNode.final = true + } + + stack.push({ + node: noEditNode, + editsRemaining: frame.editsRemaining, + str: frame.str.slice(1) + }) + } + + if (frame.editsRemaining == 0) { + continue + } + + // insertion + if ("*" in frame.node.edges) { + var insertionNode = frame.node.edges["*"] + } else { + var insertionNode = new lunr.TokenSet + frame.node.edges["*"] = insertionNode + } + + if (frame.str.length == 0) { + insertionNode.final = true + } + + stack.push({ + node: insertionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str + }) + + // deletion + // can only do a deletion if we have enough edits remaining + // and if there are characters left to delete in the string + if (frame.str.length > 1) { + stack.push({ + node: frame.node, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // deletion + // just removing the last character from the str + if (frame.str.length == 1) { + frame.node.final = true + } + + // substitution + // can only do a substitution if we have enough edits remaining + // and if there are characters left to substitute + if (frame.str.length >= 1) { + if ("*" in frame.node.edges) { + var substitutionNode = frame.node.edges["*"] + } else { + var substitutionNode = new lunr.TokenSet + frame.node.edges["*"] = substitutionNode + } + + if (frame.str.length == 1) { + substitutionNode.final = true + } + + stack.push({ + node: substitutionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // transposition + // can only do a transposition if there are edits remaining + // and there are enough characters to transpose + if (frame.str.length > 1) { + var charA = frame.str.charAt(0), + charB = frame.str.charAt(1), + transposeNode + + if (charB in frame.node.edges) { + transposeNode = frame.node.edges[charB] + } else { + transposeNode = new lunr.TokenSet + frame.node.edges[charB] = transposeNode + } + + if (frame.str.length == 1) { + transposeNode.final = true + } + + stack.push({ + node: transposeNode, + editsRemaining: frame.editsRemaining - 1, + str: charA + frame.str.slice(2) + }) + } + } + + return root +} + +/** + * Creates a TokenSet from a string. + * + * The string may contain one or more wildcard characters (*) + * that will allow wildcard matching when intersecting with + * another TokenSet. + * + * @param {string} str - The string to create a TokenSet from. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.fromString = function (str) { + var node = new lunr.TokenSet, + root = node + + /* + * Iterates through all characters within the passed string + * appending a node for each character. + * + * When a wildcard character is found then a self + * referencing edge is introduced to continually match + * any number of any characters. + */ + for (var i = 0, len = str.length; i < len; i++) { + var char = str[i], + final = (i == len - 1) + + if (char == "*") { + node.edges[char] = node + node.final = final + + } else { + var next = new lunr.TokenSet + next.final = final + + node.edges[char] = next + node = next + } + } + + return root +} + +/** + * Converts this TokenSet into an array of strings + * contained within the TokenSet. + * + * This is not intended to be used on a TokenSet that + * contains wildcards, in these cases the results are + * undefined and are likely to cause an infinite loop. + * + * @returns {string[]} + */ +lunr.TokenSet.prototype.toArray = function () { + var words = [] + + var stack = [{ + prefix: "", + node: this + }] + + while (stack.length) { + var frame = stack.pop(), + edges = Object.keys(frame.node.edges), + len = edges.length + + if (frame.node.final) { + /* In Safari, at this point the prefix is sometimes corrupted, see: + * https://github.com/olivernn/lunr.js/issues/279 Calling any + * String.prototype method forces Safari to "cast" this string to what + * it's supposed to be, fixing the bug. */ + frame.prefix.charAt(0) + words.push(frame.prefix) + } + + for (var i = 0; i < len; i++) { + var edge = edges[i] + + stack.push({ + prefix: frame.prefix.concat(edge), + node: frame.node.edges[edge] + }) + } + } + + return words +} + +/** + * Generates a string representation of a TokenSet. + * + * This is intended to allow TokenSets to be used as keys + * in objects, largely to aid the construction and minimisation + * of a TokenSet. As such it is not designed to be a human + * friendly representation of the TokenSet. + * + * @returns {string} + */ +lunr.TokenSet.prototype.toString = function () { + // NOTE: Using Object.keys here as this.edges is very likely + // to enter 'hash-mode' with many keys being added + // + // avoiding a for-in loop here as it leads to the function + // being de-optimised (at least in V8). From some simple + // benchmarks the performance is comparable, but allowing + // V8 to optimize may mean easy performance wins in the future. + + if (this._str) { + return this._str + } + + var str = this.final ? '1' : '0', + labels = Object.keys(this.edges).sort(), + len = labels.length + + for (var i = 0; i < len; i++) { + var label = labels[i], + node = this.edges[label] + + str = str + label + node.id + } + + return str +} + +/** + * Returns a new TokenSet that is the intersection of + * this TokenSet and the passed TokenSet. + * + * This intersection will take into account any wildcards + * contained within the TokenSet. + * + * @param {lunr.TokenSet} b - An other TokenSet to intersect with. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.prototype.intersect = function (b) { + var output = new lunr.TokenSet, + frame = undefined + + var stack = [{ + qNode: b, + output: output, + node: this + }] + + while (stack.length) { + frame = stack.pop() + + // NOTE: As with the #toString method, we are using + // Object.keys and a for loop instead of a for-in loop + // as both of these objects enter 'hash' mode, causing + // the function to be de-optimised in V8 + var qEdges = Object.keys(frame.qNode.edges), + qLen = qEdges.length, + nEdges = Object.keys(frame.node.edges), + nLen = nEdges.length + + for (var q = 0; q < qLen; q++) { + var qEdge = qEdges[q] + + for (var n = 0; n < nLen; n++) { + var nEdge = nEdges[n] + + if (nEdge == qEdge || qEdge == '*') { + var node = frame.node.edges[nEdge], + qNode = frame.qNode.edges[qEdge], + final = node.final && qNode.final, + next = undefined + + if (nEdge in frame.output.edges) { + // an edge already exists for this character + // no need to create a new node, just set the finality + // bit unless this node is already final + next = frame.output.edges[nEdge] + next.final = next.final || final + + } else { + // no edge exists yet, must create one + // set the finality bit and insert it + // into the output + next = new lunr.TokenSet + next.final = final + frame.output.edges[nEdge] = next + } + + stack.push({ + qNode: qNode, + output: next, + node: node + }) + } + } + } + } + + return output +} +lunr.TokenSet.Builder = function () { + this.previousWord = "" + this.root = new lunr.TokenSet + this.uncheckedNodes = [] + this.minimizedNodes = {} +} + +lunr.TokenSet.Builder.prototype.insert = function (word) { + var node, + commonPrefix = 0 + + if (word < this.previousWord) { + throw new Error ("Out of order word insertion") + } + + for (var i = 0; i < word.length && i < this.previousWord.length; i++) { + if (word[i] != this.previousWord[i]) break + commonPrefix++ + } + + this.minimize(commonPrefix) + + if (this.uncheckedNodes.length == 0) { + node = this.root + } else { + node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child + } + + for (var i = commonPrefix; i < word.length; i++) { + var nextNode = new lunr.TokenSet, + char = word[i] + + node.edges[char] = nextNode + + this.uncheckedNodes.push({ + parent: node, + char: char, + child: nextNode + }) + + node = nextNode + } + + node.final = true + this.previousWord = word +} + +lunr.TokenSet.Builder.prototype.finish = function () { + this.minimize(0) +} + +lunr.TokenSet.Builder.prototype.minimize = function (downTo) { + for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) { + var node = this.uncheckedNodes[i], + childKey = node.child.toString() + + if (childKey in this.minimizedNodes) { + node.parent.edges[node.char] = this.minimizedNodes[childKey] + } else { + // Cache the key for this node since + // we know it can't change anymore + node.child._str = childKey + + this.minimizedNodes[childKey] = node.child + } + + this.uncheckedNodes.pop() + } +} +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * An index contains the built index of all documents and provides a query interface + * to the index. + * + * Usually instances of lunr.Index will not be created using this constructor, instead + * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be + * used to load previously built and serialized indexes. + * + * @constructor + * @param {Object} attrs - The attributes of the built search index. + * @param {Object} attrs.invertedIndex - An index of term/field to document reference. + * @param {Object} attrs.fieldVectors - Field vectors + * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens. + * @param {string[]} attrs.fields - The names of indexed document fields. + * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms. + */ +lunr.Index = function (attrs) { + this.invertedIndex = attrs.invertedIndex + this.fieldVectors = attrs.fieldVectors + this.tokenSet = attrs.tokenSet + this.fields = attrs.fields + this.pipeline = attrs.pipeline +} + +/** + * A result contains details of a document matching a search query. + * @typedef {Object} lunr.Index~Result + * @property {string} ref - The reference of the document this result represents. + * @property {number} score - A number between 0 and 1 representing how similar this document is to the query. + * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match. + */ + +/** + * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple + * query language which itself is parsed into an instance of lunr.Query. + * + * For programmatically building queries it is advised to directly use lunr.Query, the query language + * is best used for human entered text rather than program generated text. + * + * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported + * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello' + * or 'world', though those that contain both will rank higher in the results. + * + * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can + * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding + * wildcards will increase the number of documents that will be found but can also have a negative + * impact on query performance, especially with wildcards at the beginning of a term. + * + * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term + * hello in the title field will match this query. Using a field not present in the index will lead + * to an error being thrown. + * + * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term + * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported + * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2. + * Avoid large values for edit distance to improve query performance. + * + * Each term also supports a presence modifier. By default a term's presence in document is optional, however + * this can be changed to either required or prohibited. For a term's presence to be required in a document the + * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and + * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not + * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'. + * + * To escape special characters the backslash character '\' can be used, this allows searches to include + * characters that would normally be considered modifiers, e.g. `foo\~2` will search for a term "foo~2" instead + * of attempting to apply a boost of 2 to the search term "foo". + * + * @typedef {string} lunr.Index~QueryString + * @example Simple single term query + * hello + * @example Multiple term query + * hello world + * @example term scoped to a field + * title:hello + * @example term with a boost of 10 + * hello^10 + * @example term with an edit distance of 2 + * hello~2 + * @example terms with presence modifiers + * -foo +bar baz + */ + +/** + * Performs a search against the index using lunr query syntax. + * + * Results will be returned sorted by their score, the most relevant results + * will be returned first. For details on how the score is calculated, please see + * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}. + * + * For more programmatic querying use lunr.Index#query. + * + * @param {lunr.Index~QueryString} queryString - A string containing a lunr query. + * @throws {lunr.QueryParseError} If the passed query string cannot be parsed. + * @returns {lunr.Index~Result[]} + */ +lunr.Index.prototype.search = function (queryString) { + return this.query(function (query) { + var parser = new lunr.QueryParser(queryString, query) + parser.parse() + }) +} + +/** + * A query builder callback provides a query object to be used to express + * the query to perform on the index. + * + * @callback lunr.Index~queryBuilder + * @param {lunr.Query} query - The query object to build up. + * @this lunr.Query + */ + +/** + * Performs a query against the index using the yielded lunr.Query object. + * + * If performing programmatic queries against the index, this method is preferred + * over lunr.Index#search so as to avoid the additional query parsing overhead. + * + * A query object is yielded to the supplied function which should be used to + * express the query to be run against the index. + * + * Note that although this function takes a callback parameter it is _not_ an + * asynchronous operation, the callback is just yielded a query object to be + * customized. + * + * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query. + * @returns {lunr.Index~Result[]} + */ +lunr.Index.prototype.query = function (fn) { + // for each query clause + // * process terms + // * expand terms from token set + // * find matching documents and metadata + // * get document vectors + // * score documents + + var query = new lunr.Query(this.fields), + matchingFields = Object.create(null), + queryVectors = Object.create(null), + termFieldCache = Object.create(null), + requiredMatches = Object.create(null), + prohibitedMatches = Object.create(null) + + /* + * To support field level boosts a query vector is created per + * field. An empty vector is eagerly created to support negated + * queries. + */ + for (var i = 0; i < this.fields.length; i++) { + queryVectors[this.fields[i]] = new lunr.Vector + } + + fn.call(query, query) + + for (var i = 0; i < query.clauses.length; i++) { + /* + * Unless the pipeline has been disabled for this term, which is + * the case for terms with wildcards, we need to pass the clause + * term through the search pipeline. A pipeline returns an array + * of processed terms. Pipeline functions may expand the passed + * term, which means we may end up performing multiple index lookups + * for a single query term. + */ + var clause = query.clauses[i], + terms = null, + clauseMatches = lunr.Set.empty + + if (clause.usePipeline) { + terms = this.pipeline.runString(clause.term, { + fields: clause.fields + }) + } else { + terms = [clause.term] + } + + for (var m = 0; m < terms.length; m++) { + var term = terms[m] + + /* + * Each term returned from the pipeline needs to use the same query + * clause object, e.g. the same boost and or edit distance. The + * simplest way to do this is to re-use the clause object but mutate + * its term property. + */ + clause.term = term + + /* + * From the term in the clause we create a token set which will then + * be used to intersect the indexes token set to get a list of terms + * to lookup in the inverted index + */ + var termTokenSet = lunr.TokenSet.fromClause(clause), + expandedTerms = this.tokenSet.intersect(termTokenSet).toArray() + + /* + * If a term marked as required does not exist in the tokenSet it is + * impossible for the search to return any matches. We set all the field + * scoped required matches set to empty and stop examining any further + * clauses. + */ + if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = lunr.Set.empty + } + + break + } + + for (var j = 0; j < expandedTerms.length; j++) { + /* + * For each term get the posting and termIndex, this is required for + * building the query vector. + */ + var expandedTerm = expandedTerms[j], + posting = this.invertedIndex[expandedTerm], + termIndex = posting._index + + for (var k = 0; k < clause.fields.length; k++) { + /* + * For each field that this query term is scoped by (by default + * all fields are in scope) we need to get all the document refs + * that have this term in that field. + * + * The posting is the entry in the invertedIndex for the matching + * term from above. + */ + var field = clause.fields[k], + fieldPosting = posting[field], + matchingDocumentRefs = Object.keys(fieldPosting), + termField = expandedTerm + "/" + field, + matchingDocumentsSet = new lunr.Set(matchingDocumentRefs) + + /* + * if the presence of this term is required ensure that the matching + * documents are added to the set of required matches for this clause. + * + */ + if (clause.presence == lunr.Query.presence.REQUIRED) { + clauseMatches = clauseMatches.union(matchingDocumentsSet) + + if (requiredMatches[field] === undefined) { + requiredMatches[field] = lunr.Set.complete + } + } + + /* + * if the presence of this term is prohibited ensure that the matching + * documents are added to the set of prohibited matches for this field, + * creating that set if it does not yet exist. + */ + if (clause.presence == lunr.Query.presence.PROHIBITED) { + if (prohibitedMatches[field] === undefined) { + prohibitedMatches[field] = lunr.Set.empty + } + + prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet) + + /* + * Prohibited matches should not be part of the query vector used for + * similarity scoring and no metadata should be extracted so we continue + * to the next field + */ + continue + } + + /* + * The query field vector is populated using the termIndex found for + * the term and a unit value with the appropriate boost applied. + * Using upsert because there could already be an entry in the vector + * for the term we are working with. In that case we just add the scores + * together. + */ + queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b }) + + /** + * If we've already seen this term, field combo then we've already collected + * the matching documents and metadata, no need to go through all that again + */ + if (termFieldCache[termField]) { + continue + } + + for (var l = 0; l < matchingDocumentRefs.length; l++) { + /* + * All metadata for this term/field/document triple + * are then extracted and collected into an instance + * of lunr.MatchData ready to be returned in the query + * results + */ + var matchingDocumentRef = matchingDocumentRefs[l], + matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field), + metadata = fieldPosting[matchingDocumentRef], + fieldMatch + + if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) { + matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata) + } else { + fieldMatch.add(expandedTerm, field, metadata) + } + + } + + termFieldCache[termField] = true + } + } + } + + /** + * If the presence was required we need to update the requiredMatches field sets. + * We do this after all fields for the term have collected their matches because + * the clause terms presence is required in _any_ of the fields not _all_ of the + * fields. + */ + if (clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = requiredMatches[field].intersect(clauseMatches) + } + } + } + + /** + * Need to combine the field scoped required and prohibited + * matching documents into a global set of required and prohibited + * matches + */ + var allRequiredMatches = lunr.Set.complete, + allProhibitedMatches = lunr.Set.empty + + for (var i = 0; i < this.fields.length; i++) { + var field = this.fields[i] + + if (requiredMatches[field]) { + allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field]) + } + + if (prohibitedMatches[field]) { + allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field]) + } + } + + var matchingFieldRefs = Object.keys(matchingFields), + results = [], + matches = Object.create(null) + + /* + * If the query is negated (contains only prohibited terms) + * we need to get _all_ fieldRefs currently existing in the + * index. This is only done when we know that the query is + * entirely prohibited terms to avoid any cost of getting all + * fieldRefs unnecessarily. + * + * Additionally, blank MatchData must be created to correctly + * populate the results. + */ + if (query.isNegated()) { + matchingFieldRefs = Object.keys(this.fieldVectors) + + for (var i = 0; i < matchingFieldRefs.length; i++) { + var matchingFieldRef = matchingFieldRefs[i] + var fieldRef = lunr.FieldRef.fromString(matchingFieldRef) + matchingFields[matchingFieldRef] = new lunr.MatchData + } + } + + for (var i = 0; i < matchingFieldRefs.length; i++) { + /* + * Currently we have document fields that match the query, but we + * need to return documents. The matchData and scores are combined + * from multiple fields belonging to the same document. + * + * Scores are calculated by field, using the query vectors created + * above, and combined into a final document score using addition. + */ + var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]), + docRef = fieldRef.docRef + + if (!allRequiredMatches.contains(docRef)) { + continue + } + + if (allProhibitedMatches.contains(docRef)) { + continue + } + + var fieldVector = this.fieldVectors[fieldRef], + score = queryVectors[fieldRef.fieldName].similarity(fieldVector), + docMatch + + if ((docMatch = matches[docRef]) !== undefined) { + docMatch.score += score + docMatch.matchData.combine(matchingFields[fieldRef]) + } else { + var match = { + ref: docRef, + score: score, + matchData: matchingFields[fieldRef] + } + matches[docRef] = match + results.push(match) + } + } + + /* + * Sort the results objects by score, highest first. + */ + return results.sort(function (a, b) { + return b.score - a.score + }) +} + +/** + * Prepares the index for JSON serialization. + * + * The schema for this JSON blob will be described in a + * separate JSON schema file. + * + * @returns {Object} + */ +lunr.Index.prototype.toJSON = function () { + var invertedIndex = Object.keys(this.invertedIndex) + .sort() + .map(function (term) { + return [term, this.invertedIndex[term]] + }, this) + + var fieldVectors = Object.keys(this.fieldVectors) + .map(function (ref) { + return [ref, this.fieldVectors[ref].toJSON()] + }, this) + + return { + version: lunr.version, + fields: this.fields, + fieldVectors: fieldVectors, + invertedIndex: invertedIndex, + pipeline: this.pipeline.toJSON() + } +} + +/** + * Loads a previously serialized lunr.Index + * + * @param {Object} serializedIndex - A previously serialized lunr.Index + * @returns {lunr.Index} + */ +lunr.Index.load = function (serializedIndex) { + var attrs = {}, + fieldVectors = {}, + serializedVectors = serializedIndex.fieldVectors, + invertedIndex = Object.create(null), + serializedInvertedIndex = serializedIndex.invertedIndex, + tokenSetBuilder = new lunr.TokenSet.Builder, + pipeline = lunr.Pipeline.load(serializedIndex.pipeline) + + if (serializedIndex.version != lunr.version) { + lunr.utils.warn("Version mismatch when loading serialised index. Current version of lunr '" + lunr.version + "' does not match serialized index '" + serializedIndex.version + "'") + } + + for (var i = 0; i < serializedVectors.length; i++) { + var tuple = serializedVectors[i], + ref = tuple[0], + elements = tuple[1] + + fieldVectors[ref] = new lunr.Vector(elements) + } + + for (var i = 0; i < serializedInvertedIndex.length; i++) { + var tuple = serializedInvertedIndex[i], + term = tuple[0], + posting = tuple[1] + + tokenSetBuilder.insert(term) + invertedIndex[term] = posting + } + + tokenSetBuilder.finish() + + attrs.fields = serializedIndex.fields + + attrs.fieldVectors = fieldVectors + attrs.invertedIndex = invertedIndex + attrs.tokenSet = tokenSetBuilder.root + attrs.pipeline = pipeline + + return new lunr.Index(attrs) +} +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.Builder performs indexing on a set of documents and + * returns instances of lunr.Index ready for querying. + * + * All configuration of the index is done via the builder, the + * fields to index, the document reference, the text processing + * pipeline and document scoring parameters are all set on the + * builder before indexing. + * + * @constructor + * @property {string} _ref - Internal reference to the document reference field. + * @property {string[]} _fields - Internal reference to the document fields to index. + * @property {object} invertedIndex - The inverted index maps terms to document fields. + * @property {object} documentTermFrequencies - Keeps track of document term frequencies. + * @property {object} documentLengths - Keeps track of the length of documents added to the index. + * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing. + * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing. + * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index. + * @property {number} documentCount - Keeps track of the total number of documents indexed. + * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75. + * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2. + * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space. + * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index. + */ +lunr.Builder = function () { + this._ref = "id" + this._fields = Object.create(null) + this._documents = Object.create(null) + this.invertedIndex = Object.create(null) + this.fieldTermFrequencies = {} + this.fieldLengths = {} + this.tokenizer = lunr.tokenizer + this.pipeline = new lunr.Pipeline + this.searchPipeline = new lunr.Pipeline + this.documentCount = 0 + this._b = 0.75 + this._k1 = 1.2 + this.termIndex = 0 + this.metadataWhitelist = [] +} + +/** + * Sets the document field used as the document reference. Every document must have this field. + * The type of this field in the document should be a string, if it is not a string it will be + * coerced into a string by calling toString. + * + * The default ref is 'id'. + * + * The ref should _not_ be changed during indexing, it should be set before any documents are + * added to the index. Changing it during indexing can lead to inconsistent results. + * + * @param {string} ref - The name of the reference field in the document. + */ +lunr.Builder.prototype.ref = function (ref) { + this._ref = ref +} + +/** + * A function that is used to extract a field from a document. + * + * Lunr expects a field to be at the top level of a document, if however the field + * is deeply nested within a document an extractor function can be used to extract + * the right field for indexing. + * + * @callback fieldExtractor + * @param {object} doc - The document being added to the index. + * @returns {?(string|object|object[])} obj - The object that will be indexed for this field. + * @example Extracting a nested field + * function (doc) { return doc.nested.field } + */ + +/** + * Adds a field to the list of document fields that will be indexed. Every document being + * indexed should have this field. Null values for this field in indexed documents will + * not cause errors but will limit the chance of that document being retrieved by searches. + * + * All fields should be added before adding documents to the index. Adding fields after + * a document has been indexed will have no effect on already indexed documents. + * + * Fields can be boosted at build time. This allows terms within that field to have more + * importance when ranking search results. Use a field boost to specify that matches within + * one field are more important than other fields. + * + * @param {string} fieldName - The name of a field to index in all documents. + * @param {object} attributes - Optional attributes associated with this field. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this field. + * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document. + * @throws {RangeError} fieldName cannot contain unsupported characters '/' + */ +lunr.Builder.prototype.field = function (fieldName, attributes) { + if (/\//.test(fieldName)) { + throw new RangeError ("Field '" + fieldName + "' contains illegal character '/'") + } + + this._fields[fieldName] = attributes || {} +} + +/** + * A parameter to tune the amount of field length normalisation that is applied when + * calculating relevance scores. A value of 0 will completely disable any normalisation + * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b + * will be clamped to the range 0 - 1. + * + * @param {number} number - The value to set for this tuning parameter. + */ +lunr.Builder.prototype.b = function (number) { + if (number < 0) { + this._b = 0 + } else if (number > 1) { + this._b = 1 + } else { + this._b = number + } +} + +/** + * A parameter that controls the speed at which a rise in term frequency results in term + * frequency saturation. The default value is 1.2. Setting this to a higher value will give + * slower saturation levels, a lower value will result in quicker saturation. + * + * @param {number} number - The value to set for this tuning parameter. + */ +lunr.Builder.prototype.k1 = function (number) { + this._k1 = number +} + +/** + * Adds a document to the index. + * + * Before adding fields to the index the index should have been fully setup, with the document + * ref and all fields to index already having been specified. + * + * The document must have a field name as specified by the ref (by default this is 'id') and + * it should have all fields defined for indexing, though null or undefined values will not + * cause errors. + * + * Entire documents can be boosted at build time. Applying a boost to a document indicates that + * this document should rank higher in search results than other documents. + * + * @param {object} doc - The document to add to the index. + * @param {object} attributes - Optional attributes associated with this document. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this document. + */ +lunr.Builder.prototype.add = function (doc, attributes) { + var docRef = doc[this._ref], + fields = Object.keys(this._fields) + + this._documents[docRef] = attributes || {} + this.documentCount += 1 + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i], + extractor = this._fields[fieldName].extractor, + field = extractor ? extractor(doc) : doc[fieldName], + tokens = this.tokenizer(field, { + fields: [fieldName] + }), + terms = this.pipeline.run(tokens), + fieldRef = new lunr.FieldRef (docRef, fieldName), + fieldTerms = Object.create(null) + + this.fieldTermFrequencies[fieldRef] = fieldTerms + this.fieldLengths[fieldRef] = 0 + + // store the length of this field for this document + this.fieldLengths[fieldRef] += terms.length + + // calculate term frequencies for this field + for (var j = 0; j < terms.length; j++) { + var term = terms[j] + + if (fieldTerms[term] == undefined) { + fieldTerms[term] = 0 + } + + fieldTerms[term] += 1 + + // add to inverted index + // create an initial posting if one doesn't exist + if (this.invertedIndex[term] == undefined) { + var posting = Object.create(null) + posting["_index"] = this.termIndex + this.termIndex += 1 + + for (var k = 0; k < fields.length; k++) { + posting[fields[k]] = Object.create(null) + } + + this.invertedIndex[term] = posting + } + + // add an entry for this term/fieldName/docRef to the invertedIndex + if (this.invertedIndex[term][fieldName][docRef] == undefined) { + this.invertedIndex[term][fieldName][docRef] = Object.create(null) + } + + // store all whitelisted metadata about this token in the + // inverted index + for (var l = 0; l < this.metadataWhitelist.length; l++) { + var metadataKey = this.metadataWhitelist[l], + metadata = term.metadata[metadataKey] + + if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) { + this.invertedIndex[term][fieldName][docRef][metadataKey] = [] + } + + this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata) + } + } + + } +} + +/** + * Calculates the average document length for this index + * + * @private + */ +lunr.Builder.prototype.calculateAverageFieldLengths = function () { + + var fieldRefs = Object.keys(this.fieldLengths), + numberOfFields = fieldRefs.length, + accumulator = {}, + documentsWithField = {} + + for (var i = 0; i < numberOfFields; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + field = fieldRef.fieldName + + documentsWithField[field] || (documentsWithField[field] = 0) + documentsWithField[field] += 1 + + accumulator[field] || (accumulator[field] = 0) + accumulator[field] += this.fieldLengths[fieldRef] + } + + var fields = Object.keys(this._fields) + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i] + accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName] + } + + this.averageFieldLength = accumulator +} + +/** + * Builds a vector space model of every document using lunr.Vector + * + * @private + */ +lunr.Builder.prototype.createFieldVectors = function () { + var fieldVectors = {}, + fieldRefs = Object.keys(this.fieldTermFrequencies), + fieldRefsLength = fieldRefs.length, + termIdfCache = Object.create(null) + + for (var i = 0; i < fieldRefsLength; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + fieldName = fieldRef.fieldName, + fieldLength = this.fieldLengths[fieldRef], + fieldVector = new lunr.Vector, + termFrequencies = this.fieldTermFrequencies[fieldRef], + terms = Object.keys(termFrequencies), + termsLength = terms.length + + + var fieldBoost = this._fields[fieldName].boost || 1, + docBoost = this._documents[fieldRef.docRef].boost || 1 + + for (var j = 0; j < termsLength; j++) { + var term = terms[j], + tf = termFrequencies[term], + termIndex = this.invertedIndex[term]._index, + idf, score, scoreWithPrecision + + if (termIdfCache[term] === undefined) { + idf = lunr.idf(this.invertedIndex[term], this.documentCount) + termIdfCache[term] = idf + } else { + idf = termIdfCache[term] + } + + score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf) + score *= fieldBoost + score *= docBoost + scoreWithPrecision = Math.round(score * 1000) / 1000 + // Converts 1.23456789 to 1.234. + // Reducing the precision so that the vectors take up less + // space when serialised. Doing it now so that they behave + // the same before and after serialisation. Also, this is + // the fastest approach to reducing a number's precision in + // JavaScript. + + fieldVector.insert(termIndex, scoreWithPrecision) + } + + fieldVectors[fieldRef] = fieldVector + } + + this.fieldVectors = fieldVectors +} + +/** + * Creates a token set of all tokens in the index using lunr.TokenSet + * + * @private + */ +lunr.Builder.prototype.createTokenSet = function () { + this.tokenSet = lunr.TokenSet.fromArray( + Object.keys(this.invertedIndex).sort() + ) +} + +/** + * Builds the index, creating an instance of lunr.Index. + * + * This completes the indexing process and should only be called + * once all documents have been added to the index. + * + * @returns {lunr.Index} + */ +lunr.Builder.prototype.build = function () { + this.calculateAverageFieldLengths() + this.createFieldVectors() + this.createTokenSet() + + return new lunr.Index({ + invertedIndex: this.invertedIndex, + fieldVectors: this.fieldVectors, + tokenSet: this.tokenSet, + fields: Object.keys(this._fields), + pipeline: this.searchPipeline + }) +} + +/** + * Applies a plugin to the index builder. + * + * A plugin is a function that is called with the index builder as its context. + * Plugins can be used to customise or extend the behaviour of the index + * in some way. A plugin is just a function, that encapsulated the custom + * behaviour that should be applied when building the index. + * + * The plugin function will be called with the index builder as its argument, additional + * arguments can also be passed when calling use. The function will be called + * with the index builder as its context. + * + * @param {Function} plugin The plugin to apply. + */ +lunr.Builder.prototype.use = function (fn) { + var args = Array.prototype.slice.call(arguments, 1) + args.unshift(this) + fn.apply(this, args) +} +/** + * Contains and collects metadata about a matching document. + * A single instance of lunr.MatchData is returned as part of every + * lunr.Index~Result. + * + * @constructor + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + * @property {object} metadata - A cloned collection of metadata associated with this document. + * @see {@link lunr.Index~Result} + */ +lunr.MatchData = function (term, field, metadata) { + var clonedMetadata = Object.create(null), + metadataKeys = Object.keys(metadata || {}) + + // Cloning the metadata to prevent the original + // being mutated during match data combination. + // Metadata is kept in an array within the inverted + // index so cloning the data can be done with + // Array#slice + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + clonedMetadata[key] = metadata[key].slice() + } + + this.metadata = Object.create(null) + + if (term !== undefined) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = clonedMetadata + } +} + +/** + * An instance of lunr.MatchData will be created for every term that matches a + * document. However only one instance is required in a lunr.Index~Result. This + * method combines metadata from another instance of lunr.MatchData with this + * objects metadata. + * + * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one. + * @see {@link lunr.Index~Result} + */ +lunr.MatchData.prototype.combine = function (otherMatchData) { + var terms = Object.keys(otherMatchData.metadata) + + for (var i = 0; i < terms.length; i++) { + var term = terms[i], + fields = Object.keys(otherMatchData.metadata[term]) + + if (this.metadata[term] == undefined) { + this.metadata[term] = Object.create(null) + } + + for (var j = 0; j < fields.length; j++) { + var field = fields[j], + keys = Object.keys(otherMatchData.metadata[term][field]) + + if (this.metadata[term][field] == undefined) { + this.metadata[term][field] = Object.create(null) + } + + for (var k = 0; k < keys.length; k++) { + var key = keys[k] + + if (this.metadata[term][field][key] == undefined) { + this.metadata[term][field][key] = otherMatchData.metadata[term][field][key] + } else { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key]) + } + + } + } + } +} + +/** + * Add metadata for a term/field pair to this instance of match data. + * + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + */ +lunr.MatchData.prototype.add = function (term, field, metadata) { + if (!(term in this.metadata)) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = metadata + return + } + + if (!(field in this.metadata[term])) { + this.metadata[term][field] = metadata + return + } + + var metadataKeys = Object.keys(metadata) + + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + + if (key in this.metadata[term][field]) { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key]) + } else { + this.metadata[term][field][key] = metadata[key] + } + } +} +/** + * A lunr.Query provides a programmatic way of defining queries to be performed + * against a {@link lunr.Index}. + * + * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method + * so the query object is pre-initialized with the right index fields. + * + * @constructor + * @property {lunr.Query~Clause[]} clauses - An array of query clauses. + * @property {string[]} allFields - An array of all available fields in a lunr.Index. + */ +lunr.Query = function (allFields) { + this.clauses = [] + this.allFields = allFields +} + +/** + * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause. + * + * This allows wildcards to be added to the beginning and end of a term without having to manually do any string + * concatenation. + * + * The wildcard constants can be bitwise combined to select both leading and trailing wildcards. + * + * @constant + * @default + * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour + * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists + * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with trailing wildcard + * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING }) + * @example query term with leading and trailing wildcard + * query.term('foo', { + * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING + * }) + */ + +lunr.Query.wildcard = new String ("*") +lunr.Query.wildcard.NONE = 0 +lunr.Query.wildcard.LEADING = 1 +lunr.Query.wildcard.TRAILING = 2 + +/** + * Constants for indicating what kind of presence a term must have in matching documents. + * + * @constant + * @enum {number} + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with required presence + * query.term('foo', { presence: lunr.Query.presence.REQUIRED }) + */ +lunr.Query.presence = { + /** + * Term's presence in a document is optional, this is the default value. + */ + OPTIONAL: 1, + + /** + * Term's presence in a document is required, documents that do not contain + * this term will not be returned. + */ + REQUIRED: 2, + + /** + * Term's presence in a document is prohibited, documents that do contain + * this term will not be returned. + */ + PROHIBITED: 3 +} + +/** + * A single clause in a {@link lunr.Query} contains a term and details on how to + * match that term against a {@link lunr.Index}. + * + * @typedef {Object} lunr.Query~Clause + * @property {string[]} fields - The fields in an index this clause should be matched against. + * @property {number} [boost=1] - Any boost that should be applied when matching this clause. + * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be. + * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline. + * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended. + * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents. + */ + +/** + * Adds a {@link lunr.Query~Clause} to this query. + * + * Unless the clause contains the fields to be matched all fields will be matched. In addition + * a default boost of 1 is applied to the clause. + * + * @param {lunr.Query~Clause} clause - The clause to add to this query. + * @see lunr.Query~Clause + * @returns {lunr.Query} + */ +lunr.Query.prototype.clause = function (clause) { + if (!('fields' in clause)) { + clause.fields = this.allFields + } + + if (!('boost' in clause)) { + clause.boost = 1 + } + + if (!('usePipeline' in clause)) { + clause.usePipeline = true + } + + if (!('wildcard' in clause)) { + clause.wildcard = lunr.Query.wildcard.NONE + } + + if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) { + clause.term = "*" + clause.term + } + + if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) { + clause.term = "" + clause.term + "*" + } + + if (!('presence' in clause)) { + clause.presence = lunr.Query.presence.OPTIONAL + } + + this.clauses.push(clause) + + return this +} + +/** + * A negated query is one in which every clause has a presence of + * prohibited. These queries require some special processing to return + * the expected results. + * + * @returns boolean + */ +lunr.Query.prototype.isNegated = function () { + for (var i = 0; i < this.clauses.length; i++) { + if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) { + return false + } + } + + return true +} + +/** + * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause} + * to the list of clauses that make up this query. + * + * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion + * to a token or token-like string should be done before calling this method. + * + * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an + * array, each term in the array will share the same options. + * + * @param {object|object[]} term - The term(s) to add to the query. + * @param {object} [options] - Any additional properties to add to the query clause. + * @returns {lunr.Query} + * @see lunr.Query#clause + * @see lunr.Query~Clause + * @example adding a single term to a query + * query.term("foo") + * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard + * query.term("foo", { + * fields: ["title"], + * boost: 10, + * wildcard: lunr.Query.wildcard.TRAILING + * }) + * @example using lunr.tokenizer to convert a string to tokens before using them as terms + * query.term(lunr.tokenizer("foo bar")) + */ +lunr.Query.prototype.term = function (term, options) { + if (Array.isArray(term)) { + term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this) + return this + } + + var clause = options || {} + clause.term = term.toString() + + this.clause(clause) + + return this +} +lunr.QueryParseError = function (message, start, end) { + this.name = "QueryParseError" + this.message = message + this.start = start + this.end = end +} + +lunr.QueryParseError.prototype = new Error +lunr.QueryLexer = function (str) { + this.lexemes = [] + this.str = str + this.length = str.length + this.pos = 0 + this.start = 0 + this.escapeCharPositions = [] +} + +lunr.QueryLexer.prototype.run = function () { + var state = lunr.QueryLexer.lexText + + while (state) { + state = state(this) + } +} + +lunr.QueryLexer.prototype.sliceString = function () { + var subSlices = [], + sliceStart = this.start, + sliceEnd = this.pos + + for (var i = 0; i < this.escapeCharPositions.length; i++) { + sliceEnd = this.escapeCharPositions[i] + subSlices.push(this.str.slice(sliceStart, sliceEnd)) + sliceStart = sliceEnd + 1 + } + + subSlices.push(this.str.slice(sliceStart, this.pos)) + this.escapeCharPositions.length = 0 + + return subSlices.join('') +} + +lunr.QueryLexer.prototype.emit = function (type) { + this.lexemes.push({ + type: type, + str: this.sliceString(), + start: this.start, + end: this.pos + }) + + this.start = this.pos +} + +lunr.QueryLexer.prototype.escapeCharacter = function () { + this.escapeCharPositions.push(this.pos - 1) + this.pos += 1 +} + +lunr.QueryLexer.prototype.next = function () { + if (this.pos >= this.length) { + return lunr.QueryLexer.EOS + } + + var char = this.str.charAt(this.pos) + this.pos += 1 + return char +} + +lunr.QueryLexer.prototype.width = function () { + return this.pos - this.start +} + +lunr.QueryLexer.prototype.ignore = function () { + if (this.start == this.pos) { + this.pos += 1 + } + + this.start = this.pos +} + +lunr.QueryLexer.prototype.backup = function () { + this.pos -= 1 +} + +lunr.QueryLexer.prototype.acceptDigitRun = function () { + var char, charCode + + do { + char = this.next() + charCode = char.charCodeAt(0) + } while (charCode > 47 && charCode < 58) + + if (char != lunr.QueryLexer.EOS) { + this.backup() + } +} + +lunr.QueryLexer.prototype.more = function () { + return this.pos < this.length +} + +lunr.QueryLexer.EOS = 'EOS' +lunr.QueryLexer.FIELD = 'FIELD' +lunr.QueryLexer.TERM = 'TERM' +lunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE' +lunr.QueryLexer.BOOST = 'BOOST' +lunr.QueryLexer.PRESENCE = 'PRESENCE' + +lunr.QueryLexer.lexField = function (lexer) { + lexer.backup() + lexer.emit(lunr.QueryLexer.FIELD) + lexer.ignore() + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexTerm = function (lexer) { + if (lexer.width() > 1) { + lexer.backup() + lexer.emit(lunr.QueryLexer.TERM) + } + + lexer.ignore() + + if (lexer.more()) { + return lunr.QueryLexer.lexText + } +} + +lunr.QueryLexer.lexEditDistance = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.EDIT_DISTANCE) + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexBoost = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.BOOST) + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexEOS = function (lexer) { + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } +} + +// This matches the separator used when tokenising fields +// within a document. These should match otherwise it is +// not possible to search for some tokens within a document. +// +// It is possible for the user to change the separator on the +// tokenizer so it _might_ clash with any other of the special +// characters already used within the search string, e.g. :. +// +// This means that it is possible to change the separator in +// such a way that makes some words unsearchable using a search +// string. +lunr.QueryLexer.termSeparator = lunr.tokenizer.separator + +lunr.QueryLexer.lexText = function (lexer) { + while (true) { + var char = lexer.next() + + if (char == lunr.QueryLexer.EOS) { + return lunr.QueryLexer.lexEOS + } + + // Escape character is '\' + if (char.charCodeAt(0) == 92) { + lexer.escapeCharacter() + continue + } + + if (char == ":") { + return lunr.QueryLexer.lexField + } + + if (char == "~") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexEditDistance + } + + if (char == "^") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexBoost + } + + // "+" indicates term presence is required + // checking for length to ensure that only + // leading "+" are considered + if (char == "+" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + // "-" indicates term presence is prohibited + // checking for length to ensure that only + // leading "-" are considered + if (char == "-" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + if (char.match(lunr.QueryLexer.termSeparator)) { + return lunr.QueryLexer.lexTerm + } + } +} + +lunr.QueryParser = function (str, query) { + this.lexer = new lunr.QueryLexer (str) + this.query = query + this.currentClause = {} + this.lexemeIdx = 0 +} + +lunr.QueryParser.prototype.parse = function () { + this.lexer.run() + this.lexemes = this.lexer.lexemes + + var state = lunr.QueryParser.parseClause + + while (state) { + state = state(this) + } + + return this.query +} + +lunr.QueryParser.prototype.peekLexeme = function () { + return this.lexemes[this.lexemeIdx] +} + +lunr.QueryParser.prototype.consumeLexeme = function () { + var lexeme = this.peekLexeme() + this.lexemeIdx += 1 + return lexeme +} + +lunr.QueryParser.prototype.nextClause = function () { + var completedClause = this.currentClause + this.query.clause(completedClause) + this.currentClause = {} +} + +lunr.QueryParser.parseClause = function (parser) { + var lexeme = parser.peekLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.type) { + case lunr.QueryLexer.PRESENCE: + return lunr.QueryParser.parsePresence + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expected either a field or a term, found " + lexeme.type + + if (lexeme.str.length >= 1) { + errorMessage += " with value '" + lexeme.str + "'" + } + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } +} + +lunr.QueryParser.parsePresence = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.str) { + case "-": + parser.currentClause.presence = lunr.Query.presence.PROHIBITED + break + case "+": + parser.currentClause.presence = lunr.Query.presence.REQUIRED + break + default: + var errorMessage = "unrecognised presence operator'" + lexeme.str + "'" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term or field, found nothing" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term or field, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseField = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + if (parser.query.allFields.indexOf(lexeme.str) == -1) { + var possibleFields = parser.query.allFields.map(function (f) { return "'" + f + "'" }).join(', '), + errorMessage = "unrecognised field '" + lexeme.str + "', possible fields: " + possibleFields + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.fields = [lexeme.str] + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term, found nothing" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseTerm = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + parser.currentClause.term = lexeme.str.toLowerCase() + + if (lexeme.str.indexOf("*") != -1) { + parser.currentClause.usePipeline = false + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseEditDistance = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var editDistance = parseInt(lexeme.str, 10) + + if (isNaN(editDistance)) { + var errorMessage = "edit distance must be numeric" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.editDistance = editDistance + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseBoost = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var boost = parseInt(lexeme.str, 10) + + if (isNaN(boost)) { + var errorMessage = "boost must be numeric" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.boost = boost + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + + /** + * export the module via AMD, CommonJS or as a browser global + * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js + */ + ;(function (root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(factory) + } else if (typeof exports === 'object') { + /** + * Node. Does not work with strict CommonJS, but + * only CommonJS-like environments that support module.exports, + * like Node. + */ + module.exports = factory() + } else { + // Browser globals (root is window) + root.lunr = factory() + } + }(this, function () { + /** + * Just return a value to define the module export. + * This example returns an object, but the module + * can return a function as the exported value. + */ + return lunr + })) +})(); diff --git a/search/main.js b/search/main.js new file mode 100644 index 00000000..a5e469d7 --- /dev/null +++ b/search/main.js @@ -0,0 +1,109 @@ +function getSearchTermFromLocation() { + var sPageURL = window.location.search.substring(1); + var sURLVariables = sPageURL.split('&'); + for (var i = 0; i < sURLVariables.length; i++) { + var sParameterName = sURLVariables[i].split('='); + if (sParameterName[0] == 'q') { + return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20')); + } + } +} + +function joinUrl (base, path) { + if (path.substring(0, 1) === "/") { + // path starts with `/`. Thus it is absolute. + return path; + } + if (base.substring(base.length-1) === "/") { + // base ends with `/` + return base + path; + } + return base + "/" + path; +} + +function escapeHtml (value) { + return value.replace(/&/g, '&') + .replace(/"/g, '"') + .replace(//g, '>'); +} + +function formatResult (location, title, summary) { + return ''; +} + +function displayResults (results) { + var search_results = document.getElementById("mkdocs-search-results"); + while (search_results.firstChild) { + search_results.removeChild(search_results.firstChild); + } + if (results.length > 0){ + for (var i=0; i < results.length; i++){ + var result = results[i]; + var html = formatResult(result.location, result.title, result.summary); + search_results.insertAdjacentHTML('beforeend', html); + } + } else { + var noResultsText = search_results.getAttribute('data-no-results-text'); + if (!noResultsText) { + noResultsText = "No results found"; + } + search_results.insertAdjacentHTML('beforeend', '

' + noResultsText + '

'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..48071e97 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"QWC2 / QWC Services QGIS Web Client 2 (QWC2) is a modular next generation responsive web client for QGIS Server, built with ReactJS and OpenLayers. The core concept of QWC2 is to display QGIS Projects which are published by QGIS Server via WMS. There are two ways to run QWC2: As part of the qwc-services ecosystem, includes additional services to which includes additional services to extend the viewer functionality (such as user administration, editing, etc.). This is the recommended approach. As a standalone viewer (static JS/HTML/CSS web application) on top of QGIS Server. QWC2 with qwc-servies on the backend provide a complete Web GIS infrastructure. Overview of functionalities Without any additional services, the stock QWC2 offers the following main functionalities: Theme switcher (a theme is a published QGIS project) Switchable background layers Layer tree Object information (feature info) Search with configurable providers Measurement tools Redlining (sketching) URL sharing Geolocation PDF printing Raster and DXF export Compare layers Import external layers (WMS, WFS, WMTS, KML, GeoJSON) When run as part of the qwc-services ecosystem, the following additional viewer functionalities are available: User administration Editing Fulltext search Compact permalinks Height profile Custom feature info templates Mapinfo popup Reports (via Jasper) qwc-services also provides the following enterprise relevant functionalities: Docker/Kubernetes or WSGI deployments Multi-tenant setup Custom service integration Multiple authentication backends Explore Quickstart Some public viewers: Demo | Glarus | Solothurn | qgisweb.oslandia.net | Erft Verband Support Community support: Github Commercial Support: Sourcepole and other companies. Improve this web site","title":"Home"},{"location":"#qwc2-qwc-services","text":"QGIS Web Client 2 (QWC2) is a modular next generation responsive web client for QGIS Server, built with ReactJS and OpenLayers. The core concept of QWC2 is to display QGIS Projects which are published by QGIS Server via WMS. There are two ways to run QWC2: As part of the qwc-services ecosystem, includes additional services to which includes additional services to extend the viewer functionality (such as user administration, editing, etc.). This is the recommended approach. As a standalone viewer (static JS/HTML/CSS web application) on top of QGIS Server. QWC2 with qwc-servies on the backend provide a complete Web GIS infrastructure.","title":"QWC2 / QWC Services"},{"location":"#overview-of-functionalities","text":"Without any additional services, the stock QWC2 offers the following main functionalities: Theme switcher (a theme is a published QGIS project) Switchable background layers Layer tree Object information (feature info) Search with configurable providers Measurement tools Redlining (sketching) URL sharing Geolocation PDF printing Raster and DXF export Compare layers Import external layers (WMS, WFS, WMTS, KML, GeoJSON) When run as part of the qwc-services ecosystem, the following additional viewer functionalities are available: User administration Editing Fulltext search Compact permalinks Height profile Custom feature info templates Mapinfo popup Reports (via Jasper) qwc-services also provides the following enterprise relevant functionalities: Docker/Kubernetes or WSGI deployments Multi-tenant setup Custom service integration Multiple authentication backends","title":"Overview of functionalities"},{"location":"#explore","text":"Quickstart Some public viewers: Demo | Glarus | Solothurn | qgisweb.oslandia.net | Erft Verband","title":"Explore"},{"location":"#support","text":"Community support: Github Commercial Support: Sourcepole and other companies. Improve this web site","title":"Support"},{"location":"FAQ/","text":"FAQ","title":"FAQ"},{"location":"FAQ/#faq","text":"","title":"FAQ"},{"location":"QuickStart/","text":"Quick start Running QWC2 as part of qwc-services qwc-services is a collection of loosely coupled micro-services for extending QWC2. The services communicate with each other via HTTP/Rest, and are mostly written in Python. The easiest way to run qwc-services is to use the readily available docker images, using the sample setup at qwc-docker . To be able to run qwc-docker , first install docker and docker compose : Docker: https://docs.docker.com/engine/install/ docker-compose: https://docs.docker.com/compose/install/ Then, follow these steps: Clone the qwc-docker sample setup at qwc-docker and copy the docker-compose and api-gateway configuration templates: git clone https://github.com/qwc-services/qwc-docker.git cd qwc-docker cp docker-compose-example.yml docker-compose.yml cp api-gateway/nginx-example.conf api-gateway/nginx.conf Create a secret key: python3 -c 'import secrets; print(\"JWT_SECRET_KEY=\\\"%s\\\"\" % secrets.token_hex(48))' >.env Change the UID/GID which runs the QWC services to match the user/group which owns the shared volumes on the host by setting SERVICE_UID and SERVICE_GID in qwc-docker/docker-compose.yml . Set permissions for the shared solr data volume: sudo chown 8983:8983 volumes/solr/data Start all containers (will download all images from dockerhub when executed the first time): docker-compose up The map viewer will run on http://localhost:8088/ . The admin GUI will run on http://localhost:8088/qwc_admin (default admin credentials: username admin , password admin , requires password change on first login). Next steps: Configure the themes Customize the viewer Configuring the services Set resource permissions Running QWC2 as a standalone viewer If you don't need the advanced functionalities provided by qwc-services or want to integrate QWC2 in another environment, you can run QWC2 as a standalone viewer. To work with QWC2, you will need a minimal development environment consisting of git , node and yarn . You will also need a running QGIS Server instance which serves your projects. The fastest way to get started is by cloning the demo application: git clone --recursive https://github.com/qgis/qwc2-demo-app.git Next, install all required dependencies: cd qwc2-demo-app yarn install Then, start a local development application: yarn start The development application will run by default on http://localhost:8081 . At this point, you can customize and configure the application according to your needs, as described in detail in the following chapters. The final step is to compile a deployable application bundle for production: yarn run prod You can then deploy the contents of the prod folder to your web server. Next steps: Configure the themes Customize the viewer","title":"Quick start"},{"location":"QuickStart/#quick-start","text":"","title":"Quick start"},{"location":"QuickStart/#running-qwc2-as-part-of-qwc-services","text":"qwc-services is a collection of loosely coupled micro-services for extending QWC2. The services communicate with each other via HTTP/Rest, and are mostly written in Python. The easiest way to run qwc-services is to use the readily available docker images, using the sample setup at qwc-docker . To be able to run qwc-docker , first install docker and docker compose : Docker: https://docs.docker.com/engine/install/ docker-compose: https://docs.docker.com/compose/install/ Then, follow these steps: Clone the qwc-docker sample setup at qwc-docker and copy the docker-compose and api-gateway configuration templates: git clone https://github.com/qwc-services/qwc-docker.git cd qwc-docker cp docker-compose-example.yml docker-compose.yml cp api-gateway/nginx-example.conf api-gateway/nginx.conf Create a secret key: python3 -c 'import secrets; print(\"JWT_SECRET_KEY=\\\"%s\\\"\" % secrets.token_hex(48))' >.env Change the UID/GID which runs the QWC services to match the user/group which owns the shared volumes on the host by setting SERVICE_UID and SERVICE_GID in qwc-docker/docker-compose.yml . Set permissions for the shared solr data volume: sudo chown 8983:8983 volumes/solr/data Start all containers (will download all images from dockerhub when executed the first time): docker-compose up The map viewer will run on http://localhost:8088/ . The admin GUI will run on http://localhost:8088/qwc_admin (default admin credentials: username admin , password admin , requires password change on first login). Next steps: Configure the themes Customize the viewer Configuring the services Set resource permissions","title":"Running QWC2 as part of qwc-services"},{"location":"QuickStart/#running-qwc2-as-a-standalone-viewer","text":"If you don't need the advanced functionalities provided by qwc-services or want to integrate QWC2 in another environment, you can run QWC2 as a standalone viewer. To work with QWC2, you will need a minimal development environment consisting of git , node and yarn . You will also need a running QGIS Server instance which serves your projects. The fastest way to get started is by cloning the demo application: git clone --recursive https://github.com/qgis/qwc2-demo-app.git Next, install all required dependencies: cd qwc2-demo-app yarn install Then, start a local development application: yarn start The development application will run by default on http://localhost:8081 . At this point, you can customize and configure the application according to your needs, as described in detail in the following chapters. The final step is to compile a deployable application bundle for production: yarn run prod You can then deploy the contents of the prod folder to your web server. Next steps: Configure the themes Customize the viewer","title":"Running QWC2 as a standalone viewer"},{"location":"configuration/ResourcesPermissions/","text":"Managing Users, Resources and Permissions qwc-docker has a QWC configuration backend . That backend can be reached by default at http://localhost:8088/qwc_admin . The configuration backend allows to assign users and groups to roles. The roles in their turn can receive permissions on resources. These configuration settings will be stored in the configuration database . Out of the box qwc-docker comes with with a container qwc-postgis that contains the configuration database. Users, groups and roles Roles can be given permissions on resources. That means that if you want to give users or groups permissions on resources, then you have to first create a role, configure the permissions that the roles has on some resources, and then assign the role the users or groups. Resources The following resource types are available: Map : WMS corresponding to a QGIS Project Layer : layer of a map Attribute : attribute of a map layer Print template : print composer template of a QGIS Project Data : Data layer for editing Attribute : attribute of a data layer Data (create) : Data layer for creating features Data (read) : Data layer for reading features Data (update) : Data layer for updating features Data (delete) : Data layer for deleting features Viewer : custom map viewer configuration Viewer task : permittable viewer tasks FeatureInfo service : Feature info service FeatureInfo layer : Feature info layer The resource name corresponds to the technical name of its resource (e.g. WMS layer name). Most notably, the name of a map resource corresponds to the relative path to the project below qgs-resources without .qgs extension (so i.e. the resource name for qgs-resources/subfolder/project.qgs will be subfolder/project ). Note: If your QGIS project is configured to return the field aliases rather than the field names in GetFeatureInfo , the resource name for layer attribute resources corresponds to the alias of the field. Available map , layer , attribute and print_template resources are determined from WMS GetProjectSettings and the QGIS projects. data and their attribute resources define a data layer for the Data service . For more detailed CRUD permissions data_create , data_read , data_update and data_delete can be used instead of data ( data and write=False is equivalent to data_read ; data and write=True is equivalent to all CRUD resources combined). The viewer resource defines a custom viewer configuration for the map viewer (see Custom viewer configurations ). The viewer_task resource defines viewer functionalities (e.g. printing or raster export) that can be restricted or permitted. Their name (e.g. RasterExport ) corresponds to the key in menuItems and toolbarItems in the QWC2 config.json . Restricted viewer task items are then removed from the menu and toolbar in the map viewer. Viewer tasks not explicitly added as resources are kept unchanged from the config.json . Note : The resource types, i.e. for custom QWC2 plugins, can be extended by inserting new types into the qwc_config.resource_types table. These can be queried, e.g. in a custom service, by using PermissionClient::resource_permissions() or PermissionClient::resource_restrictions() from QWC Services Core . Permissions Permissions are based on roles. Roles can be assigned to groups or users, and users can be members of groups. A special role is \"public\". The \"public\" role applies always, no matter whether a user is signed in or is not signed in. Roles can be assigned permission for resources. The write flag is only used for data resources and determines whether a data layer is read-only. Based on the user's identity (user name and/or group name), all corresponding roles and their permissions and restrictions are collected. The service configurations are then modified according to these permissions and restrictions. By using the permissions_default_allow configuration setting in tenantConfig.json , some resources can be set to be permitted or restricted by default if no permissions are set (default: false ). Among affected resources are Map , Layer , Print template , Viewer task , FeatureInfo service , FeatureInfo layer . E.g.: permissions_default_allow=true : all maps and layers are permitted by default permissions_default_allow=false : maps and layers are only available if their resources and permissions are explicitly configured Restricted themes The display behaviour of restricted themes can be configured in the mapViewer service configuration in tenantConfig.json as follows: { \"name\": \"mapViewer\", \"config\": { \"show_restricted_themes\": false, \"show_restricted_themes_whitelist\": [], \"redirect_restricted_themes_to_auth\": false, \"internal_permalink_service_url\": \"http://qwc-permalink-service:9090\" } } show_restricted_themes : Whether to show placeholder items for restricted themes. Default: false . show_restricted_themes_whitelist : Whitelist of restricted theme names to display as placeholders. If empty, all restricted themes are shown. Only used if show_restricted_themes enabled. Default: [] . redirect_restricted_themes_to_auth : Whether to redirect to login on auth service if requesting a restricted theme in URL params, if not currently signed in. Default: false . internal_permalink_service_url : Internal permalink service URL for getting the theme from a resolved permalink for redirecting to login (default: http://qwc-permalink-service:9090 ). This is used only if redirect_restricted_themes_to_auth is enabled and permalink_service_url is set. Permissions file The QWC Config Generator generates a JSON file for all permissions from the QWC ConfigDB. See READMEs of QWC services for service specific contents in permissions.json . Group registration Using the optional Registration GUI allows users to request membership or unsubscribe from registrable groups. These requests can then be accepted or rejected in the Admin GUI . Workflow: Admin GUI admin user creates new groups with assigned roles and permissions on resources admin user configures registrable groups Registration GUI user select desired groups from registrable groups and submits application form admin users are notified of new registration requests Admin GUI admin user selects entry from list of pending registration requests admin user accepts or rejects registration requests for a user user is added to or removed from accepted groups user is notified of registration request updates Map Viewer user permissions are updated for new groups","title":"Resources and permissions"},{"location":"configuration/ResourcesPermissions/#managing-users-resources-and-permissions","text":"qwc-docker has a QWC configuration backend . That backend can be reached by default at http://localhost:8088/qwc_admin . The configuration backend allows to assign users and groups to roles. The roles in their turn can receive permissions on resources. These configuration settings will be stored in the configuration database . Out of the box qwc-docker comes with with a container qwc-postgis that contains the configuration database.","title":"Managing Users, Resources and Permissions"},{"location":"configuration/ResourcesPermissions/#users-groups-and-roles","text":"Roles can be given permissions on resources. That means that if you want to give users or groups permissions on resources, then you have to first create a role, configure the permissions that the roles has on some resources, and then assign the role the users or groups.","title":"Users, groups and roles"},{"location":"configuration/ResourcesPermissions/#resources","text":"The following resource types are available: Map : WMS corresponding to a QGIS Project Layer : layer of a map Attribute : attribute of a map layer Print template : print composer template of a QGIS Project Data : Data layer for editing Attribute : attribute of a data layer Data (create) : Data layer for creating features Data (read) : Data layer for reading features Data (update) : Data layer for updating features Data (delete) : Data layer for deleting features Viewer : custom map viewer configuration Viewer task : permittable viewer tasks FeatureInfo service : Feature info service FeatureInfo layer : Feature info layer The resource name corresponds to the technical name of its resource (e.g. WMS layer name). Most notably, the name of a map resource corresponds to the relative path to the project below qgs-resources without .qgs extension (so i.e. the resource name for qgs-resources/subfolder/project.qgs will be subfolder/project ). Note: If your QGIS project is configured to return the field aliases rather than the field names in GetFeatureInfo , the resource name for layer attribute resources corresponds to the alias of the field. Available map , layer , attribute and print_template resources are determined from WMS GetProjectSettings and the QGIS projects. data and their attribute resources define a data layer for the Data service . For more detailed CRUD permissions data_create , data_read , data_update and data_delete can be used instead of data ( data and write=False is equivalent to data_read ; data and write=True is equivalent to all CRUD resources combined). The viewer resource defines a custom viewer configuration for the map viewer (see Custom viewer configurations ). The viewer_task resource defines viewer functionalities (e.g. printing or raster export) that can be restricted or permitted. Their name (e.g. RasterExport ) corresponds to the key in menuItems and toolbarItems in the QWC2 config.json . Restricted viewer task items are then removed from the menu and toolbar in the map viewer. Viewer tasks not explicitly added as resources are kept unchanged from the config.json . Note : The resource types, i.e. for custom QWC2 plugins, can be extended by inserting new types into the qwc_config.resource_types table. These can be queried, e.g. in a custom service, by using PermissionClient::resource_permissions() or PermissionClient::resource_restrictions() from QWC Services Core .","title":"Resources"},{"location":"configuration/ResourcesPermissions/#permissions","text":"Permissions are based on roles. Roles can be assigned to groups or users, and users can be members of groups. A special role is \"public\". The \"public\" role applies always, no matter whether a user is signed in or is not signed in. Roles can be assigned permission for resources. The write flag is only used for data resources and determines whether a data layer is read-only. Based on the user's identity (user name and/or group name), all corresponding roles and their permissions and restrictions are collected. The service configurations are then modified according to these permissions and restrictions. By using the permissions_default_allow configuration setting in tenantConfig.json , some resources can be set to be permitted or restricted by default if no permissions are set (default: false ). Among affected resources are Map , Layer , Print template , Viewer task , FeatureInfo service , FeatureInfo layer . E.g.: permissions_default_allow=true : all maps and layers are permitted by default permissions_default_allow=false : maps and layers are only available if their resources and permissions are explicitly configured","title":"Permissions"},{"location":"configuration/ResourcesPermissions/#restricted-themes","text":"The display behaviour of restricted themes can be configured in the mapViewer service configuration in tenantConfig.json as follows: { \"name\": \"mapViewer\", \"config\": { \"show_restricted_themes\": false, \"show_restricted_themes_whitelist\": [], \"redirect_restricted_themes_to_auth\": false, \"internal_permalink_service_url\": \"http://qwc-permalink-service:9090\" } } show_restricted_themes : Whether to show placeholder items for restricted themes. Default: false . show_restricted_themes_whitelist : Whitelist of restricted theme names to display as placeholders. If empty, all restricted themes are shown. Only used if show_restricted_themes enabled. Default: [] . redirect_restricted_themes_to_auth : Whether to redirect to login on auth service if requesting a restricted theme in URL params, if not currently signed in. Default: false . internal_permalink_service_url : Internal permalink service URL for getting the theme from a resolved permalink for redirecting to login (default: http://qwc-permalink-service:9090 ). This is used only if redirect_restricted_themes_to_auth is enabled and permalink_service_url is set.","title":"Restricted themes"},{"location":"configuration/ResourcesPermissions/#permissions-file","text":"The QWC Config Generator generates a JSON file for all permissions from the QWC ConfigDB. See READMEs of QWC services for service specific contents in permissions.json .","title":"Permissions file"},{"location":"configuration/ResourcesPermissions/#group-registration","text":"Using the optional Registration GUI allows users to request membership or unsubscribe from registrable groups. These requests can then be accepted or rejected in the Admin GUI . Workflow: Admin GUI admin user creates new groups with assigned roles and permissions on resources admin user configures registrable groups Registration GUI user select desired groups from registrable groups and submits application form admin users are notified of new registration requests Admin GUI admin user selects entry from list of pending registration requests admin user accepts or rejects registration requests for a user user is added to or removed from accepted groups user is notified of registration request updates Map Viewer user permissions are updated for new groups","title":"Group registration"},{"location":"configuration/ServiceConfiguration/","text":"QWC Services configuration The architecture of qwc-services is as follows: API-Gateway: API Gateway, forwards requests to individual services http://localhost:8088 Auth-Service: Authentication service with local user database (default users: admin:admin, demo:demo) http://localhost:8088/auth/login Map viewer: QWC2 map viewer http://localhost:8088 OGC Service: Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server http://localhost:8088/ows/api Admin GUI: Admin GUI http://localhost:8088/qwc_admin/ qwc-docker ships a pre-configured the qwc-services ecosystem as an easy to use application. Service overview Following is an overview of existing qwc-services : Applications : QWC2 Map Viewer : The map viewer application QWC Admin GUI : Configuration backend for managing users and permissions Registration GUI : GUI for registration of new users REST services : DB auth service : Authentication service with local user database LDAP auth service : LDAP Authentication service Data service : Data edit service, required for QWC2 editing functionality Document service : Service for generating Jasper reports Elevation service : Service for providing elevation data, required for QWC2 elevation profile Feature info service : Service for providing enhanced GetFeatureInfo responses to QWC2 Fulltext search service : Fulltext search service for the QWC2 search functionality Legend service : Service for providing enhanced legend graphics to QWC2 Mapinfo service : Service for providing additional information to the QWC2 right-click map context popup OGC service : Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server Permalink service : Service for storing compat permalinks and bookmarks generated by QWC2 Print service : Service for enhancing the QWC2 GetPrint requests Configuration database : DB schema and migrations Demo database Configuration generator : Configuration generator qwc-docker layout The layout of the qwc-docker tree is as follows: Path Description \u251c\u2500 api-gateway/nginx.conf API gateway configuration. \u251c\u2500 volumes/ Contains folders which are mounted into the various containers. \u2502 \u251c\u2500 attachments Storage of files uploaded through the QWC2 editing functionality. \u2502 \u251c\u2500 config// Service configuration files, generated by qwc-config-generator . \u2502 \u251c\u2500 config-in// Input configuration files, processed by the qwc-config-generator . \u2502 \u2502 \u251c\u2500 config.json Master configuration for the QWC2 viewer. \u2502 \u2502 \u251c\u2500 index.html Viewer entry point. \u2502 \u2502 \u251c\u2500 themesConfig.json Themes configuration. \u2502 \u2502 \u2514\u2500 tenantConfig.json Master configuration file for qwc services. \u2502 \u251c\u2500 db/ Storage of configuration database (see qwc-config-db ). \u2502 \u251c\u2500 info-templates/ Custom feature-info templates (see qwc-feature-info-service ). \u2502 \u251c\u2500 jasper-reports/ Jasper reports (see qwc-document-service ). \u2502 \u251c\u2500 legends/ Custom legend images (see qwc-legend-service ). \u2502 \u251c\u2500 qgs-resources/ QGIS projects and data referenced by the projects. \u2502 \u251c\u2500 qwc2/ QWC2 Viewer. \u2502 \u2514\u2500 solr/ Fulltext search index. \u251c\u2500 docker-compose.yml Container configuration file. \u251c\u2500 pg_service.conf Database service definitions. \u2514\u2500 pg_service-write.conf Database service definitions for write connections. Service configurations The master configuration file for the QWC services is located at qwc-docker/volumes/config-in//tenantConfig.json , where is the tenant name, default by default. See Multi Tenancy for more details on tenants. The file is structured as follows: { \"$schema\": \"https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json\", \"service\": \"config-generator\", \"config\": { }, \"themesConfig\": \"./themesConfig.json\", \"services\": [ { \"name\": \" }, ... ] } Refer to the qwc-config-generator schema for the available ConfigGenerator config settings. themesConfig is a relative path to the theme configuration file as documented in Theme configuration . The services block contains the configuration for the individual QWC services, as documented in the reference . Note: All config settings can also be set as environment variables in capitalized form in docker-compose.yml . Note: Some variables must be set as environment variables in docker-compose.yml : ENV Default value Description INPUT_CONFIG_PATH config-in Base path for service configuration files OUTPUT_CONFIG_PATH /tmp Base path for service configuration files JWT_SECRET_KEY ******** secret key for JWT token TENANT_URL_RE None Regex for tenant extraction from base URL. Example: ^https?://.+?/(.+?)/ TENANT_HEADER None Tenant Header name. Example: Tenant Enabling additional services Add service entry in qwc-services/docker-compose.yml , setting the service mountpoint: SERVICE_MOUNTPOINT=/ Example: qwc-print-service: image: sourcepole/qwc-print-service:vYYYY.MM.DD environment: <<: *qwc-service-variables SERVICE_MOUNTPOINT: '/api/v1/print' volumes: - ./volumes/config:/srv/qwc_service/config:ro ports: - \"127.0.0.1:5020:9090\" Add corresponding entry in api-gateway/nginx.conf , example: location /api/v1/print { proxy_pass http://qwc-print-service:9090; } If necessary, uncomment/add the respective service url (see also the qwc-map-viewer schema reference ) in the mapViewer config block of volumes/config-in/default/tenantConfig.json , i.e. { \"name\": \"mapViewer\", \"generator_config\": { # ... }, \"config\": { \"print_service_url\": \"/api/v1/print/\", # ... } } Add the service configuration block below services in volumes/config-in/default/tenantConfig.json , according to the service config schema, i.e. { \"name\": \"print\", \"config\": { \"ogc_service_url\": \"http://qwc-ogc-service:9090/\", \"qgis_server_version\": \"3.16\" } } Configuration database The Configuration database (ConfigDB) contains the database schema qwc_config for configurations and permissions of QWC services. This database uses the PostgreSQL connection service qwc_configdb by default, which can be setup for the corresponding database in the PostgreSQL connection service file qwc-docker/pg_service.conf . To use an external configuration database, either change the connection definition for qwc_configdb in qwc-docker/pg_service.conf or change the config_db_url in qwc-docker/volumes/config-in//tenantConfig.json . Database migrations An existing ConfigDB can be updated to the latest schema by running the database migrations from the qwc-config-db directory: git clone https://github.com/qwc-services/qwc-config-db.git cd qwc-config-db/ # Install alembic, either globally or activate python virtualenv and run `pip install -r requirements.txt`) alembic upgrade head Note: The qwc_configdb service definition must exist in the host, for instance: cat $HOME/.pg_service.conf [qwc_configdb] host=localhost port=5439 dbname=qwc_demo user=qwc_admin password=qwc_admin sslmode=disable Keeping QWC services up to date When using qwc-docker , updating the services is a simple as updating the image tags in qwc-docker/docker-compose.yml . Two versioning schemes are available: vYYYY-MM-DD : These refer to the latest available version of the respective images (i.e. v2023.05.12 ). vYYYY.X-lts : These refer to the long term support version of the respective images (i.e. v2023.1-lts ). You can always check the available tags on dockerhub, for example at https://hub.docker.com/r/sourcepole/qwc-config-generator . The qwc-docker Upgrade Notes documents major changes, and in particular all incompatible changes between releases which require changes to the application specific code and/or configuration.","title":"Services"},{"location":"configuration/ServiceConfiguration/#qwc-services-configuration","text":"The architecture of qwc-services is as follows: API-Gateway: API Gateway, forwards requests to individual services http://localhost:8088 Auth-Service: Authentication service with local user database (default users: admin:admin, demo:demo) http://localhost:8088/auth/login Map viewer: QWC2 map viewer http://localhost:8088 OGC Service: Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server http://localhost:8088/ows/api Admin GUI: Admin GUI http://localhost:8088/qwc_admin/ qwc-docker ships a pre-configured the qwc-services ecosystem as an easy to use application.","title":"QWC Services configuration"},{"location":"configuration/ServiceConfiguration/#service-overview","text":"Following is an overview of existing qwc-services : Applications : QWC2 Map Viewer : The map viewer application QWC Admin GUI : Configuration backend for managing users and permissions Registration GUI : GUI for registration of new users REST services : DB auth service : Authentication service with local user database LDAP auth service : LDAP Authentication service Data service : Data edit service, required for QWC2 editing functionality Document service : Service for generating Jasper reports Elevation service : Service for providing elevation data, required for QWC2 elevation profile Feature info service : Service for providing enhanced GetFeatureInfo responses to QWC2 Fulltext search service : Fulltext search service for the QWC2 search functionality Legend service : Service for providing enhanced legend graphics to QWC2 Mapinfo service : Service for providing additional information to the QWC2 right-click map context popup OGC service : Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server Permalink service : Service for storing compat permalinks and bookmarks generated by QWC2 Print service : Service for enhancing the QWC2 GetPrint requests Configuration database : DB schema and migrations Demo database Configuration generator : Configuration generator","title":"Service overview"},{"location":"configuration/ServiceConfiguration/#qwc-docker-layout","text":"The layout of the qwc-docker tree is as follows: Path Description \u251c\u2500 api-gateway/nginx.conf API gateway configuration. \u251c\u2500 volumes/ Contains folders which are mounted into the various containers. \u2502 \u251c\u2500 attachments Storage of files uploaded through the QWC2 editing functionality. \u2502 \u251c\u2500 config// Service configuration files, generated by qwc-config-generator . \u2502 \u251c\u2500 config-in// Input configuration files, processed by the qwc-config-generator . \u2502 \u2502 \u251c\u2500 config.json Master configuration for the QWC2 viewer. \u2502 \u2502 \u251c\u2500 index.html Viewer entry point. \u2502 \u2502 \u251c\u2500 themesConfig.json Themes configuration. \u2502 \u2502 \u2514\u2500 tenantConfig.json Master configuration file for qwc services. \u2502 \u251c\u2500 db/ Storage of configuration database (see qwc-config-db ). \u2502 \u251c\u2500 info-templates/ Custom feature-info templates (see qwc-feature-info-service ). \u2502 \u251c\u2500 jasper-reports/ Jasper reports (see qwc-document-service ). \u2502 \u251c\u2500 legends/ Custom legend images (see qwc-legend-service ). \u2502 \u251c\u2500 qgs-resources/ QGIS projects and data referenced by the projects. \u2502 \u251c\u2500 qwc2/ QWC2 Viewer. \u2502 \u2514\u2500 solr/ Fulltext search index. \u251c\u2500 docker-compose.yml Container configuration file. \u251c\u2500 pg_service.conf Database service definitions. \u2514\u2500 pg_service-write.conf Database service definitions for write connections.","title":"qwc-docker layout"},{"location":"configuration/ServiceConfiguration/#service-configurations","text":"The master configuration file for the QWC services is located at qwc-docker/volumes/config-in//tenantConfig.json , where is the tenant name, default by default. See Multi Tenancy for more details on tenants. The file is structured as follows: { \"$schema\": \"https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json\", \"service\": \"config-generator\", \"config\": { }, \"themesConfig\": \"./themesConfig.json\", \"services\": [ { \"name\": \" }, ... ] } Refer to the qwc-config-generator schema for the available ConfigGenerator config settings. themesConfig is a relative path to the theme configuration file as documented in Theme configuration . The services block contains the configuration for the individual QWC services, as documented in the reference . Note: All config settings can also be set as environment variables in capitalized form in docker-compose.yml . Note: Some variables must be set as environment variables in docker-compose.yml : ENV Default value Description INPUT_CONFIG_PATH config-in Base path for service configuration files OUTPUT_CONFIG_PATH /tmp Base path for service configuration files JWT_SECRET_KEY ******** secret key for JWT token TENANT_URL_RE None Regex for tenant extraction from base URL. Example: ^https?://.+?/(.+?)/ TENANT_HEADER None Tenant Header name. Example: Tenant","title":"Service configurations"},{"location":"configuration/ServiceConfiguration/#enabling-additional-services","text":"Add service entry in qwc-services/docker-compose.yml , setting the service mountpoint: SERVICE_MOUNTPOINT=/ Example: qwc-print-service: image: sourcepole/qwc-print-service:vYYYY.MM.DD environment: <<: *qwc-service-variables SERVICE_MOUNTPOINT: '/api/v1/print' volumes: - ./volumes/config:/srv/qwc_service/config:ro ports: - \"127.0.0.1:5020:9090\" Add corresponding entry in api-gateway/nginx.conf , example: location /api/v1/print { proxy_pass http://qwc-print-service:9090; } If necessary, uncomment/add the respective service url (see also the qwc-map-viewer schema reference ) in the mapViewer config block of volumes/config-in/default/tenantConfig.json , i.e. { \"name\": \"mapViewer\", \"generator_config\": { # ... }, \"config\": { \"print_service_url\": \"/api/v1/print/\", # ... } } Add the service configuration block below services in volumes/config-in/default/tenantConfig.json , according to the service config schema, i.e. { \"name\": \"print\", \"config\": { \"ogc_service_url\": \"http://qwc-ogc-service:9090/\", \"qgis_server_version\": \"3.16\" } }","title":"Enabling additional services"},{"location":"configuration/ServiceConfiguration/#configuration-database","text":"The Configuration database (ConfigDB) contains the database schema qwc_config for configurations and permissions of QWC services. This database uses the PostgreSQL connection service qwc_configdb by default, which can be setup for the corresponding database in the PostgreSQL connection service file qwc-docker/pg_service.conf . To use an external configuration database, either change the connection definition for qwc_configdb in qwc-docker/pg_service.conf or change the config_db_url in qwc-docker/volumes/config-in//tenantConfig.json .","title":"Configuration database"},{"location":"configuration/ServiceConfiguration/#database-migrations","text":"An existing ConfigDB can be updated to the latest schema by running the database migrations from the qwc-config-db directory: git clone https://github.com/qwc-services/qwc-config-db.git cd qwc-config-db/ # Install alembic, either globally or activate python virtualenv and run `pip install -r requirements.txt`) alembic upgrade head Note: The qwc_configdb service definition must exist in the host, for instance: cat $HOME/.pg_service.conf [qwc_configdb] host=localhost port=5439 dbname=qwc_demo user=qwc_admin password=qwc_admin sslmode=disable","title":"Database migrations"},{"location":"configuration/ServiceConfiguration/#keeping-qwc-services-up-to-date","text":"When using qwc-docker , updating the services is a simple as updating the image tags in qwc-docker/docker-compose.yml . Two versioning schemes are available: vYYYY-MM-DD : These refer to the latest available version of the respective images (i.e. v2023.05.12 ). vYYYY.X-lts : These refer to the long term support version of the respective images (i.e. v2023.1-lts ). You can always check the available tags on dockerhub, for example at https://hub.docker.com/r/sourcepole/qwc-config-generator . The qwc-docker Upgrade Notes documents major changes, and in particular all incompatible changes between releases which require changes to the application specific code and/or configuration.","title":"Keeping QWC services up to date"},{"location":"configuration/ThemesConfiguration/","text":"Themes configuration A theme corresponds to a QGIS project, published as WMS and served by QGIS Server. The basic steps for configuring a theme are: Create a QGIS project and deploy it to QGIS Server Writing the QWC2 theme configuration Generating the themes configuration Creating and publishing a QGIS project The first step is to prepare a QGIS project for publishing. Besides the common tasks of adding and styling layers, the following table gives an overview of settings which influence how the theme is displayed in QWC2: What Where Description Service Metadata Project Properties \u2192 QGIS Server \u2192 Service capabilities Shown in the theme info dialog, invokable from the Layer Tree panel titlebar. Title, keywords Project Properties \u2192 QGIS Server \u2192 Service capabilities Theme title, displayed in the Theme Switcher, and keywords, useful for filtering. Map extent Project Properties \u2192 QGIS Server \u2192 WMS \u2192 Advertised extent The extent used as initial map extent when loading the theme, unless overridden in themesConfig.json . Queryable layers Project Properties \u2192 Data sources Mark layers as identifyable by the client. FeatureInfo geometry Project Properties \u2192 QGIS Server \u2192 WMS Capabilities \u2192 Add geometry to feature response Return feature geometries with the GetFeatureInfo request. Allows the client to highlight the selected features. Layer Display Field Vector Layer Properties \u2192 Display The field used in the identify results. Layer Map Tip Vector Layer Properties \u2192 Display The contents of the Map Tip shown when hovering over layers in the client, if displaying Map Tips is enabled in the Layer Tree. Layer Metadata Layer Properties \u2192 QGIS Server Shown in the client Layer Info dialog, invokable from the Layer Tree. Scale range Layer Properties \u2192 Rendering \u2192 Scale dependent visibility The scale range within which a layer is visible, useful to improve rendering performance. Initial visibility Layers Panel Initial visibility of layers and groups. Rendering order Layer Order Panel or Layers Panel Rendering order of the layers. If layer re-ordering is enabled in config.json , the order from the Layer Order Panel is ignored. Print layouts Layout manager The print layouts offered in the Print plugin. Print layout labels Layout manager Print layout labels with an ID will be exposed in the Print plugin. Note: a label ID starting with __ will not be exposed. Attribute form Vector Layer Properties \u2192 Attributes Form The configured attribute form will be displayed when editing in QWC2. External layers Layer Properties \u2192 QGIS Server \u2192 Data URL Mark the layer as an external layer to avoid cascaded requests. See Configuring external layers . Then, store the project in the publishing directory of your QGIS Server instance. When using qwc-docker , store the project as *.qgs below qwc-docker/volumes/qgs-resources . Alternatively, when using qwc-docker , you can also store the project in a database in QGIS using Project \u2192 Save To \u2192 PostgreSQL (see Storing projects in database ). Ensuring valid datasources A common issue is that the project will reference datasources in locations which cannot be resolved when QGIS Server reads the project, in particular when running QGIS Server inside a docker container. To avoid such issues: Make sure that any file-based resources are located on the same level or below the level of the *.qgs project file. Remember to copy all resources along with the *.qgs project file to the server. Load any PostgreSQL datasource in QGIS using a service, and make sure the service definition exists both in the pg_service.conf on your host system as well as in the qwc_docker/pg_service.conf and qwc_docker/pg_service-write.conf which are mounted inside the docker containers. For instance, to use default qwc-docker database, use the qwc_geodb service and add the service definition to your host pg_service.conf as follows: [qwc_geodb] host=localhost port=5439 dbname=qwc_demo user=qwc_service password=qwc_service sslmode=disable Configuring the themes in themesConfig.json The next step is to configure the theme for QWC2. There are two approaches: Automatic theme configuration (only when using qwc-docker ): Just copy the project file to the designated location and the qwc-config-generator will automatically generate a theme configuration using default parameters. Manual theme configuration : Manually configure a theme with the full set of configuration options. Automatic theme configuration When using qwc-docker , save your QGIS projects below qwc-docker/volumes/qgs-resources/scan . Adjust the default settings ( defaultMapCrs , defaultBackgroundLayers , etc.) as desired in qwc-docker/volumes/config-in//themesConfig.json . Then generate the theme configuration . You can configure an automatically configured theme as default theme by setting defaultTheme in themesConfig.json to the path to the QGIS project file below qwc-docker/volumes/qgs-resources , without the .qgs extension. For example to set qwc-docker/volumes/qgs-resources/scan/project.qgs as default theme, you'd write ... \"defaultTheme\": \"scan/project\" ... To use a custom thumbnail for an automatically configured theme, place a an image called .png in qwc-docker/volumes/qwc2/assets/img/mapthumbs . For example. if the project is called project_name.qgs , the name thumbnail image would be named project_name.png . Note: The auto-scan directory can be is controlled by qgis_projects_scan_base_dir in qwc-docker/volumes/config-in//themesConfig.json . Manual theme configuration The theme configuration file is located as follows: Standalone viewer: qwc2-app/themesConfig.json qwc-docker : qwc-docker/volumes/config-in//themesConfig.json Note : when using qwc-docker , the themes configuration may also be embedded as themesConfig directly in qwc-docker/volumes/config-in//tenantConfig.json . The themesConfig.json file contains a list of themes, optionally organized in groups, as well as a list of background layers: { \"themes\": { \"items\": [ { }, ... ], \"groups\": [ { \"title\": , \"items\": [{ }, ...], \"groups\": [ { }, ...] }, ... ], \"externalLayers\": [ { }, ... ], \"themeInfoLinks\": [ { }, ... ], \"backgroundLayers\": [ { }, ... ], }, \"defaultMapCrs\": \"\", \"defaultBackgroundLayers\": \"\", \"defaultWMSVersion\": \"\", \"defaultScales\": [], \"defaultPrintScales\" [], \"defaultPrintResolutions\": [], \"defaultSearchProviders\": [], \"defaultPrintGrid\": [], \"defaultTheme\": \"\" } Refer to the sample themesConfig.json for a complete example. The format of the theme definitions is as follows: Entry Description \"id\": \"\", Theme identificator. Autogenerated if not specified. \"url\": \"\", The address of desired WMS served by QGIS Server. \"mapCrs: \"\", Optional, map projection, defaults to defaultMapCrs . \"title\": \"\", Optional, override WMS title. \"description\": \"\", Optional, an additional description to show below the theme title. \"thumbnail\": \"\", Optional, image file in assets/img/mapthumbs (see Viewer assets ). If omitted, autogenerated via WMS GetMap. \"attribution\": \"\", Optional, attribution which will be shown in the bottom right corner of the map. \"attributionUrl\": \"\", Optional, link associated to the attribution \"scales\": [], List of denominators of allowed map scales. If omitted, defaults to defaultScales . \"printScales\": [], List of denominators of allowed print scales. If omitted, defaults to defaultPrintScales . \"printResolutions\": [], List of available print resolutions. If omitted, defaults to defaultPrintResolutions . \"printGrid\": [ List of grid scale-dependent grid intervals to use when printing. If omitted, defaults to defaultPrintGrid . \u2063 {\"s\": , \"x\": , \"y\": }, Keep this list sorted in descending order by scale denominator. \u2063 {\"s\": , \"x\": , \"y\": } In this example, {x: , y: } will be used for > Scale >= . ], \"printLabelForSearchResult\": \"\", Optional, an ID of a print layout label to which the current search result text (if any) will be written to when printing. \"printLabelForAttribution\": \"\", Optional, an ID of a print layout label to which the current attribution text (if any) will be written to when printing. \"printLabelConfig\": { Optional, configuration of the text input fields for print layout labels. \u2063 \"\": {\"rows\": , \"maxLength\": }, Height of the input field in rows and maximum number of allowed characters. }, \"extent\": [, , , ], Optional, override theme extent. In mapCrs . \"tiled\": , Optional, use tiled WMS, defaults to false . \"format\": \"\", Optional, the format to use for WMS GetMap. Defaults to image/png . \"externalLayers\": [{ Optional, external layers to use as replacements for internal layers, see below. \u2063 \"name\": \"\", Name of the external layer, matching a ExternalLayerDefinition , see below. \u2063 \"internalLayer\": \"\" Name of an internal layer, as contained in the QGIS project, to replace with the external layer. }], \"themeInfoLinks\": { Optional, custom links to additional resources, shown as a menu in the theme selector in the theme switcher.\\ \u2063 \"title\": \"\", An arbitrary string shown as title of the menu. \u2063 \"titleMsgId\": \"\", Alternative to title , a message ID, translated through the translation files. \u2063 \"entries\": [, ...] List of theme info link names, see below. }, \"backgroundLayers\": [{, Optional, list of available background layers, defaults to defaultBackgroundLayers . \u2063 \"name\": \"\", Name of matching BackgroundLayerDefinition , see below. \u2063 \"printLayer\": \"\"\\|[], Optional, name of layer to use as matching background layer when printing. Alternatively, a list [{\"maxScale\": , \"name\": \"\"}, ..., {\"maxScale\": null, \"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. \u2063 \"visibility\": , Optional, initial visibility of the layer when theme is loaded. \u2063 \"overview\": , 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). }], \"searchProviders\": [\"\"], Optional, list of search providers, see Search providers . Defaults to defaultSearchProviders . \"minSearchScaleDenom\": , Optional, minimum scale to enforce when zooming to search results. Takes precedence over value in config.json . \"featureReport\": { Optional, available feature report templates. \u2063 \"\": \"\" WMS sublayer ID and associated template ID to pass to the featureReportService . }, \"additionalMouseCrs\": [\"\"], 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 . \"watermark\": { Optional, configuration of watermark to add to raster export images. \u2063 \"text\": \"\", Arbitrary text. \u2063 \"texpadding\": , Optional, padding between text and frame, in points. \u2063 \"fontsize\": , Optional, font size. \u2063 \"fontfamily\": \"\", Optional, font family. \u2063 \"fontcolor\": \"#RRGGBB\", Optional, font color. \u2063 \"backgroundcolor\": \"#RRGGBB\", Optional, frame background color. \u2063 \"framecolor\": \"#RRGGBB\", Optional, frame color. \u2063 \"framewidth\": , Optional, frame width. }, \"collapseLayerGroupsBelowLevel\": , Optional, layer tree level below which to initially collapse groups. By default the tree is completely expanded. \"skipEmptyFeatureAttributes\": , Optional, whether to skip empty attributes in the identify results. Default is false . \"mapTips\": \\|null, Optional, per-theme setting whether map-tips are unavailable ( null ), disabled by default ( false ) or enabled by default ( true ). \"extraLegendParameters\": \"<&KEY=VALUE>\", Optional, additional query parameters to append to GetLegendGraphic request. \"extraDxfParameters\": \"<&KEY=VALUE>\", Optional, additional query parameters to append to DXF export request. \"extraPrintParameters\": \"<&KEY=VALUE>\", Optional, additional query parameters to append to GetPrint request (requires QGIS Server >= 3.32.0). \"printLabelBlacklist\": [\"\", ...] Optional, list of composer label ids to not expose in the print dialog. \"editConfig\": \"\" Optional, object or path to a filename containing the editing configuration for the theme, see Editing . \"snapping\": {...}, Optional, snapping configuration, see Snapping . \"config\": { Optional, per-theme configuration entries which override the global entries in config.json , see Viewer Configuration . \u2063 \"allowRemovingThemeLayers\": See config.json for which settings can be specified here. \u2063 ... } \"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 . \u2063 \"username\": Optional: http basic authentication username. \u2063 \"password\": Optional: http basic authentication password. }, A bare minimum theme entry might look as follows: { \"id\": \"theme_id\", \"title\": \"My theme\", \"url\": \"/ows/my_theme\", \"mapCrs\": \"EPSG:3857\", \"backgroundLayers\": [{\"name\": \"background_layer_name\"}], \"searchProviders\" [\"coordinates\"] } Note: The theme identifier id can be freely defined and will appear in the viewer URL as the t query parameter. When using qwc-docker , the url can be specified as /ows/ where relative_path_to_qgs is the path to the QGIS project file below qwc-docker/volumes/qgs-resources , without the .qgs extension. In the above sample, the project file would be located at qwc-docker/volumes/qgs-resources/my_theme.qgs . External layers External layers can be used to selectively replace layers in a QGIS project with a layer from an external source, for instance in the case of a WMS layer embedded in a QGIS project, to avoid cascading WMS requests. They are handled transparently by QWC2 (they are positioned in the layer tree identically to the internal layer they replace), but the GetMap and GetFeatureInfo requests are sent directly to the specified WMS Service. Configuring external layers via Data Url The simplest way to define an external layer is to set the \"Data Url\" for a layer in QGIS (Layer Properties \u2192 QGIS Server \u2192 Data Url) to a string of these forms wms:?# wmts:?# For instance: wms:http://wms.geo.admin.ch?tiled=false&infoFormat=application/geojson#ch.are.bauzonen wmts:https://wmts10.geo.admin.ch/EPSG/2056/1.0.0/WMTSCapabilities.xml#ch.swisstopo.swissboundaries3d-gemeinde-flaeche.fill Note: Support for WMTS in Data Url is currently only implemented when using qwc-docker . Note: You can pass parameters which control the behaviour of the WMS client in QGIS Server by prefexing the parameters with extwms. when the layer is requested by QGIS Server, i.e. when printing. Example to override the step width/heigth of the QGIS WMS Client: wms:http://wms.geo.admin.ch?extwms.stepWidth=4096&extwms.stepHeight=4096#ch.swisstopo.pixelkarte-farbe-pk1000.noscale Manually configuring external layers Rather than settin the \"Data Url\", you can provide a manual configuration in externalLayers in themesConfig.json as follows: Entry Description { \u2063 \"name\": \"\", The name of the external layer, as referenced in the theme definitions. \u2063 \"type\": \"\", Layer type, \"wms\" or \"wmts\" \u2063 \"url\": \"\", The WMS URL or WMTS resource URL for the external layer. } For external WMS layers, the following additional parameters apply: Entry Description \"params\": { Parameters for the GetMap request. \u2063 \"LAYERS\": \",...\" , WMS layer names. \u2063 \"OPACITIES\": \"<0-255>,...\" Optional, if WMS server supports opacities. }, \"featureInfoUrl\": \"\", Optional, base URL for WMS GetFeatureInfo, if different from url . \"legendUrl\": \"\" , Optional, base URL for WMS GetLegendGraphic, if different from url . \"queryLayers\": [\"\", ...], Optional, list of GetFeatureInfo query layers, if different from params.LAYERS . \"infoFormats\": [\"\", ...] List of GetFeatureInfo query formats which the WMS service supports. For external WMTS layers, the following additional parameters apply (you can use the qwc2/scripts/wmts_config_generator.py script to obtain these values): Entry Description \"tileMatrixSet\": \"\", The name of the tile matrix set. \"originX\": , The X origin of the tile matrix. \"originY\": , The Y origin of the tile matrix. \"projection\": \"EPSG:\", The layer projection. \"resolutions\": [, ...], The list of WMTS resolutions. \"tileSize\": [, ] The tile width and height. Theme info links You can specify links to display in an info-menu next to the respective theme title in the theme switcher entries. The format for the theme info links is as follows: Entry Description \"name\": \"\", The name of the link, as referenced in the theme definitions. \"title\": \"\", The title for the link, as displayed in the info menu of the theme entry in the theme switcher. \"url\": \"\", A link URL. \"target\": \"\" The link target, i.e. _blank . Background layers Background layers are handled completely client-side and do not appear in the layer tree. The format of the background layer definitions is as follows: Entry Description \"name\": \"\", The name of the background layer, used in the theme definitions. \"title\": \"\", The title of the background layer, as displayed in the background switcher. \"titleMsgId\": \"<Title msgID>\", Alternative to title , a message ID, translated through the translation files. \"thumbnail\": \"<Filename>\", Optional, image file in assets/img/mapthumbs (see Viewer assets ). Defaults to default.jpg . \"type\": \"<Type>\", The background layer type, i.e. wms or wmts . \"attribution\": \"<Attribution>\", Optional, attribution which will be shown in the bottom right corner of the map. \"attributionUrl\": \"<URL>\", Optional, link associated to the attribution \"group\": \"<GroupId>\", Optional, a group ID string. Background layers with the same group ID will be grouped together in the background switcher. \"minScale\": <min_scale>, Optional, minimum scale denominator from which to render the layer. \"maxScale\": <max_scale>, Optional, maximum scale denominator from which to render the layer. <Layer params> Parameters according to the specified layer type. Refer to the sample themesConfig.json for some examples. Note : You can use the helper python script located at qwc2/scripts/wmts_config_generator.py to easily generate WMTS background layer configurations. Alternatively, WMS and WMTS background layers can also be defined specifiying a resource identifier, which will then be resolved at runtime. For example: { \"name\":\"ch.swisstopo.pixelkarte-grau\", \"title\":\"National map (gray)\", \"resource\": \"wmts:https://wmts10.geo.admin.ch/EPSG/2056/1.0.0/WMTSCapabilities.xml#ch.swisstopo.pixelkarte-grau\", \"thumbnail\":\"img/mapthumbs/default.jpg\" } A background layer definition can also be a group of layers, in the format { \"name\": \"<Name>\", \"title\": \"<Title>\", \"type\": \"group\", \"items\": [ { <BackgroundLayerDefinition> }, { <BackgroundLayerDefinition> }, ... ] } Instead of specifiying a full background layer definition in a group, you can also reference an existing one with \"ref\": \"<bg_layer_name>\" , and selectively override certain properties, such as minScale and maxScale : { ... \"items\": [ { \"ref\": \"<bg_layer_name>\", \"minScale\": <min_scale>, \"maxScale\": <max_scale> }, ... ] } Generating the themes configuration The file ultimately read by the QWC2 viewer is the themes.json configuration, which includes the contents of themesConfig.json completed with additional data obtained from the QGIS Project. When using qwc-docker , you can generate the themes from the qwc-admin-gui administration backend, running on http://localhost:8088/qwc_admin by default. Log in as admin user, then press the green Generate service configuration button. This will invoce the qwc-config-generator , which will generate mapViewerConfig.json located below qwc-docker/volumes/config/<tentant> . You can then inspect the generated themes.json at http://localhost:8088/themes.json . When using QWC2 as a standalone viewer, the themes.json can be generated by invoking yarn run themesconfig Note: this command is automatically invoked when starting the development server via yarn start . If working in an environment without node, using the equivalent command python3 qwc2/scripts/themesConfig.py If you want to manage multiple themesConfig.json files, you can specify which while should be processed by the theme generation script via the QWC2_THEMES_CONFIG environment variable. Storing projects in database When you are using qwc-docker , you can configure QWC to read the QGIS projects directly from the database. To do this, proceed as follows: Set up a PostgreSQL database connection in QGIS, checking the \"Allow saving/loading QGIS projects in the database\" option. Save the project to the configured database in QGIS using Project \u2192 Save To \u2192 PostgreSQL. Add a qgisprojects service definition for the used database to qwc-docker/pg_service.conf . Write a theme configuration entry in themesConfig.json using with \"url\": \"/ows/pg/<schema>/<projectname>\" , where schema and projectname as as specified when saving the project in QGIS. Split categorized layers When using qwc-docker , the qwc-config-generator has the ability to split a layer that has been classified with QGIS into multiple layers and move them into a new group (the group name will be the original layer name). To activate this functionality, follow these steps: Place the projects whose layers you want to split below qwc-docker/volumes/config-in/<tenant>/qgis_projects . In the topolevel config in qwc-docker/volumes/config-in/<tenant>/tenantConfig.json , ensure qgis_projects_gen_base_dir is set and valid, and set \"split_categorized_layers\": true . For all layers that you want to split, create the variable convert_categorized_layer and set it to true . Generate the themes configuration . The qwc-config-generator will process the projects and write the modified projects to qgis_projects_gen_base_dir . Note: Make sure you are using qwc-config-generator:v<version> and not qwc-config-generator:v<version>-noqgis .","title":"Themes"},{"location":"configuration/ThemesConfiguration/#themes-configuration","text":"A theme corresponds to a QGIS project, published as WMS and served by QGIS Server. The basic steps for configuring a theme are: Create a QGIS project and deploy it to QGIS Server Writing the QWC2 theme configuration Generating the themes configuration","title":"Themes configuration"},{"location":"configuration/ThemesConfiguration/#creating-and-publishing-a-qgis-project","text":"The first step is to prepare a QGIS project for publishing. Besides the common tasks of adding and styling layers, the following table gives an overview of settings which influence how the theme is displayed in QWC2: What Where Description Service Metadata Project Properties \u2192 QGIS Server \u2192 Service capabilities Shown in the theme info dialog, invokable from the Layer Tree panel titlebar. Title, keywords Project Properties \u2192 QGIS Server \u2192 Service capabilities Theme title, displayed in the Theme Switcher, and keywords, useful for filtering. Map extent Project Properties \u2192 QGIS Server \u2192 WMS \u2192 Advertised extent The extent used as initial map extent when loading the theme, unless overridden in themesConfig.json . Queryable layers Project Properties \u2192 Data sources Mark layers as identifyable by the client. FeatureInfo geometry Project Properties \u2192 QGIS Server \u2192 WMS Capabilities \u2192 Add geometry to feature response Return feature geometries with the GetFeatureInfo request. Allows the client to highlight the selected features. Layer Display Field Vector Layer Properties \u2192 Display The field used in the identify results. Layer Map Tip Vector Layer Properties \u2192 Display The contents of the Map Tip shown when hovering over layers in the client, if displaying Map Tips is enabled in the Layer Tree. Layer Metadata Layer Properties \u2192 QGIS Server Shown in the client Layer Info dialog, invokable from the Layer Tree. Scale range Layer Properties \u2192 Rendering \u2192 Scale dependent visibility The scale range within which a layer is visible, useful to improve rendering performance. Initial visibility Layers Panel Initial visibility of layers and groups. Rendering order Layer Order Panel or Layers Panel Rendering order of the layers. If layer re-ordering is enabled in config.json , the order from the Layer Order Panel is ignored. Print layouts Layout manager The print layouts offered in the Print plugin. Print layout labels Layout manager Print layout labels with an ID will be exposed in the Print plugin. Note: a label ID starting with __ will not be exposed. Attribute form Vector Layer Properties \u2192 Attributes Form The configured attribute form will be displayed when editing in QWC2. External layers Layer Properties \u2192 QGIS Server \u2192 Data URL Mark the layer as an external layer to avoid cascaded requests. See Configuring external layers . Then, store the project in the publishing directory of your QGIS Server instance. When using qwc-docker , store the project as *.qgs below qwc-docker/volumes/qgs-resources . Alternatively, when using qwc-docker , you can also store the project in a database in QGIS using Project \u2192 Save To \u2192 PostgreSQL (see Storing projects in database ).","title":"Creating and publishing a QGIS project"},{"location":"configuration/ThemesConfiguration/#ensuring-valid-datasources","text":"A common issue is that the project will reference datasources in locations which cannot be resolved when QGIS Server reads the project, in particular when running QGIS Server inside a docker container. To avoid such issues: Make sure that any file-based resources are located on the same level or below the level of the *.qgs project file. Remember to copy all resources along with the *.qgs project file to the server. Load any PostgreSQL datasource in QGIS using a service, and make sure the service definition exists both in the pg_service.conf on your host system as well as in the qwc_docker/pg_service.conf and qwc_docker/pg_service-write.conf which are mounted inside the docker containers. For instance, to use default qwc-docker database, use the qwc_geodb service and add the service definition to your host pg_service.conf as follows: [qwc_geodb] host=localhost port=5439 dbname=qwc_demo user=qwc_service password=qwc_service sslmode=disable","title":"Ensuring valid datasources"},{"location":"configuration/ThemesConfiguration/#configuring-the-themes-in-themesconfigjson","text":"The next step is to configure the theme for QWC2. There are two approaches: Automatic theme configuration (only when using qwc-docker ): Just copy the project file to the designated location and the qwc-config-generator will automatically generate a theme configuration using default parameters. Manual theme configuration : Manually configure a theme with the full set of configuration options.","title":"Configuring the themes in themesConfig.json "},{"location":"configuration/ThemesConfiguration/#automatic-theme-configuration","text":"When using qwc-docker , save your QGIS projects below qwc-docker/volumes/qgs-resources/scan . Adjust the default settings ( defaultMapCrs , defaultBackgroundLayers , etc.) as desired in qwc-docker/volumes/config-in/<tentant>/themesConfig.json . Then generate the theme configuration . You can configure an automatically configured theme as default theme by setting defaultTheme in themesConfig.json to the path to the QGIS project file below qwc-docker/volumes/qgs-resources , without the .qgs extension. For example to set qwc-docker/volumes/qgs-resources/scan/project.qgs as default theme, you'd write ... \"defaultTheme\": \"scan/project\" ... To use a custom thumbnail for an automatically configured theme, place a an image called <project_basename>.png in qwc-docker/volumes/qwc2/assets/img/mapthumbs . For example. if the project is called project_name.qgs , the name thumbnail image would be named project_name.png . Note: The auto-scan directory can be is controlled by qgis_projects_scan_base_dir in qwc-docker/volumes/config-in/<tentant>/themesConfig.json .","title":"Automatic theme configuration "},{"location":"configuration/ThemesConfiguration/#manual-theme-configuration","text":"The theme configuration file is located as follows: Standalone viewer: qwc2-app/themesConfig.json qwc-docker : qwc-docker/volumes/config-in/<tentant>/themesConfig.json Note : when using qwc-docker , the themes configuration may also be embedded as themesConfig directly in qwc-docker/volumes/config-in/<tentant>/tenantConfig.json . The themesConfig.json file contains a list of themes, optionally organized in groups, as well as a list of background layers: { \"themes\": { \"items\": [ { <ThemeDefinition> }, ... ], \"groups\": [ { \"title\": <Group title>, \"items\": [{ <ThemeDefinition> }, ...], \"groups\": [ { <Group> }, ...] }, ... ], \"externalLayers\": [ { <ExternalLayerDefinition> }, ... ], \"themeInfoLinks\": [ { <ThemeInfoLinkDefinition> }, ... ], \"backgroundLayers\": [ { <BackgroundLayerDefinition> }, ... ], }, \"defaultMapCrs\": \"<Default map crs, defaults to EPSG:3857>\", \"defaultBackgroundLayers\": \"<Default background layers, see theme definition below>\", \"defaultWMSVersion\": \"<Default WMS version, i.e. 1.3.0>\", \"defaultScales\": [<Scale denominators, see theme definition below>], \"defaultPrintScales\" [<Scale denominators, see theme definition below>], \"defaultPrintResolutions\": [<DPIs, see theme definition below>], \"defaultSearchProviders\": [<Search providers, see theme definition below>], \"defaultPrintGrid\": [<Print grid, see theme definition below>], \"defaultTheme\": \"<Default theme id>\" } Refer to the sample themesConfig.json for a complete example. The format of the theme definitions is as follows: Entry Description \"id\": \"<id>\", Theme identificator. Autogenerated if not specified. \"url\": \"<WMS URL>\", The address of desired WMS served by QGIS Server. \"mapCrs: \"<EPSG code>\", Optional, map projection, defaults to defaultMapCrs . \"title\": \"<Custom title>\", Optional, override WMS title. \"description\": \"<Description>\", Optional, an additional description to show below the theme title. \"thumbnail\": \"<Filename>\", Optional, image file in assets/img/mapthumbs (see Viewer assets ). If omitted, autogenerated via WMS GetMap. \"attribution\": \"<Attribution>\", Optional, attribution which will be shown in the bottom right corner of the map. \"attributionUrl\": \"<URL>\", Optional, link associated to the attribution \"scales\": [<Scale denominators>], List of denominators of allowed map scales. If omitted, defaults to defaultScales . \"printScales\": [<Scale denominators>], List of denominators of allowed print scales. If omitted, defaults to defaultPrintScales . \"printResolutions\": [<DPIs>], List of available print resolutions. If omitted, defaults to defaultPrintResolutions . \"printGrid\": [ List of grid scale-dependent grid intervals to use when printing. If omitted, defaults to defaultPrintGrid . \u2063 {\"s\": <Scale1>, \"x\": <Width1>, \"y\": <Height1>}, Keep this list sorted in descending order by scale denominator. \u2063 {\"s\": <Scale2>, \"x\": <Width2>, \"y\": <Height2>} In this example, {x: <Width2>, y: <Height2>} will be used for <Scale1> > Scale >= <Scale2> . ], \"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. \"printLabelForAttribution\": \"<ID>\", Optional, an ID of a print layout label to which the current attribution text (if any) will be written to when printing. \"printLabelConfig\": { Optional, configuration of the text input fields for print layout labels. \u2063 \"<LabelId>\": {\"rows\": <n>, \"maxLength\": <n>}, Height of the input field in rows and maximum number of allowed characters. }, \"extent\": [<xmin>, <ymin>, <xmax>, <ymax>], Optional, override theme extent. In mapCrs . \"tiled\": <boolean>, Optional, use tiled WMS, defaults to false . \"format\": \"<mimetype>\", Optional, the format to use for WMS GetMap. Defaults to image/png . \"externalLayers\": [{ Optional, external layers to use as replacements for internal layers, see below. \u2063 \"name\": \"<external_layer_name>\", Name of the external layer, matching a ExternalLayerDefinition , see below. \u2063 \"internalLayer\": \"<QGis_layer_name>\" Name of an internal layer, as contained in the QGIS project, to replace with the external layer. }], \"themeInfoLinks\": { Optional, custom links to additional resources, shown as a menu in the theme selector in the theme switcher.\\ \u2063 \"title\": \"<Menu title>\", An arbitrary string shown as title of the menu. \u2063 \"titleMsgId\": \"<Menu title msgID>\", Alternative to title , a message ID, translated through the translation files. \u2063 \"entries\": [<link_name>, ...] List of theme info link names, see below. }, \"backgroundLayers\": [{, Optional, list of available background layers, defaults to defaultBackgroundLayers . \u2063 \"name\": \"<Background layer name>\", Name of matching BackgroundLayerDefinition , see below. \u2063 \"printLayer\": \"<QGIS layer name>\"\\|[<list>], Optional, name of layer to use as matching background layer when printing. Alternatively, a list [{\"maxScale\": <scale>, \"name\": \"<QGis layer name>\"}, ..., {\"maxScale\": null, \"name\": \"<QGis 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. \u2063 \"visibility\": <boolean> , Optional, initial visibility of the layer when theme is loaded. \u2063 \"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). }], \"searchProviders\": [\"<Provider>\"], Optional, list of search providers, see Search providers . Defaults to defaultSearchProviders . \"minSearchScaleDenom\": <number>, Optional, minimum scale to enforce when zooming to search results. Takes precedence over value in config.json . \"featureReport\": { Optional, available feature report templates. \u2063 \"<LayerId>\": \"<TemplateID>\" WMS sublayer ID and associated template ID to pass to the featureReportService . }, \"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 . \"watermark\": { Optional, configuration of watermark to add to raster export images. \u2063 \"text\": \"<text>\", Arbitrary text. \u2063 \"texpadding\": <number>, Optional, padding between text and frame, in points. \u2063 \"fontsize\": <number>, Optional, font size. \u2063 \"fontfamily\": \"<Font family>\", Optional, font family. \u2063 \"fontcolor\": \"#RRGGBB\", Optional, font color. \u2063 \"backgroundcolor\": \"#RRGGBB\", Optional, frame background color. \u2063 \"framecolor\": \"#RRGGBB\", Optional, frame color. \u2063 \"framewidth\": <number>, Optional, frame width. }, \"collapseLayerGroupsBelowLevel\": <level>, Optional, layer tree level below which to initially collapse groups. By default the tree is completely expanded. \"skipEmptyFeatureAttributes\": <boolean>, Optional, whether to skip empty attributes in the identify results. Default is false . \"mapTips\": <boolean>\\|null, Optional, per-theme setting whether map-tips are unavailable ( null ), disabled by default ( false ) or enabled by default ( true ). \"extraLegendParameters\": \"<&KEY=VALUE>\", Optional, additional query parameters to append to GetLegendGraphic request. \"extraDxfParameters\": \"<&KEY=VALUE>\", Optional, additional query parameters to append to DXF export request. \"extraPrintParameters\": \"<&KEY=VALUE>\", Optional, additional query parameters to append to GetPrint request (requires QGIS Server >= 3.32.0). \"printLabelBlacklist\": [\"<LabelId>\", ...] Optional, list of composer label ids to not expose in the print dialog. \"editConfig\": \"<editConfig.json>\" Optional, object or path to a filename containing the editing configuration for the theme, see Editing . \"snapping\": {...}, Optional, snapping configuration, see Snapping . \"config\": { Optional, per-theme configuration entries which override the global entries in config.json , see Viewer Configuration . \u2063 \"allowRemovingThemeLayers\": <boolean> See config.json for which settings can be specified here. \u2063 ... } \"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 . \u2063 \"username\": <username> Optional: http basic authentication username. \u2063 \"password\": <password> Optional: http basic authentication password. }, A bare minimum theme entry might look as follows: { \"id\": \"theme_id\", \"title\": \"My theme\", \"url\": \"/ows/my_theme\", \"mapCrs\": \"EPSG:3857\", \"backgroundLayers\": [{\"name\": \"background_layer_name\"}], \"searchProviders\" [\"coordinates\"] } Note: The theme identifier id can be freely defined and will appear in the viewer URL as the t query parameter. When using qwc-docker , the url can be specified as /ows/<relative_path_to_qgs> where relative_path_to_qgs is the path to the QGIS project file below qwc-docker/volumes/qgs-resources , without the .qgs extension. In the above sample, the project file would be located at qwc-docker/volumes/qgs-resources/my_theme.qgs .","title":"Manual theme configuration "},{"location":"configuration/ThemesConfiguration/#external-layers","text":"External layers can be used to selectively replace layers in a QGIS project with a layer from an external source, for instance in the case of a WMS layer embedded in a QGIS project, to avoid cascading WMS requests. They are handled transparently by QWC2 (they are positioned in the layer tree identically to the internal layer they replace), but the GetMap and GetFeatureInfo requests are sent directly to the specified WMS Service. Configuring external layers via Data Url The simplest way to define an external layer is to set the \"Data Url\" for a layer in QGIS (Layer Properties \u2192 QGIS Server \u2192 Data Url) to a string of these forms wms:<service_url>?<options>#<layername> wmts:<capabilities_url>?<options>#<layername> For instance: wms:http://wms.geo.admin.ch?tiled=false&infoFormat=application/geojson#ch.are.bauzonen wmts:https://wmts10.geo.admin.ch/EPSG/2056/1.0.0/WMTSCapabilities.xml#ch.swisstopo.swissboundaries3d-gemeinde-flaeche.fill Note: Support for WMTS in Data Url is currently only implemented when using qwc-docker . Note: You can pass parameters which control the behaviour of the WMS client in QGIS Server by prefexing the parameters with extwms. when the layer is requested by QGIS Server, i.e. when printing. Example to override the step width/heigth of the QGIS WMS Client: wms:http://wms.geo.admin.ch?extwms.stepWidth=4096&extwms.stepHeight=4096#ch.swisstopo.pixelkarte-farbe-pk1000.noscale Manually configuring external layers Rather than settin the \"Data Url\", you can provide a manual configuration in externalLayers in themesConfig.json as follows: Entry Description { \u2063 \"name\": \"<external_layer_name>\", The name of the external layer, as referenced in the theme definitions. \u2063 \"type\": \"<layer_type>\", Layer type, \"wms\" or \"wmts\" \u2063 \"url\": \"<wms_baseurl>\", The WMS URL or WMTS resource URL for the external layer. } For external WMS layers, the following additional parameters apply: Entry Description \"params\": { Parameters for the GetMap request. \u2063 \"LAYERS\": \"<wms_layername>,...\" , WMS layer names. \u2063 \"OPACITIES\": \"<0-255>,...\" Optional, if WMS server supports opacities. }, \"featureInfoUrl\": \"<wms_featureinfo_baseurl>\", Optional, base URL for WMS GetFeatureInfo, if different from url . \"legendUrl\": \"<wms_legendgraphic_baseurl>\" , Optional, base URL for WMS GetLegendGraphic, if different from url . \"queryLayers\": [\"<wms_featureinfo_layername>\", ...], Optional, list of GetFeatureInfo query layers, if different from params.LAYERS . \"infoFormats\": [\"<featureinfo_format>\", ...] List of GetFeatureInfo query formats which the WMS service supports. For external WMTS layers, the following additional parameters apply (you can use the qwc2/scripts/wmts_config_generator.py script to obtain these values): Entry Description \"tileMatrixSet\": \"<tile_matrix_set_name>\", The name of the tile matrix set. \"originX\": <origin_x>, The X origin of the tile matrix. \"originY\": <origin_y>, The Y origin of the tile matrix. \"projection\": \"EPSG:<code>\", The layer projection. \"resolutions\": [<resolution>, ...], The list of WMTS resolutions. \"tileSize\": [<tile_width>, <tile_height>] The tile width and height.","title":"External layers "},{"location":"configuration/ThemesConfiguration/#theme-info-links","text":"You can specify links to display in an info-menu next to the respective theme title in the theme switcher entries. The format for the theme info links is as follows: Entry Description \"name\": \"<link_name>\", The name of the link, as referenced in the theme definitions. \"title\": \"<link_title>\", The title for the link, as displayed in the info menu of the theme entry in the theme switcher. \"url\": \"<link>\", A link URL. \"target\": \"<link_target>\" The link target, i.e. _blank .","title":"Theme info links"},{"location":"configuration/ThemesConfiguration/#background-layers","text":"Background layers are handled completely client-side and do not appear in the layer tree. The format of the background layer definitions is as follows: Entry Description \"name\": \"<Name>\", The name of the background layer, used in the theme definitions. \"title\": \"<Title>\", The title of the background layer, as displayed in the background switcher. \"titleMsgId\": \"<Title msgID>\", Alternative to title , a message ID, translated through the translation files. \"thumbnail\": \"<Filename>\", Optional, image file in assets/img/mapthumbs (see Viewer assets ). Defaults to default.jpg . \"type\": \"<Type>\", The background layer type, i.e. wms or wmts . \"attribution\": \"<Attribution>\", Optional, attribution which will be shown in the bottom right corner of the map. \"attributionUrl\": \"<URL>\", Optional, link associated to the attribution \"group\": \"<GroupId>\", Optional, a group ID string. Background layers with the same group ID will be grouped together in the background switcher. \"minScale\": <min_scale>, Optional, minimum scale denominator from which to render the layer. \"maxScale\": <max_scale>, Optional, maximum scale denominator from which to render the layer. <Layer params> Parameters according to the specified layer type. Refer to the sample themesConfig.json for some examples. Note : You can use the helper python script located at qwc2/scripts/wmts_config_generator.py to easily generate WMTS background layer configurations. Alternatively, WMS and WMTS background layers can also be defined specifiying a resource identifier, which will then be resolved at runtime. For example: { \"name\":\"ch.swisstopo.pixelkarte-grau\", \"title\":\"National map (gray)\", \"resource\": \"wmts:https://wmts10.geo.admin.ch/EPSG/2056/1.0.0/WMTSCapabilities.xml#ch.swisstopo.pixelkarte-grau\", \"thumbnail\":\"img/mapthumbs/default.jpg\" } A background layer definition can also be a group of layers, in the format { \"name\": \"<Name>\", \"title\": \"<Title>\", \"type\": \"group\", \"items\": [ { <BackgroundLayerDefinition> }, { <BackgroundLayerDefinition> }, ... ] } Instead of specifiying a full background layer definition in a group, you can also reference an existing one with \"ref\": \"<bg_layer_name>\" , and selectively override certain properties, such as minScale and maxScale : { ... \"items\": [ { \"ref\": \"<bg_layer_name>\", \"minScale\": <min_scale>, \"maxScale\": <max_scale> }, ... ] }","title":"Background layers"},{"location":"configuration/ThemesConfiguration/#generating-the-themes-configuration","text":"The file ultimately read by the QWC2 viewer is the themes.json configuration, which includes the contents of themesConfig.json completed with additional data obtained from the QGIS Project. When using qwc-docker , you can generate the themes from the qwc-admin-gui administration backend, running on http://localhost:8088/qwc_admin by default. Log in as admin user, then press the green Generate service configuration button. This will invoce the qwc-config-generator , which will generate mapViewerConfig.json located below qwc-docker/volumes/config/<tentant> . You can then inspect the generated themes.json at http://localhost:8088/themes.json . When using QWC2 as a standalone viewer, the themes.json can be generated by invoking yarn run themesconfig Note: this command is automatically invoked when starting the development server via yarn start . If working in an environment without node, using the equivalent command python3 qwc2/scripts/themesConfig.py If you want to manage multiple themesConfig.json files, you can specify which while should be processed by the theme generation script via the QWC2_THEMES_CONFIG environment variable.","title":"Generating the themes configuration "},{"location":"configuration/ThemesConfiguration/#storing-projects-in-database","text":"When you are using qwc-docker , you can configure QWC to read the QGIS projects directly from the database. To do this, proceed as follows: Set up a PostgreSQL database connection in QGIS, checking the \"Allow saving/loading QGIS projects in the database\" option. Save the project to the configured database in QGIS using Project \u2192 Save To \u2192 PostgreSQL. Add a qgisprojects service definition for the used database to qwc-docker/pg_service.conf . Write a theme configuration entry in themesConfig.json using with \"url\": \"/ows/pg/<schema>/<projectname>\" , where schema and projectname as as specified when saving the project in QGIS.","title":"Storing projects in database "},{"location":"configuration/ThemesConfiguration/#split-categorized-layers","text":"When using qwc-docker , the qwc-config-generator has the ability to split a layer that has been classified with QGIS into multiple layers and move them into a new group (the group name will be the original layer name). To activate this functionality, follow these steps: Place the projects whose layers you want to split below qwc-docker/volumes/config-in/<tenant>/qgis_projects . In the topolevel config in qwc-docker/volumes/config-in/<tenant>/tenantConfig.json , ensure qgis_projects_gen_base_dir is set and valid, and set \"split_categorized_layers\": true . For all layers that you want to split, create the variable convert_categorized_layer and set it to true . Generate the themes configuration . The qwc-config-generator will process the projects and write the modified projects to qgis_projects_gen_base_dir . Note: Make sure you are using qwc-config-generator:v<version> and not qwc-config-generator:v<version>-noqgis .","title":"Split categorized layers"},{"location":"configuration/ViewerConfiguration/","text":"QWC2 Viewer Configuration This chapter describes how to customize the QWC2 viewer. First of all, it is important to keep in mind that the QWC2 Viewer is designed to be a modular and highly customizeable application. Configuration falls into three categories: Load-time configuration : configuration applied when the application is loaded. Customizing the assets : specify additional search providers, customize the color schemes, etc... Compiling a custom viewer : configure which components which are built into the application, add own plugins, etc... The qwc2-demo-app (and the qwc-map-viewer-demo docker image) serve as a good starting point, and for simple viewers the load-time configuration options are often sufficient to avoid the need of building a customized application. Load-time configuration config.json The load-time configuration config.json configuration file contains global viewer settings as well as the viewer plugin configuration for mobile and desktop devices. It is located as follows: qwc-docker : qwc-docker/volumes/config-in/<tentant>/config.json Standalone viewer: qwc2-app/static/config.json Refer to the sample config.json for a concrete example. Global settings All settings are optional, with fallback to the default values as documented. Setting Description assetsPath Relative path to the assets folder. Default value: assets . translationsPath Relative path to the translations folder. Default value: translations . loadTranslationOverrides Whether to attempt to load tanslation overrides, see translations . Default value: false . urlPositionFormat How to encode the current map extent in the URL, either centerAndZoom or extent . See URL parameters for details. Default value: extent . urlPositionCrs The CRS used to encode the current map extent coordinates in the URL. Default value: the map projection. omitUrlParameterUpdates Whether to omit updating the URL parameters. Default value: false . defaultFeatureStyle The default style to use for selection geometries and other unstyled features. Default value: see qwc2/utils/FeatureStyles.js . defaultMarkerStyle The default style to use as marker icon. Default value: see qwc2/utils/FeatureStyles.js . defaultInteractionStyle The default style to use on geometries to measure, snap or edit. Default value: see qwc2/utils/FeatureStyles.js . 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. allowFractionalZoom Whether to allow arbitrary scales for viewing the map. Default value: false . localeAwareNumbers Whether to use locale aware numbers throughout. Default value: false . wmsHidpi Whether to honour the device pixel ratio for WMS GetMap requests. Default value: true . wmsMaxGetUrlLength URL length limit before switching to a POST request for GetMap and GetFeatureInfo. Default: 2048. qgisServerVersion The QGIS Server major version in use, defaults to 3 . defaultColorScheme The color scheme to use. See Color schemes for details. startupTask Task to automatically aktivate on application start, in the format {key: \"<Task>\", \"mode\": \"<Mode>\"} . 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). Global settings, overridable per theme The following options can be specified globally, and also overriden per theme, see themesConfig.json . All settings are optional, with fallback to the default values as documented. Setting Description preserveExtentOnThemeSwitch Whether to preserve the current map extent when switching theme, if possible (see below). Default value: false . preserveBackgroundOnThemeSwitch Whether to preserve the current background layer when switching theme, if possible. Default value: false . preserveNonThemeLayersOnThemeSwitch Whether to preserve non-theme layers when switching theme. Default value: false . allowReorderingLayers Whether to allow re-ordering layers in the layer tree. Default value: false . flattenLayerTreeGroups Whether to display a flat layer tree, omitting the groups. Default value: false . allowLayerTreeSeparators Allows users to add separator items in a flat layer tree. Default value: false . preventSplittingGroupsWhenReordering Whether to prevent splitting sibling groups or the group itself when reordering items. Default value: false . allowRemovingThemeLayers Whether to allow removing any theme layers from the layer tree. Default value: false . searchThemes Whether allow searching for themes from the global search field. Default value: false . allowAddingOtherThemes Whether to allow adding another theme to a currently loaded theme. Default value: false . disableImportingLocalLayers Whether to hide the option to import local layers from the layer tree. Default value: false . 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>\"} . identifyTool The name of the identify plugin to use. It is possible to have multiple identify tools, and i.e. on a per-theme basis select which one is active. Default value: Identify . globallyDisableDockableDialogs Whether to globally disable the dockable feature of popup dialogs. Default value: false . globallyDisableMaximizeableDialogs Whether to globally disable the maximizeable feature of popup dialogs. Default value: false . Note: The layer tree supports re-ordering layers via drag-and-drop if allowReorderingLayers = true and either preventSplittingGroupsWhenReordering = true or flattenLayerTreeGroups = true . If preserveExtentOnThemeSwitch = true , the current extent is preserved if it is within the new theme extent and if the current theme map projection is equal to the new theme projection. If preserveExtentOnThemeSwitch = \"force\" , the current extent is preserved regardless of whether it is within the new theme extent, but the current and new theme map projections must still match. URLs of external services Some plugins require external services (typically part of the qwc-services ecosystem). When using the qwc-docker , these configuration entries will be automatically injected into the config.json for enabled services. Setting Description authServiceUrl Typically the URL of a QWC authentication service like qwc-db-auth . editServiceUrl Typically the URL of the qwc-data-service . elevationServiceUrl Typically the URL of the qwc-elevation-service . mapInfoService Typically the URL of the qwc-map-info-service . permalinkServiceUrl Typically the URL of the qwc-permalink-service . searchServiceUrl Typically the URL of the qwc-fulltext-search-service . featureReportService Typically the URL of the qwc-document-service . Plugin configuration The plugin configuration is entered as follows: \"plugins\": { \"common\": [{<PluginConfig>}, ...], \"mobile\": [{<PluginConfig>}, ...], \"desktop\": [{<PluginConfig>}, ...] } The final mobile and desktop configurations will be computed by merging the common configuration with the respective specific configuration. Each <PluginConfig> block is of the format Setting Description { \u2063 \"name\": \"<name>\", The plugin name. \u2063 \"cfg\": {...}, The plugin configuration options, see plugin reference . \u2063 \"mapClickAction\": <\"identify\"|\"unset\"|null>, Optional: in case the plugin activates a viewer task, determines whether a click in the map will result in the identify tool being invoked, the task being unset, or whether no particular action should be performed (default). } A particularly interesting aspect is the configuration of the entries in the application menu and toolbar, i.e. the entries in menuItems and toolbarItems in the TopBar plugin configuration. The format of these entries is as follows: Setting Description { \u2063 \"key\": \"<key>\", The name of a plugin, i.e. LayerTree . The label for the entry will be looked up from the translations using the appmenu.items.<key> message identifier (see Managing translations ). \u2063 \"icon\": \"<icon>\", The icon of the entry, either a built-in icon name (see below), or :/<path_to_asset> containing the path relative to assetsPath of an asset image. \u2063 \"themeBlacklist\": [\"<themename>\", ...], Optional, allows specifying a blacklist of theme names or titles for which the entry should not be visible. \u2063 \"themeWhitelist\": [\"<themename>\", ...], Optional, allows specifying a whitelist of theme names or titles for which the entry should be visible. \u2063 \"mode\": \"<mode>\", Optional, depending on the plugin, a mode can be configured to launch the plugin directly in a specific mode. For instance, the Measure plugin supports specifying the measurement mode ( Point , LineString , Polygon ). \u2063 \"requireAuth\": \"<true|false>\", Optional, the entry is only visible when user is logged-in. \u2063 \"shortcut\": \"<shortcut>\" Optional, keyboard shortcut which triggers the entry, i.e. \"alt+shift+a\" . } Note: The built-in icons are those located in qwc2-app/qwc2/icons and in qwc2-app/icons . The built-in icon names are the respective file names, without .svg extension. Opening external websites As a special case, entries for opening external URLs can be defined as follows: Setting Description { \u2063 \"key\": \"<key>\", An arbitrary key (not used by existing plugins), used to lookup the label for the entry from the translations. \u2063 \"icon\": \"<icon>\", As above. \u2063 \"url\": \"<url>\", The URL to open. Can contain as placeholders the keys listed in URL Parameters , encolsed in $ (i.e. $e$ for the extent). In addition, the placeholders $x$ and $y$ for the individual map center coordinates are also supported. \u2063 \"target\": \"<target>\" The target where to open the URL, if empty, _blank is assumed. Can be iframe to open the link in a iframe window inside QWC2. } In general, the procedure for enabling a plugin is: Make sure the plugin is compiled into the application (see Build-time configuration ). In the plugins section of config.json , below common (or mobile and/or desktop ), add an entry { \"name\": \"<Plugin name>\", \"cfg\": { <Plugin configuration props> } } For most plugins (i.e. those which launch as an explicit task in the viewer), add entries in menuItems and/or toolbarItems as desired, i.e. \"menuItems\": [ ... {\"key\": \"<Plugin name>\", \"icon\": \"<icon name>\", ...} ] Customizing the viewer assets The viewer assets are located as follows: Standalone viewer: qwc2-app/static/assets qwc-docker : qwc-docker/volumes/qwc2/assets The default structure of the assets folder is as follows: Path Description \u2514\u2500 assets/ See Viewer assets \u251c\u2500 css/ Additional style sheets, must be included by index.html . \u2502 \u251c\u2500 colorschemes.css Additional color schemes. \u2502 \u2514\u2500 qwc2.css Additional style definitions. \u251c\u2500 img/ Application logo etc. \u2502 \u251c\u2500 genmapthumbs/ Autogenerated map thumbnails. \u2502 \u2514\u2500 mapthumbs/ Map thumbnails. \u251c\u2500 templates/ \u2502 \u2514\u2500 legendprint.html HTML template for the legend print. \u251c\u2500 help.html Help dialog fragment, see Help dialog . \u2514\u2500 searchProviders.js Additional search providers, see Search providers . Furthermore, the application entry point index.html is located as follows: Standalone viewer: qwc2-app/index.html qwc-docker : qwc-docker/volumes/config-in/<tenant>/index.html This file noteably specifies the application title, and references many of the assets located below the assets folder. Customizing the color scheme The QWC2 color scheme is fully customizeable via CSS. A default color-scheme is built-in (see DefaultColorScheme.css ). To define a custom color scheme, copy the default color scheme to assets/css/colorschemes.css , add an appropriate class name to the :root selector, and modify the colors as desided. Two additional examples ( highcontrast and dark ) are provided by default in assets/css/colorschemes.css . You can then modify the color scheme which is applied by default by setting defaultColorScheme in config.json to an appropriate class name (i.e. highcontrast or dark ). To change the color scheme at runtime in QWC2, make sure the Settings plugin is enabled, and in the Settings plugin configuration block in config.json list the color schemes below colorSchemes . Refer to the sample config.json . Note : When changing the color scheme via Settings dialog in QWC2, the picked color scheme is stored in the browser local storage, and this setting will override the defaultColorScheme setting from config.json. Specifying the style` URL-parameter (see URL parameters ) will take precedence over all other settings. Note: Make sure that assets/css/colorschemes.css is included in index.html . Overriding component styles Occasionally, it may be desired to customize the styling on the QWC2 components. The recommended approach is to add the corresponding style overrides to assets/css/qwc2.css . Note: Make sure that assets/css/qwc2.css is included in index.html . Customizing the application logo The application logo in its various shapes and sizes are located below assets/img/ . In particular, the logo.svg and logo-mobile.svg images are displayed as in the top left corner of QWC2 in desktop and mobile mode respectively. If you'd like to use another format than SVG (while keeping logo and logo-mobile as base name), you can change logoFormat in the TopBar configuration block in config.json . Providing custom map thumbnails By default, when generating the themes configuration (see [ThemesConfiguration.md#generating-theme-configuration]), a default map thumbnail is generating via WMS GetMap , and placed below assets/img/genmapthumbs . You can provide your own thumbnail images instead by placing the corresponding images below assets/img/mapthumbs and referencing these as thumbnail in you theme configuration block in themesConig.json . Personalizing the help dialog You can personalize the help dialog by providing a plain HTML document fragment in static/assets/help.html and configuring the Help plugin accordingly in config.json : { \"name\": \"Help\", \"cfg\": { \"bodyContentsFragmentUrl\": \"assets/help.html\" } } Note: $VERSION$ can be used in the HTML document fragment as a placeholder for the application build date. Personalizing the legend print template The legend print template assets/templates/legendprint.html is used when printing the map legend from the layer tree. The only requirement for this template is that is must contain a <div id=\"legendcontainer\"></div> element. Building a custom viewer QWC2 is divided into two repositories: The QWC2 components, hosted at https://github.com/qgis/qwc2/ . This repository contains the core building blocks common to all QWC2 applications. The QWC2 application, the demo application is hosted at https://github.com/qgis/qwc2-demo-app . To build a custom viewer, the first step is cloning the demo application: git clone --recursive https://github.com/qgis/qwc2-demo-app.git qwc2-app The typical layout of a QWC2 app source tree is as follows: Path Description \u251c\u2500 static/ \u2502 \u251c\u2500 assets/ See Viewer assets \u2502 \u251c\u2500 translations/ Translation files. \u2502 \u251c\u2500 config.json Master configuration file. \u2502 \u2514\u2500 themes.json Full theme configuration, autogenerated from themesConfig.json . \u251c\u2500 js/ \u2502 \u251c\u2500 app.jsx Entry point of the ReactJS application. \u2502 \u251c\u2500 appConfig.js Configuration of the qwc2 core modules. \u2502 \u251c\u2500 Help.jsx Built-in component of custom Help dialog, see Help dialog . \u2502 \u2514\u2500 SearchProviders.js Built-in custom search providers, see Search providers . \u251c\u2500 icons/ Application icons. \u251c\u2500 qwc2/ Git submodule containing the core qwc2 components. \u251c\u2500 index.html Entry point. \u251c\u2500 package.json NodeJS configuration file. \u251c\u2500 themesConfig.json Themes configuration. \u2514\u2500 webpack.config.js Webpack configuration. Application build-time configuration The js/appConfig.js is the the principal build-time configuation file, and defines: - The default application locale, built into the application. This locale is used if no available locale matches the browser locale. - Which plugins are built into the application. Plugins left out here will be completely omitted when compiling the application bundle, and will hence also reduce the size of the bundle. - Various hook functions, as documented in the sample sample js/appConfig.js . Refer to the sample appConfig.js for a concrete example. Overriding icons The common application icons are located in qwc2/icons . They can be overridden by creating an icon with the same filename in the application specific icons folder. Note : The icons in the icons folder are compiled into an icon font. The icons need to be black content on transparent background, and all drawings (including texts) must be converted to paths for the icons to render correctly. Compiling an application bundle After tweaking the source files as desired, compile a deployable application bundle for production running yarn run prod When using qwc-docker , copy the contents of the qwc2-app/prod folder to qwc-docker/volumes/qwc2 and edit the qwc-docker/docker-compose.yml to use qwc-map-viewer-base with your custom build: qwc-map-viewer: image: sourcepole/qwc-map-viewer-base:vYYYY.MM.DD environment: <<: *qwc-service-variables SERVICE_MOUNTPOINT: '/' volumes: - ./pg_service.conf:/srv/pg_service.conf:ro - ./volumes/config:/srv/qwc_service/config:ro - ./volumes/qwc2:/qwc2:ro Keeping the QWC2 application up to date As mentioned above, QWC2 is split into a common components repository and an application specific repository. The goal of this approach is to cleanly separate user-specific configuration and components which common components which serve as a basis for all QWC2 applications, and to make it as easy as possible to rebase the application onto the latest common QWC2 components. The recommended workflow is to keep the qwc2 folder a submodule referencing the upstream qwc2 repository . To update it, just checkout/update the desired branch: cd qwc2 git checkout master # or git checkout YYYY-lts git pull The QWC2 Upgrade Notes documents major changes, and in particular all incompatible changes between releases which require changes to the application specific code and/or configuration. Translations This section gives an overview of the common tasks related to the QWC2 translations. Switching language By default, QWC2 will attempt to load the translation matching your browser language. Alternatively, you can explicitly specify the language by adding the lang=<lang> query parameter to the application URL, i.e. lang=de-CH . The Settings plugin furthermore allows graphically switching the language within QWC2. Adding and modify translations When working inside a qwc2-app source folder, the translations can be found on two levels: At QWC2 components level, in qwc2-app/qwc2/translations . At application level, in qwc2-app/static/translations . A script will take care of merging the component translations into the application translations. This way, when updating the QWC2 submodule, new translations are automatically obtained. This script is automatically invoked on yarn start , but can also be manually invoked using yarn run tsupdate Translations are stored inside the respective translations folder as regular plain-text JSON files, named <lang>.json and can be freely edited with any text editor. The tsconfig.json files stored inside the respective translations folder contains the list of languages for which translations should be generated and a list of message IDs to include in the translation. The tsupdate script will automatically scan the code for message IDs (looking for static strings passed to LocaleUtils.tr and LocaleUtils.trmsg ), store these in tsconfig.json and automatically create resp. update the translation files. In some cases tsconfig.json will not pick up a message ID (for instance, if it is computed at runtime). In these cases, the message IDs can be added manually to the extra_strings section of the tsconfig.json . Also it may be desired to override a translation inherited from the QWC2 components at application level. To prevent tsupdate from continuously reverting the overridden translation, the respective message IDs can be added to the overrides section in the application tsconfig.json file. To add a new language, list it in qwc2-app/qwc2/translations/tsconfig.json and run yarn run tsupdate , then complete the messages taking the english translation file as reference. When adding or modifying translations at QWC2 components level, please contribute them by submitting a pull request to the upstream qwc2 repository . Selectively overriding translation strings Occasionally, it is desireable to selectively override specific translation strinsg. While one can modify the full translation file as described above, especially when using the qwc-map-viewer-demo docker image, it is easier to just selectively override the desired translation strings and leave the original file unchanged and avoid having to compile a custom viewer (or overwriting the entire file with a docker volume mount). To do this: Set loadTranslationOverrides to true in config.json . Create a <lang>_overrides.json containing just the ovverridden strings, for example en-US_overrides.json : { \"messages\": { \"appmenu\": { \"items\": { \"LayerTree\": \"Layers\" } } } } Place this file inside the translations folder of your production build. When using qwc-docker , you can place this file in qwc-docker/volumes/qwc2/translations/ and mount this file inside the container, i.e. : qwc-map-viewer: image: sourcepole/qwc-map-viewer-demo:vYYYY.MM.DD [...] volumes: - ./volumes/qwc2/translations/en-US_overrides.json:/qwc2/translations/en-US_overrides.json:ro Specifying the default fallback translation When no translation exists for the requested language (i.e. the current browser language), QWC2 will fall back to the default translation specified as defaultLocaleData in qwc2-app/js/appConfig.js . For the demo viewer, the default fallback translation is en-US .","title":"Viewer"},{"location":"configuration/ViewerConfiguration/#qwc2-viewer-configuration","text":"This chapter describes how to customize the QWC2 viewer. First of all, it is important to keep in mind that the QWC2 Viewer is designed to be a modular and highly customizeable application. Configuration falls into three categories: Load-time configuration : configuration applied when the application is loaded. Customizing the assets : specify additional search providers, customize the color schemes, etc... Compiling a custom viewer : configure which components which are built into the application, add own plugins, etc... The qwc2-demo-app (and the qwc-map-viewer-demo docker image) serve as a good starting point, and for simple viewers the load-time configuration options are often sufficient to avoid the need of building a customized application.","title":"QWC2 Viewer Configuration"},{"location":"configuration/ViewerConfiguration/#load-time-configuration-configjson","text":"The load-time configuration config.json configuration file contains global viewer settings as well as the viewer plugin configuration for mobile and desktop devices. It is located as follows: qwc-docker : qwc-docker/volumes/config-in/<tentant>/config.json Standalone viewer: qwc2-app/static/config.json Refer to the sample config.json for a concrete example.","title":"Load-time configuration config.json"},{"location":"configuration/ViewerConfiguration/#global-settings","text":"All settings are optional, with fallback to the default values as documented. Setting Description assetsPath Relative path to the assets folder. Default value: assets . translationsPath Relative path to the translations folder. Default value: translations . loadTranslationOverrides Whether to attempt to load tanslation overrides, see translations . Default value: false . urlPositionFormat How to encode the current map extent in the URL, either centerAndZoom or extent . See URL parameters for details. Default value: extent . urlPositionCrs The CRS used to encode the current map extent coordinates in the URL. Default value: the map projection. omitUrlParameterUpdates Whether to omit updating the URL parameters. Default value: false . defaultFeatureStyle The default style to use for selection geometries and other unstyled features. Default value: see qwc2/utils/FeatureStyles.js . defaultMarkerStyle The default style to use as marker icon. Default value: see qwc2/utils/FeatureStyles.js . defaultInteractionStyle The default style to use on geometries to measure, snap or edit. Default value: see qwc2/utils/FeatureStyles.js . 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. allowFractionalZoom Whether to allow arbitrary scales for viewing the map. Default value: false . localeAwareNumbers Whether to use locale aware numbers throughout. Default value: false . wmsHidpi Whether to honour the device pixel ratio for WMS GetMap requests. Default value: true . wmsMaxGetUrlLength URL length limit before switching to a POST request for GetMap and GetFeatureInfo. Default: 2048. qgisServerVersion The QGIS Server major version in use, defaults to 3 . defaultColorScheme The color scheme to use. See Color schemes for details. startupTask Task to automatically aktivate on application start, in the format {key: \"<Task>\", \"mode\": \"<Mode>\"} . 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).","title":"Global settings"},{"location":"configuration/ViewerConfiguration/#global-settings-overridable-per-theme","text":"The following options can be specified globally, and also overriden per theme, see themesConfig.json . All settings are optional, with fallback to the default values as documented. Setting Description preserveExtentOnThemeSwitch Whether to preserve the current map extent when switching theme, if possible (see below). Default value: false . preserveBackgroundOnThemeSwitch Whether to preserve the current background layer when switching theme, if possible. Default value: false . preserveNonThemeLayersOnThemeSwitch Whether to preserve non-theme layers when switching theme. Default value: false . allowReorderingLayers Whether to allow re-ordering layers in the layer tree. Default value: false . flattenLayerTreeGroups Whether to display a flat layer tree, omitting the groups. Default value: false . allowLayerTreeSeparators Allows users to add separator items in a flat layer tree. Default value: false . preventSplittingGroupsWhenReordering Whether to prevent splitting sibling groups or the group itself when reordering items. Default value: false . allowRemovingThemeLayers Whether to allow removing any theme layers from the layer tree. Default value: false . searchThemes Whether allow searching for themes from the global search field. Default value: false . allowAddingOtherThemes Whether to allow adding another theme to a currently loaded theme. Default value: false . disableImportingLocalLayers Whether to hide the option to import local layers from the layer tree. Default value: false . 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>\"} . identifyTool The name of the identify plugin to use. It is possible to have multiple identify tools, and i.e. on a per-theme basis select which one is active. Default value: Identify . globallyDisableDockableDialogs Whether to globally disable the dockable feature of popup dialogs. Default value: false . globallyDisableMaximizeableDialogs Whether to globally disable the maximizeable feature of popup dialogs. Default value: false . Note: The layer tree supports re-ordering layers via drag-and-drop if allowReorderingLayers = true and either preventSplittingGroupsWhenReordering = true or flattenLayerTreeGroups = true . If preserveExtentOnThemeSwitch = true , the current extent is preserved if it is within the new theme extent and if the current theme map projection is equal to the new theme projection. If preserveExtentOnThemeSwitch = \"force\" , the current extent is preserved regardless of whether it is within the new theme extent, but the current and new theme map projections must still match.","title":"Global settings, overridable per theme"},{"location":"configuration/ViewerConfiguration/#urls-of-external-services","text":"Some plugins require external services (typically part of the qwc-services ecosystem). When using the qwc-docker , these configuration entries will be automatically injected into the config.json for enabled services. Setting Description authServiceUrl Typically the URL of a QWC authentication service like qwc-db-auth . editServiceUrl Typically the URL of the qwc-data-service . elevationServiceUrl Typically the URL of the qwc-elevation-service . mapInfoService Typically the URL of the qwc-map-info-service . permalinkServiceUrl Typically the URL of the qwc-permalink-service . searchServiceUrl Typically the URL of the qwc-fulltext-search-service . featureReportService Typically the URL of the qwc-document-service .","title":"URLs of external services"},{"location":"configuration/ViewerConfiguration/#plugin-configuration","text":"The plugin configuration is entered as follows: \"plugins\": { \"common\": [{<PluginConfig>}, ...], \"mobile\": [{<PluginConfig>}, ...], \"desktop\": [{<PluginConfig>}, ...] } The final mobile and desktop configurations will be computed by merging the common configuration with the respective specific configuration. Each <PluginConfig> block is of the format Setting Description { \u2063 \"name\": \"<name>\", The plugin name. \u2063 \"cfg\": {...}, The plugin configuration options, see plugin reference . \u2063 \"mapClickAction\": <\"identify\"|\"unset\"|null>, Optional: in case the plugin activates a viewer task, determines whether a click in the map will result in the identify tool being invoked, the task being unset, or whether no particular action should be performed (default). } A particularly interesting aspect is the configuration of the entries in the application menu and toolbar, i.e. the entries in menuItems and toolbarItems in the TopBar plugin configuration. The format of these entries is as follows: Setting Description { \u2063 \"key\": \"<key>\", The name of a plugin, i.e. LayerTree . The label for the entry will be looked up from the translations using the appmenu.items.<key> message identifier (see Managing translations ). \u2063 \"icon\": \"<icon>\", The icon of the entry, either a built-in icon name (see below), or :/<path_to_asset> containing the path relative to assetsPath of an asset image. \u2063 \"themeBlacklist\": [\"<themename>\", ...], Optional, allows specifying a blacklist of theme names or titles for which the entry should not be visible. \u2063 \"themeWhitelist\": [\"<themename>\", ...], Optional, allows specifying a whitelist of theme names or titles for which the entry should be visible. \u2063 \"mode\": \"<mode>\", Optional, depending on the plugin, a mode can be configured to launch the plugin directly in a specific mode. For instance, the Measure plugin supports specifying the measurement mode ( Point , LineString , Polygon ). \u2063 \"requireAuth\": \"<true|false>\", Optional, the entry is only visible when user is logged-in. \u2063 \"shortcut\": \"<shortcut>\" Optional, keyboard shortcut which triggers the entry, i.e. \"alt+shift+a\" . } Note: The built-in icons are those located in qwc2-app/qwc2/icons and in qwc2-app/icons . The built-in icon names are the respective file names, without .svg extension. Opening external websites As a special case, entries for opening external URLs can be defined as follows: Setting Description { \u2063 \"key\": \"<key>\", An arbitrary key (not used by existing plugins), used to lookup the label for the entry from the translations. \u2063 \"icon\": \"<icon>\", As above. \u2063 \"url\": \"<url>\", The URL to open. Can contain as placeholders the keys listed in URL Parameters , encolsed in $ (i.e. $e$ for the extent). In addition, the placeholders $x$ and $y$ for the individual map center coordinates are also supported. \u2063 \"target\": \"<target>\" The target where to open the URL, if empty, _blank is assumed. Can be iframe to open the link in a iframe window inside QWC2. } In general, the procedure for enabling a plugin is: Make sure the plugin is compiled into the application (see Build-time configuration ). In the plugins section of config.json , below common (or mobile and/or desktop ), add an entry { \"name\": \"<Plugin name>\", \"cfg\": { <Plugin configuration props> } } For most plugins (i.e. those which launch as an explicit task in the viewer), add entries in menuItems and/or toolbarItems as desired, i.e. \"menuItems\": [ ... {\"key\": \"<Plugin name>\", \"icon\": \"<icon name>\", ...} ]","title":"Plugin configuration"},{"location":"configuration/ViewerConfiguration/#customizing-the-viewer-assets","text":"The viewer assets are located as follows: Standalone viewer: qwc2-app/static/assets qwc-docker : qwc-docker/volumes/qwc2/assets The default structure of the assets folder is as follows: Path Description \u2514\u2500 assets/ See Viewer assets \u251c\u2500 css/ Additional style sheets, must be included by index.html . \u2502 \u251c\u2500 colorschemes.css Additional color schemes. \u2502 \u2514\u2500 qwc2.css Additional style definitions. \u251c\u2500 img/ Application logo etc. \u2502 \u251c\u2500 genmapthumbs/ Autogenerated map thumbnails. \u2502 \u2514\u2500 mapthumbs/ Map thumbnails. \u251c\u2500 templates/ \u2502 \u2514\u2500 legendprint.html HTML template for the legend print. \u251c\u2500 help.html Help dialog fragment, see Help dialog . \u2514\u2500 searchProviders.js Additional search providers, see Search providers . Furthermore, the application entry point index.html is located as follows: Standalone viewer: qwc2-app/index.html qwc-docker : qwc-docker/volumes/config-in/<tenant>/index.html This file noteably specifies the application title, and references many of the assets located below the assets folder.","title":"Customizing the viewer assets "},{"location":"configuration/ViewerConfiguration/#customizing-the-color-scheme","text":"The QWC2 color scheme is fully customizeable via CSS. A default color-scheme is built-in (see DefaultColorScheme.css ). To define a custom color scheme, copy the default color scheme to assets/css/colorschemes.css , add an appropriate class name to the :root selector, and modify the colors as desided. Two additional examples ( highcontrast and dark ) are provided by default in assets/css/colorschemes.css . You can then modify the color scheme which is applied by default by setting defaultColorScheme in config.json to an appropriate class name (i.e. highcontrast or dark ). To change the color scheme at runtime in QWC2, make sure the Settings plugin is enabled, and in the Settings plugin configuration block in config.json list the color schemes below colorSchemes . Refer to the sample config.json . Note : When changing the color scheme via Settings dialog in QWC2, the picked color scheme is stored in the browser local storage, and this setting will override the defaultColorScheme setting from config.json. Specifying the style` URL-parameter (see URL parameters ) will take precedence over all other settings. Note: Make sure that assets/css/colorschemes.css is included in index.html .","title":"Customizing the color scheme"},{"location":"configuration/ViewerConfiguration/#overriding-component-styles","text":"Occasionally, it may be desired to customize the styling on the QWC2 components. The recommended approach is to add the corresponding style overrides to assets/css/qwc2.css . Note: Make sure that assets/css/qwc2.css is included in index.html .","title":"Overriding component styles"},{"location":"configuration/ViewerConfiguration/#customizing-the-application-logo","text":"The application logo in its various shapes and sizes are located below assets/img/ . In particular, the logo.svg and logo-mobile.svg images are displayed as in the top left corner of QWC2 in desktop and mobile mode respectively. If you'd like to use another format than SVG (while keeping logo and logo-mobile as base name), you can change logoFormat in the TopBar configuration block in config.json .","title":"Customizing the application logo"},{"location":"configuration/ViewerConfiguration/#providing-custom-map-thumbnails","text":"By default, when generating the themes configuration (see [ThemesConfiguration.md#generating-theme-configuration]), a default map thumbnail is generating via WMS GetMap , and placed below assets/img/genmapthumbs . You can provide your own thumbnail images instead by placing the corresponding images below assets/img/mapthumbs and referencing these as thumbnail in you theme configuration block in themesConig.json .","title":"Providing custom map thumbnails"},{"location":"configuration/ViewerConfiguration/#personalizing-the-help-dialog","text":"You can personalize the help dialog by providing a plain HTML document fragment in static/assets/help.html and configuring the Help plugin accordingly in config.json : { \"name\": \"Help\", \"cfg\": { \"bodyContentsFragmentUrl\": \"assets/help.html\" } } Note: $VERSION$ can be used in the HTML document fragment as a placeholder for the application build date.","title":"Personalizing the help dialog "},{"location":"configuration/ViewerConfiguration/#personalizing-the-legend-print-template","text":"The legend print template assets/templates/legendprint.html is used when printing the map legend from the layer tree. The only requirement for this template is that is must contain a <div id=\"legendcontainer\"></div> element.","title":"Personalizing the legend print template"},{"location":"configuration/ViewerConfiguration/#building-a-custom-viewer","text":"QWC2 is divided into two repositories: The QWC2 components, hosted at https://github.com/qgis/qwc2/ . This repository contains the core building blocks common to all QWC2 applications. The QWC2 application, the demo application is hosted at https://github.com/qgis/qwc2-demo-app . To build a custom viewer, the first step is cloning the demo application: git clone --recursive https://github.com/qgis/qwc2-demo-app.git qwc2-app The typical layout of a QWC2 app source tree is as follows: Path Description \u251c\u2500 static/ \u2502 \u251c\u2500 assets/ See Viewer assets \u2502 \u251c\u2500 translations/ Translation files. \u2502 \u251c\u2500 config.json Master configuration file. \u2502 \u2514\u2500 themes.json Full theme configuration, autogenerated from themesConfig.json . \u251c\u2500 js/ \u2502 \u251c\u2500 app.jsx Entry point of the ReactJS application. \u2502 \u251c\u2500 appConfig.js Configuration of the qwc2 core modules. \u2502 \u251c\u2500 Help.jsx Built-in component of custom Help dialog, see Help dialog . \u2502 \u2514\u2500 SearchProviders.js Built-in custom search providers, see Search providers . \u251c\u2500 icons/ Application icons. \u251c\u2500 qwc2/ Git submodule containing the core qwc2 components. \u251c\u2500 index.html Entry point. \u251c\u2500 package.json NodeJS configuration file. \u251c\u2500 themesConfig.json Themes configuration. \u2514\u2500 webpack.config.js Webpack configuration.","title":"Building a custom viewer "},{"location":"configuration/ViewerConfiguration/#application-build-time-configuration","text":"The js/appConfig.js is the the principal build-time configuation file, and defines: - The default application locale, built into the application. This locale is used if no available locale matches the browser locale. - Which plugins are built into the application. Plugins left out here will be completely omitted when compiling the application bundle, and will hence also reduce the size of the bundle. - Various hook functions, as documented in the sample sample js/appConfig.js . Refer to the sample appConfig.js for a concrete example.","title":"Application build-time configuration"},{"location":"configuration/ViewerConfiguration/#overriding-icons","text":"The common application icons are located in qwc2/icons . They can be overridden by creating an icon with the same filename in the application specific icons folder. Note : The icons in the icons folder are compiled into an icon font. The icons need to be black content on transparent background, and all drawings (including texts) must be converted to paths for the icons to render correctly.","title":"Overriding icons"},{"location":"configuration/ViewerConfiguration/#compiling-an-application-bundle","text":"After tweaking the source files as desired, compile a deployable application bundle for production running yarn run prod When using qwc-docker , copy the contents of the qwc2-app/prod folder to qwc-docker/volumes/qwc2 and edit the qwc-docker/docker-compose.yml to use qwc-map-viewer-base with your custom build: qwc-map-viewer: image: sourcepole/qwc-map-viewer-base:vYYYY.MM.DD environment: <<: *qwc-service-variables SERVICE_MOUNTPOINT: '/' volumes: - ./pg_service.conf:/srv/pg_service.conf:ro - ./volumes/config:/srv/qwc_service/config:ro - ./volumes/qwc2:/qwc2:ro","title":"Compiling an application bundle"},{"location":"configuration/ViewerConfiguration/#keeping-the-qwc2-application-up-to-date","text":"As mentioned above, QWC2 is split into a common components repository and an application specific repository. The goal of this approach is to cleanly separate user-specific configuration and components which common components which serve as a basis for all QWC2 applications, and to make it as easy as possible to rebase the application onto the latest common QWC2 components. The recommended workflow is to keep the qwc2 folder a submodule referencing the upstream qwc2 repository . To update it, just checkout/update the desired branch: cd qwc2 git checkout master # or git checkout YYYY-lts git pull The QWC2 Upgrade Notes documents major changes, and in particular all incompatible changes between releases which require changes to the application specific code and/or configuration.","title":"Keeping the QWC2 application up to date"},{"location":"configuration/ViewerConfiguration/#translations","text":"This section gives an overview of the common tasks related to the QWC2 translations.","title":"Translations "},{"location":"configuration/ViewerConfiguration/#switching-language","text":"By default, QWC2 will attempt to load the translation matching your browser language. Alternatively, you can explicitly specify the language by adding the lang=<lang> query parameter to the application URL, i.e. lang=de-CH . The Settings plugin furthermore allows graphically switching the language within QWC2.","title":"Switching language"},{"location":"configuration/ViewerConfiguration/#adding-and-modify-translations","text":"When working inside a qwc2-app source folder, the translations can be found on two levels: At QWC2 components level, in qwc2-app/qwc2/translations . At application level, in qwc2-app/static/translations . A script will take care of merging the component translations into the application translations. This way, when updating the QWC2 submodule, new translations are automatically obtained. This script is automatically invoked on yarn start , but can also be manually invoked using yarn run tsupdate Translations are stored inside the respective translations folder as regular plain-text JSON files, named <lang>.json and can be freely edited with any text editor. The tsconfig.json files stored inside the respective translations folder contains the list of languages for which translations should be generated and a list of message IDs to include in the translation. The tsupdate script will automatically scan the code for message IDs (looking for static strings passed to LocaleUtils.tr and LocaleUtils.trmsg ), store these in tsconfig.json and automatically create resp. update the translation files. In some cases tsconfig.json will not pick up a message ID (for instance, if it is computed at runtime). In these cases, the message IDs can be added manually to the extra_strings section of the tsconfig.json . Also it may be desired to override a translation inherited from the QWC2 components at application level. To prevent tsupdate from continuously reverting the overridden translation, the respective message IDs can be added to the overrides section in the application tsconfig.json file. To add a new language, list it in qwc2-app/qwc2/translations/tsconfig.json and run yarn run tsupdate , then complete the messages taking the english translation file as reference. When adding or modifying translations at QWC2 components level, please contribute them by submitting a pull request to the upstream qwc2 repository .","title":"Adding and modify translations"},{"location":"configuration/ViewerConfiguration/#selectively-overriding-translation-strings","text":"Occasionally, it is desireable to selectively override specific translation strinsg. While one can modify the full translation file as described above, especially when using the qwc-map-viewer-demo docker image, it is easier to just selectively override the desired translation strings and leave the original file unchanged and avoid having to compile a custom viewer (or overwriting the entire file with a docker volume mount). To do this: Set loadTranslationOverrides to true in config.json . Create a <lang>_overrides.json containing just the ovverridden strings, for example en-US_overrides.json : { \"messages\": { \"appmenu\": { \"items\": { \"LayerTree\": \"Layers\" } } } } Place this file inside the translations folder of your production build. When using qwc-docker , you can place this file in qwc-docker/volumes/qwc2/translations/ and mount this file inside the container, i.e. : qwc-map-viewer: image: sourcepole/qwc-map-viewer-demo:vYYYY.MM.DD [...] volumes: - ./volumes/qwc2/translations/en-US_overrides.json:/qwc2/translations/en-US_overrides.json:ro","title":"Selectively overriding translation strings"},{"location":"configuration/ViewerConfiguration/#specifying-the-default-fallback-translation","text":"When no translation exists for the requested language (i.e. the current browser language), QWC2 will fall back to the default translation specified as defaultLocaleData in qwc2-app/js/appConfig.js . For the demo viewer, the default fallback translation is en-US .","title":"Specifying the default fallback translation"},{"location":"references/","text":"References QWC2 plugins qwc-config-generator qwc-admin-gui qwc-data-service qwc-db-auth qwc-elevation-service qwc-ext-service qwc-feature-info-service qwc-legend-service qwc-mapinfo-service qwc-map-viewer qwc-ogc-service qwc-permalink-service qwc-services-permissions qwc-print-service qwc-search-service","title":"References"},{"location":"references/#references","text":"QWC2 plugins qwc-config-generator qwc-admin-gui qwc-data-service qwc-db-auth qwc-elevation-service qwc-ext-service qwc-feature-info-service qwc-legend-service qwc-mapinfo-service qwc-map-viewer qwc-ogc-service qwc-permalink-service qwc-services-permissions qwc-print-service qwc-search-service","title":"References"},{"location":"references/qwc-admin-gui/","text":"QWC Admin GUI QWC Admin GUI Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-admin-gui/master/schemas/qwc-admin-gui.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"admin-gui\" config Required root config Type: object db_url Required root config db_url Type: string DB connection URL config_generator_service_url Required root config config_generator_service_url Type: string Config generator URL totp_enabled Required root config totp_enabled Type: boolean Show TOTP fields for two factor authentication user_info_fields root config user_info_fields Type: array of object Additional user fields No Additional Items Each item of this array must be: root config user_info_fields user_info_fields items Type: object proxy_url_whitelist root config proxy_url_whitelist Type: array of object List of RegExes for whitelisted URLs No Additional Items Each item of this array must be: root config proxy_url_whitelist proxy_url_whitelist items Type: object proxy_timeout root config proxy_timeout Type: integer Timeout in seconds for proxy requests admin_gui_title root config admin_gui_title Type: string Title displayed in Admin Gui home page admin_gui_subtitle root config admin_gui_subtitle Type: string Subtitle displayed in Admin Gui home page solr_service_url root config solr_service_url Type: string Solr Service base URL for collection solr_tenant_dih root config solr_tenant_dih Type: string Solr DataImportHandler for tenant solr_tenant_dih_config_file root config solr_tenant_dih_config_file Type: string Path to source DataImportHandler config file for tenant solr_config_path root config solr_config_path Type: string Path to Solr configs solr_update_check_wait root config solr_update_check_wait Type: number Wait time in seconds for checks during Solr index update solr_update_check_max_retries root config solr_update_check_max_retries Type: integer Max number of retries for checks during Solr index update plugins root config plugins Type: array of string List of plugins to load No Additional Items Each item of this array must be: root config plugins plugins items Type: string input_config_path root config input_config_path Type: string The path to the input configs. Required for 'themes' and 'config_editor' plugin. qwc2_path root config qwc2_path Type: string The path to QWC2 files. Required for 'themes' and 'alkis' plugins. qgs_resources_path root config qgs_resources_path Type: string The path to the QGIS projects. Required for 'themes' plugin. info_templates_path root config info_templates_path Type: string The path to the html info templates. Required for 'themes' plugin. ows_prefix root config ows_prefix Type: string The OGC service URL path prefix, i.e. /ows. Required for 'themes' plugin. default_qgis_server_url root config default_qgis_server_url Type: string The default Qgis server URL. Required for 'themes' plugin. Generated using json-schema-for-humans on 2023-08-23 at 12:11:42 +0000","title":"Qwc admin gui"},{"location":"references/qwc-config-generator/","text":"QWC Config generator QWC Config generator Type: object $schema root $schema Type: string Format: uri Default: \"https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"config-generator\" template root template Type: string themesConfig Required root themesConfig One of Option 1 Option 2 root themesConfig oneOf item 0 Type: object Corresponds to contents of standalone QWC2 themesConfig.json themes Required root themesConfig oneOf item 0 themes Type: object root themesConfig oneOf item 1 Type: string Path to themesConfig.json config Required root config Type: object tenant Required root config tenant Type: string Tenant name. Example: default config_db_url Required root config config_db_url Type: string Format: uri Connection URL for configuration database. Example: postgresql:///?service=qwc_configdb default_qgis_server_url Required root config default_qgis_server_url Type: string Format: uri Default QGIS Server URL for OGC requests. Example: http://qwc-qgis-server/ows/ ows_prefix root config ows_prefix Type: string OWS service path prefix. Defaults to the path component of default qgis server url. Used to form the urls of autodetected projects below qgis projects scan base_dir. Example: /ows qgis_projects_base_dir Required root config qgis_projects_base_dir Type: string Base path for QGIS projects. Example: /data qgis_projects_scan_base_dir root config qgis_projects_scan_base_dir Type: string Path for QGIS projects, which should be automatically detected. Must be a subdir qgis projects base_dir. Example: /data/scan qgis_projects_gen_base_dir root config qgis_projects_gen_base_dir Type: string Path for generated QGIS projects, result of preprocessing. Must be a subdir of qgis projects base dir. Can be the same as qgis projects scan base_dir, in which case the theme autodetection will apply to generated QGIS projects. Example: /data/gen permissions_default_allow root config permissions_default_allow Type: boolean Set whether resources are permitted or restricted by default. Example: true validate_schema root config validate_schema Type: boolean Validate configuration against schema. Example: true config_path root config config_path Type: string Target path for generated service configs and permissions, if not set by $OUTPUT CONFIG PATH. Example: /config-out qwc2_base_dir root config qwc2_base_dir Type: string Path to the QWC2 directory, which will be used to autodetect thumbnails. If qgis projects scan base dir is not set, then this option will be ignored. Example /qwc2 skip_print_layer_groups root config skip_print_layer_groups Type: boolean Skip group layers containing print layers layer_opacities root config layer_opacities Type: object Layer opacity values for QGIS <= 3.10 split_categorized_layers root config split_categorized_layers Type: boolean Set to true to activate the categorize groups functionality project_settings_read_timeout root config project_settings_read_timeout Type: number Timeout for GetProjectSettings, GetCapabilities and DescribeFeatureType requests. Default: 60sec autogen_keyvaltable_datasets root config autogen_keyvaltable_datasets Type: boolean Whether to automatically generate data service datasets used for key-value relationships without requiring corresponding data resources to be created. Warning: this will expose the key and value fields of the key-value table as world readable. Default: false generate_wfs_services root config generate_wfs_services Type: boolean Generate WFS service resources and permissions for the OGC service. Default: false services Required root services Type: array Service specific config options for generating their service configs No Additional Items Each item of this array must be: root services services items Generator config for a service One of common_service mapViewer ogc root services services items oneOf common_service Type: object Generator config for a QWC service name Required root services services items oneOf item 0 name Type: enum (of string) Service name Must be one of: \"adminGui\" \"data\" \"dbAuth\" \"elevation\" \"featureInfo\" \"mapinfo\" \"permalink\" \"print\" \"search\" \"legend\" config Required root services services items oneOf item 0 config Type: object QWC service config options (cf. its JSON schema). This is copied unmodified to the service config. root services services items oneOf mapViewer Type: object Generator config for Map Viewer name Required root services services items oneOf item 1 name Type: const Service name Specific value: \"mapViewer\" generator_config Required root services services items oneOf item 1 generator_config Type: object Additional config for generating MapViewer resources qwc2_config Required root services services items oneOf item 1 generator_config qwc2_config Type: object Additional config for QWC2 application configuration qwc2_config_file Required root services services items oneOf item 1 generator_config qwc2_config qwc2_config_file Type: string Path to QWC2 config.json file. Example: /qwc2/config.json qwc2_index_file Required root services services items oneOf item 1 generator_config qwc2_config qwc2_index_file Type: string Path to QWC2 index.html file. Example: /qwc2/index.html config Required root services services items oneOf item 1 config Type: object Map Viewer config options (cf. JSON schema qwc-map-viewer.json). This is copied unmodified to the service config. root services services items oneOf ogc Type: object Generator config for OGC service name Required root services services items oneOf item 2 name Type: const Service name Specific value: \"ogc\" generator_config root services services items oneOf item 2 generator_config Type: object Additional config for generating OGC service resources wms_services root services services items oneOf item 2 generator_config wms_services Type: object Additional config for WMS services online_resources root services services items oneOf item 2 generator_config wms_services online_resources Type: object Custom OnlineResources shown in GetCapabilities service root services services items oneOf item 2 generator_config wms_services online_resources service Type: string Format: uri Default public base URL for OnlineResources feature_info root services services items oneOf item 2 generator_config wms_services online_resources feature_info Type: string Format: uri Public base URL for FeatureInfo OnlineResources legend root services services items oneOf item 2 generator_config wms_services online_resources legend Type: string Format: uri Public base URL for Legend OnlineResources config Required root services services items oneOf item 2 config Type: object OGC service config options (cf. JSON schema qwc-ogc-service.json). This is copied unmodified to the service config. Generated using json-schema-for-humans on 2023-08-23 at 12:11:42 +0000","title":"Qwc config generator"},{"location":"references/qwc-data-service/","text":"QWC Data Service QWC Data Service Type: object $schema root $schema Type: string Format: uri Default: \"https://github.com/qwc-services/qwc-data-service/raw/master/schemas/qwc-data-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"data\" config Required root config Type: object attachments_base_dir root config attachments_base_dir Type: string Base dir where attachments are stored allowed_attachment_extensions root config allowed_attachment_extensions Type: string Comma separated list of allowed attachment file extensions, i.e. '.png,.jpg' max_attachment_file_size root config max_attachment_file_size Type: number Maximum attachment file size in bytes clamd_host root config clamd_host Type: string Hostname of ClamD server listening on TCP port 3310. If set, uploaded files are checked by ClamAV upload_user_field_suffix root config upload_user_field_suffix Type: string Field suffix where to log the username who last changed an upload field, i.e. __ for the field . If empty, username is not logged. edit_timestamp_field root config edit_timestamp_field Type: string If specified, the timestamp of the last mutation to a record will be logged to the field of the record. edit_user_field root config edit_user_field Type: string If specified, the username of the last user who performed a mutation to a record with be logged to the field of the record. geometry_default_allow_null root config geometry_default_allow_null Type: boolean Whether to allow null geometries by default allowed_extensions_per_dataset root config allowed_extensions_per_dataset Type: object Loopup of allowed attachment file extensions per theme, values as comma separated list, i.e. '.png,.jpg' max_attachment_file_size_per_dataset root config max_attachment_file_size_per_dataset Type: object Lookup of maximum attachment file size in bytes per theme attachment_store_pattern root config attachment_store_pattern Type: string The path pattern to use when saving attachments to disk. You can use {random}, {filename}, {ext} and { }, where field refers to the respective field value of the committed feature. Default is '{random}/{filename}' resources Required root resources Type: object datasets Required root resources datasets Type: array of object No Additional Items Each item of this array must be: root resources datasets Dataset Type: object PostgreSQL metadata and field constraints for a dataset name Required root resources datasets Dataset name Type: string Dataset name db_url Required root resources datasets Dataset db_url Type: string DB connection string for read and write access (or read-only access if db write url is present) db_write_url root resources datasets Dataset db_write_url Type: string Optional DB connection string for write access schema Required root resources datasets Dataset schema Type: string table_name Required root resources datasets Dataset table_name Type: string primary_key Required root resources datasets Dataset primary_key Type: string fields Required root resources datasets Dataset fields Type: array of object Dataset fields with optional constraints No Additional Items Each item of this array must be: root resources datasets Dataset fields fields items Type: object name Required root resources datasets Dataset fields fields items name Type: string Field name data_type Required root resources datasets Dataset fields fields items data_type Type: enum (of string) Default: \"text\" Must be one of: \"USER-DEFINED\" \"bigint\" \"boolean\" \"character\" \"character varying\" \"date\" \"double precision\" \"file\" \"integer\" \"json\" \"jsonb\" \"numeric\" \"real\" \"smallint\" \"text\" \"time\" \"timestamp with time zone\" \"timestamp without time zone\" \"uuid\" constraints root resources datasets Dataset fields fields items constraints Type: object maxlength root resources datasets Dataset fields fields items constraints maxlength Type: integer pattern root resources datasets Dataset fields fields items constraints pattern Type: string min root resources datasets Dataset fields fields items constraints min Type: number max root resources datasets Dataset fields fields items constraints max Type: number numeric_precision root resources datasets Dataset fields fields items constraints numeric_precision Type: integer numeric_scale root resources datasets Dataset fields fields items constraints numeric_scale Type: integer step root resources datasets Dataset fields fields items constraints step Type: number values root resources datasets Dataset fields fields items constraints values Type: array of object No Additional Items Each item of this array must be: root resources datasets Dataset fields fields items constraints values values items Type: object label Required root resources datasets Dataset fields fields items constraints values values items label Type: string value Required root resources datasets Dataset fields fields items constraints values values items value Type: string readOnly root resources datasets Dataset fields fields items constraints readOnly Type: boolean required root resources datasets Dataset fields fields items constraints required Type: boolean geometry root resources datasets Dataset geometry Type: object geometry_column Required root resources datasets Dataset geometry geometry_column Type: string geometry_type Required root resources datasets Dataset geometry geometry_type Type: enum (of string) Must be one of: \"POINT\" \"POINTZ\" \"LINESTRING\" \"LINESTRINGZ\" \"POLYGON\" \"POLYGONZ\" \"MULTIPOINT\" \"MULTIPOINTZ\" \"MULTILINESTRING\" \"MULTILINESTRINGZ\" \"MULTIPOLYGON\" \"MULTIPOLYGONZ\" srid Required root resources datasets Dataset geometry srid Type: integer Spatial Reference System Identifier (EPSG code) allow_null root resources datasets Dataset geometry allow_null Type: boolean Default: false Allow setting geometry values to NULL Generated using json-schema-for-humans on 2023-08-23 at 12:11:43 +0000","title":"Qwc data service"},{"location":"references/qwc-db-auth/","text":"QWC DB authentication service QWC DB authentication service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-db-auth/master/schemas/qwc-db-auth.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"db-auth\" config Required root config Type: object db_url Required root config db_url Type: string DB connection URL password_min_length root config password_min_length Type: integer Min password length password_max_length root config password_max_length Type: integer Max password length password_constraints root config password_constraints Type: array of string List of RegExes for additional password constraints No Additional Items Each item of this array must be: root config password_constraints password_constraints items Type: string password_min_constraints root config password_min_constraints Type: integer Min number of password_constraints to match for password to be valid password_constraints_message root config password_constraints_message Type: string Validation message if password constraints are not met password_expiry root config password_expiry Type: integer Number of days until password expires, or -1 to disable password_expiry_notice root config password_expiry_notice Type: integer Show an expiry notice within this number of days before a password expires, or -1 to disable password_update_interval root config password_update_interval Type: integer Min number of seconds before password may be changed again, or -1 to disable password_allow_reuse root config password_allow_reuse Type: boolean Set whether previous passwords may be reused or not user_info_fields root config user_info_fields Type: array of string List of user info fields to include in JWT identity No Additional Items Each item of this array must be: root config user_info_fields user_info_fields items Type: string logo_image_url root config logo_image_url Type: string URL to a logo image to show in the login form background_image_url root config background_image_url Type: string URL to a background image for the login page customstylesheet root config customstylesheet Type: string Filename of custom stylesheet placed next to regular style.css Generated using json-schema-for-humans on 2023-08-23 at 12:11:43 +0000","title":"Qwc db auth"},{"location":"references/qwc-document-service/","text":"QWC Document Service Properties $schema (string) : Reference to JSON schema of this config. Default: https://raw.githubusercontent.com/qwc-services/qwc-document-service/master/schemas/qwc-document-service.json . service (string) config (object) jasper_service_url (string) : Jasper Reporting service URL for generating reports. Example: http://localhost:8002/reports. jasper_timeout (integer) : Timeout for requests forwarded to Jasper Reporting service. Default: 60 . resources (object) document_templates (array) Items (object) template (string) report_filename (string)","title":"QWC Document Service"},{"location":"references/qwc-document-service/#qwc-document-service","text":"","title":"QWC Document Service"},{"location":"references/qwc-document-service/#properties","text":"$schema (string) : Reference to JSON schema of this config. Default: https://raw.githubusercontent.com/qwc-services/qwc-document-service/master/schemas/qwc-document-service.json . service (string) config (object) jasper_service_url (string) : Jasper Reporting service URL for generating reports. Example: http://localhost:8002/reports. jasper_timeout (integer) : Timeout for requests forwarded to Jasper Reporting service. Default: 60 . resources (object) document_templates (array) Items (object) template (string) report_filename (string)","title":"Properties"},{"location":"references/qwc-elevation-service/","text":"QWC Elevation Service QWC Elevation Service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-elevation-service/master/schemas/qwc-elevation-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"elevation\" config Required root config Type: object elevation_dataset Required root config elevation_dataset Type: string Elevation dataset (file or URL). Example: https://data.sourcepole.com/srtm 1km 3857.tif Generated using json-schema-for-humans on 2023-08-23 at 12:11:44 +0000","title":"Qwc elevation service"},{"location":"references/qwc-ext-service/","text":"QWC External Link Service QWC External Link Service Type: object $schema root $schema Type: string Format: uri Default: \"https://github.com/qwc-services/qwc-ext-service/raw/master/schemas/qwc-ext-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"ext\" config Required root config Type: object get_link_timeout root config get_link_timeout Type: number Timeout for get link requests, in seconds. Default: 10. post_link_timeout root config post_link_timeout Type: number Timeout for post link requests, in seconds. Default: 30. resources Required root resources Type: object external_links Required root resources external_links Type: array of object No Additional Items Each item of this array must be: root resources external_links external_links items Type: object name Required root resources external_links external_links items name Type: string url Required root resources external_links external_links items url Type: string Generated using json-schema-for-humans on 2023-08-23 at 12:11:45 +0000","title":"Qwc ext service"},{"location":"references/qwc-feature-info-service/","text":"QWC FeatureInfo Service QWC FeatureInfo Service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-feature-info-service/master/schemas/qwc-feature-info-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"feature-info\" config Required root config Type: object default_info_template root config default_info_template Type: string Default HTML info template default_info_template_path root config default_info_template_path Type: string Default HTML info template path default_info_template_base64 root config default_info_template_base64 Type: string Default HTML info template in Base64 encoding default_qgis_server_url root config default_qgis_server_url Type: string Default URL for WMS GetFeatureInfo queries data_service_url root config data_service_url Type: string Data service URL transform_image_urls root config transform_image_urls Type: boolean Transform image URLs to inline images skip_empty_attributes root config skip_empty_attributes Type: boolean Whether to skip empty feature attributes in WMS GetFeatureInfo responses (default: false) use_permission_attribute_order root config use_permission_attribute_order Type: boolean Whether to order the attributes according to order of the permitted attribute names in WMS GetFeatureInfo responses, rather than the order returned by WMS GetFeatureInfo (default: false) resources Required root resources Type: object wms_services root resources wms_services Type: array of object No Additional Items Each item of this array must be: root resources wms_services WMS Type: object WMS service with nested layers and group layers name Required root resources wms_services WMS name Type: string WMS service name root_layer Required root resources wms_services WMS root_layer Root layer of WMS (layer or group layer) One of layer group_layer root resources wms_services WMS root_layer oneOf layer Type: object Single layer No Additional Properties name Required root resources wms_services WMS root_layer oneOf Layer name Type: string WMS layer name type root resources wms_services WMS root_layer oneOf Layer type Type: const Layer type Specific value: \"layer\" title root resources wms_services WMS root_layer oneOf Layer title Type: string Layer title attributes root resources wms_services WMS root_layer oneOf Layer attributes Type: array of object No Additional Items Each item of this array must be: root resources wms_services WMS root_layer oneOf Layer attributes attributes items Type: object name Required root resources wms_services WMS root_layer oneOf Layer attributes attributes items name Type: string Attribute name alias root resources wms_services WMS root_layer oneOf Layer attributes attributes items alias Type: string format root resources wms_services WMS root_layer oneOf Layer attributes attributes items format Type: string Formatting expression for converting attribute values format_base64 root resources wms_services WMS root_layer oneOf Layer attributes attributes items format_base64 Type: string Formatting expression for converting attribute values, in Base64 encoding json_attribute_aliases root resources wms_services WMS root_layer oneOf Layer attributes attributes items json_attribute_aliases Type: array of object Aliases for attributes in JSON values of type list No Additional Items Each item of this array must be: root resources wms_services WMS root_layer oneOf Layer attributes attributes items json_attribute_aliases json_attribute_aliases items Type: object name Required root resources wms_services WMS root_layer oneOf Layer attributes attributes items json_attribute_aliases json_attribute_aliases items name Type: string Attribute name in JSON value alias Required root resources wms_services WMS root_layer oneOf Layer attributes attributes items json_attribute_aliases json_attribute_aliases items alias Type: string Alias for attribute in JSON value info_template root resources wms_services WMS root_layer oneOf Layer info_template One of wms_info_template sql_info_template module_info_template root resources wms_services WMS root_layer oneOf Layer info_template oneOf wms_info_template Type: object Info template for WMS GetFeatureInfo No Additional Properties type Required root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 type Type: const Specific value: \"wms\" wms_url root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 wms_url Type: string Custom WMS URL if different from default qgis server_url template root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 template Type: string HTML template for info result template_path root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 template_path Type: string Path to HTML template for info result template_base64 root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 0 template_base64 Type: string HTML template for info result, in Base64 encoding root resources wms_services WMS root_layer oneOf Layer info_template oneOf sql_info_template Type: object Info template for DB Query No Additional Properties One of Option 1 Option 2 root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 oneOf item 0 Type: object The following properties are required: type db_url sql root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 oneOf item 1 Type: object The following properties are required: type db_url sql_base64 type root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 type Type: const Specific value: \"sql\" db_url root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 db_url Type: string Database connection string sql root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 sql Type: string Query SQL sql_base64 root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 sql_base64 Type: string Query SQL in Base64 encoding template root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 template Type: string HTML template for info result template_path root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 template_path Type: string Path to HTML template for info result template_base64 root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 1 template_base64 Type: string HTML template for info result, in Base64 encoding root resources wms_services WMS root_layer oneOf Layer info_template oneOf module_info_template Type: object Info template using WMS GetFeatureInfo No Additional Properties type Required root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 type Type: const Specific value: \"module\" module Required root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 module Type: string Custom info module name template root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 template Type: string HTML template for info result template_path root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 template_path Type: string Path to HTML template for info result. template_base64 root resources wms_services WMS root_layer oneOf Layer info_template oneOf item 2 template_base64 Type: string HTML template for info result, in Base64 encoding display_field root resources wms_services WMS root_layer oneOf Layer display_field Type: string Show value of this attribute in feature result header feature_report root resources wms_services WMS root_layer oneOf Layer feature_report Type: string Name of corresponding feature report root resources wms_services WMS root_layer oneOf group_layer Type: object Group layer with nested sublayers No Additional Properties name Required root resources wms_services WMS root_layer oneOf Group Layer name Type: string WMS group layer name type root resources wms_services WMS root_layer oneOf Group Layer type Type: const Layer type Specific value: \"layergroup\" title root resources wms_services WMS root_layer oneOf Group Layer title Type: string Group title layers Required root resources wms_services WMS root_layer oneOf Group Layer layers Type: array Sublayers of this group layer (layers or group layers) No Additional Items Each item of this array must be: root resources wms_services WMS root_layer oneOf Group Layer layers layers items One of layer group_layer root resources wms_services WMS root_layer oneOf Group Layer layers layers items oneOf layer Type: object Single layer Same definition as Layer root resources wms_services WMS root_layer oneOf Group Layer layers layers items oneOf group_layer Type: object Group layer with nested sublayers Same definition as Group Layer hide_sublayers root resources wms_services WMS 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) Generated using json-schema-for-humans on 2023-08-23 at 12:11:45 +0000","title":"Qwc feature info service"},{"location":"references/qwc-legend-service/","text":"QWC Legend Service QWC Legend Service Type: object $schema root $schema Type: string Format: 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 Required root service Type: const Specific value: \"legend\" config Required root config Type: object default_qgis_server_url Required root config default_qgis_server_url Type: string Default base URL for forwarding WMS GetLegendGraphics requests legend_images_path root config legend_images_path Type: string Path to legend images (required if using 'legend_image') resources Required root resources Type: object wms_services root resources wms_services Type: array of object No Additional Items Each item of this array must be: root resources wms_services WMS service Type: object WMS service with nested layers and group layers name Required root resources wms_services WMS service name Type: string WMS service name root_layer Required root resources wms_services WMS service root_layer Root layer of WMS (layer or group layer) One of layer group_layer root resources wms_services WMS service root_layer oneOf layer Type: object Single layer No Additional Properties name Required root resources wms_services WMS service root_layer oneOf Layer name Type: string WMS layer name type root resources wms_services WMS service root_layer oneOf Layer type Type: const Layer type Specific value: \"layer\" legend_image root resources wms_services WMS service root_layer oneOf Layer legend_image Type: string Legend image path relative to 'legend images path' legend_image_base64 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 name Required root resources wms_services WMS service root_layer oneOf Group Layer name Type: string WMS group layer name type root resources wms_services WMS service root_layer oneOf Group Layer type Type: const Layer type Specific value: \"layergroup\" layers Required root resources wms_services WMS service root_layer oneOf Group Layer layers Type: array Sublayers of this group layer (layers or group layers) No Additional Items Each item of this array must be: root resources wms_services WMS service root_layer oneOf Group Layer layers layers items One of layer group_layer root resources wms_services WMS service root_layer oneOf Group Layer layers layers items oneOf layer Type: object Single layer Same definition as Layer root resources wms_services WMS service root_layer oneOf Group Layer layers layers items oneOf group_layer Type: object Group layer with nested sublayers Same definition as Group Layer hide_sublayers 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) legend_image root resources wms_services WMS service root_layer oneOf Group Layer legend_image Type: string Legend image path relative to 'legend images path' (only if hide_sublayers is set) legend_image_base64 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) Generated using json-schema-for-humans on 2023-08-23 at 12:11:46 +0000","title":"Qwc legend service"},{"location":"references/qwc-map-viewer/","text":"QWC Map Viewer QWC Map Viewer Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-map-viewer/v2/schemas/qwc-map-viewer.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"map-viewer\" config Required root config Type: object qwc2_path Required root config qwc2_path Type: string Path to QWC2 files auth_service_url root config auth_service_url Type: string QWC Auth Service URL ccc_config_service_url root config ccc_config_service_url Type: string CCC Service URL data_service_url root config data_service_url Type: string QWC Data Service URL dataproduct_service_url root config dataproduct_service_url Type: string DataProduct Service URL document_service_url root config document_service_url Type: string Document Service URL elevation_service_url root config elevation_service_url Type: string QWC Elevation Service URL info_service_url root config info_service_url Type: string QWC FeatureInfo Service URL landreg_service_url root config landreg_service_url Type: string Land Register Extract Service URL legend_service_url root config legend_service_url Type: string QWC Legend Service URL mapinfo_service_url root config mapinfo_service_url Type: string MapInfo Service URL ogc_service_url Required root config ogc_service_url Type: string QWC OGC Service URL permalink_service_url root config permalink_service_url Type: string QWC Permalink Service URL internal_permalink_service_url root config internal_permalink_service_url Type: string Internal QWC Permalink Service URL plotinfo_service_url root config plotinfo_service_url Type: string PlotInfo Service URL print_service_url root config print_service_url Type: string QWC Print Service URL proxy_service_url root config proxy_service_url Type: string Proxy Service URL search_data_service_url root config search_data_service_url Type: string QWC Search Result Service URL search_service_url root config search_service_url Type: string QWC Search Service URL show_restricted_themes root config show_restricted_themes Type: boolean Whether to insert placeholder items for restricted themes in themes.json show_restricted_themes_whitelist root config show_restricted_themes_whitelist Type: array of string Whitelist of restricted theme names to include in themes.json. If empty, all restricted themes are shown. No Additional Items Each item of this array must be: root config show_restricted_themes_whitelist show_restricted_themes_whitelist items Type: string redirect_restricted_themes_to_auth root config redirect_restricted_themes_to_auth Type: boolean Whether to redirect to login on auth service if requesting a restricted theme in URL params user_info_fields root config user_info_fields Type: array of string List of user info fields to read from JWT identity No Additional Items Each item of this array must be: root config user_info_fields user_info_fields items Type: string public_paths root config public_paths Type: array of string Optional: List of paths that will be accessible without a JWT identity, if AUTH_REQUIRED is set. No Additional Items Each item of this array must be: root config public_paths public_paths items Type: string resources Required root resources Type: object qwc2_config Required root resources qwc2_config Type: object restricted_viewer_tasks root resources qwc2_config restricted_viewer_tasks Type: array of string Restricted menu items No Additional Items Each item of this array must be: root resources qwc2_config restricted_viewer_tasks restricted_viewer_tasks items Type: string config Required root resources qwc2_config config Type: object QWC2 application configuration (config.json) qwc2_themes Required root resources qwc2_themes Type: object QWC2 themes configuration (themes.json) themes Required root resources qwc2_themes themes Type: object Generated using json-schema-for-humans on 2023-08-23 at 12:11:47 +0000","title":"Qwc map viewer"},{"location":"references/qwc-mapinfo-service/","text":"QWC Mapinfo Service QWC Mapinfo Service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-mapinfo-service/master/schemas/qwc-mapinfo-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"mapinfo\" config Required root config One of Option 1 Option 2 Option 3 root config oneOf item 0 Type: object The following properties are required: db_url info_table info_geom_col info_display_col info_title root config oneOf item 1 Type: object The following properties are required: db_url info_sql info_title root config oneOf item 2 Type: object The following properties are required: queries db_url root config db_url Type: string DB connection for info queries info_table root config info_table Type: string Table to use info_geom_col root config info_geom_col Type: string Geometry column in table info_display_col root config info_display_col Type: string Display text column in table info_title root config info_title Type: string Display title info_where root config info_where Type: string Additional WHERE query queries root config queries Type: array of object No Additional Items Each item of this array must be: root config queries Query One of Option 1 Option 2 root config queries Query oneOf item 0 Type: object The following properties are required: db_url info_table info_geom_col info_display_col info_title root config queries Query oneOf item 1 Type: object The following properties are required: db_url info_sql info_title db_url root config queries Query db_url Type: string DB connection for info queries info_table root config queries Query info_table Type: string Table to use info_geom_col root config queries Query info_geom_col Type: string Geometry column in table info_display_col root config queries Query info_display_col Type: string Display text column in table info_title root config queries Query info_title Type: string Display title info_where root config queries Query info_where Type: string Additional WHERE query info_sql root config queries Query info_sql Type: string SQL query text Generated using json-schema-for-humans on 2023-08-23 at 12:11:46 +0000","title":"Qwc mapinfo service"},{"location":"references/qwc-ogc-service/","text":"QWC OGC Service QWC OGC Service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-ogc-service/master/schemas/qwc-ogc-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"ogc\" config Required root config Type: object default_qgis_server_url root config default_qgis_server_url Type: string Default base URL for WMS/WFS requests public_ogc_url_pattern root config public_ogc_url_pattern Type: string Regex pattern of the external OGC URL pattern, used to detect EXTERNAL_WMS URLs in print requests which point to the OGC server itself. Can use $origin$, $tenant$ and $mountpoint$ as variables. Default: $origin$/.*/?$mountpoint$ basic_auth_login_url root config basic_auth_login_url Type: array of string Login verification URL for requests with basic auth. Example: http://qwc-auth-service:9090/verify_login No Additional Items Each item of this array must be: root config basic_auth_login_url basic_auth_login_url items Type: string qgis_server_identity_parameter root config qgis_server_identity_parameter Type: string Name of the active user parameter for the QGIS Server. Will be set to the name of the logged in user in qwc2 public_paths root config public_paths Type: array of string Optional: List of paths that will be accessible without a JWT identity, if AUTH_REQUIRED is set. No Additional Items Each item of this array must be: root config public_paths public_paths items Type: string marker_params root config marker_params Type: object Optional: Marker parameter definitions default root config marker_params default Type: string Default value type root config marker_params type Type: string Parameter type (number, color, string) resources Required root resources Type: object wms_services root resources wms_services Type: array of object No Additional Items Each item of this array must be: root resources wms_services WMS service Type: object WMS service with nested layers and group layers name Required root resources wms_services WMS service name Type: string WMS service name wms_url root resources wms_services WMS service wms_url Type: string Custom WMS URL if different from default qgis server_url online_resources root resources wms_services WMS service online_resources Type: object Custom OnlineResources shown in GetCapabilities service root resources wms_services WMS service online_resources service Type: string Default public base URL for OnlineResources feature_info root resources wms_services WMS service online_resources feature_info Type: string Public base URL for FeatureInfo OnlineResources legend root resources wms_services WMS service online_resources legend Type: string Public base URL for Legend OnlineResources root_layer Required root resources wms_services WMS service root_layer Root layer of WMS (layer or group layer) One of wms_layer wms_group_layer root resources wms_services WMS service root_layer oneOf wms_layer Type: object Single layer No Additional Properties name Required root resources wms_services WMS service root_layer oneOf WMS Layer name Type: string WMS layer name type root resources wms_services WMS service root_layer oneOf WMS Layer type Type: const Layer type Specific value: \"layer\" title root resources wms_services WMS service root_layer oneOf WMS Layer title Type: string Layer title attributes root resources wms_services WMS service root_layer oneOf WMS Layer attributes Type: array of string Attributes for GetFeatureInfo No Additional Items Each item of this array must be: root resources wms_services WMS service root_layer oneOf WMS Layer attributes attributes items Type: string queryable root resources wms_services WMS service root_layer oneOf WMS Layer queryable Type: boolean Whether this layer is queryable opacity root resources wms_services WMS service root_layer oneOf WMS Layer opacity Type: integer Custom base opacity from 0-100 (Hidden sublayers only) root resources wms_services WMS service root_layer oneOf wms_group_layer Type: object Group layer with nested sublayers No Additional Properties name Required root resources wms_services WMS service root_layer oneOf WMS Group Layer name Type: string WMS group layer name type root resources wms_services WMS service root_layer oneOf WMS Group Layer type Type: const Layer type Specific value: \"layergroup\" title root resources wms_services WMS service root_layer oneOf WMS Group Layer title Type: string Group title layers Required root resources wms_services WMS service root_layer oneOf WMS Group Layer layers Type: array Sublayers of this group layer (layers or group layers) No Additional Items Each item of this array must be: root resources wms_services WMS service root_layer oneOf WMS Group Layer layers layers items One of wms_layer wms_group_layer root resources wms_services WMS service root_layer oneOf WMS Group Layer layers layers items oneOf wms_layer Type: object Single layer Same definition as WMS Layer root resources wms_services WMS service root_layer oneOf WMS Group Layer layers layers items oneOf wms_group_layer Type: object Group layer with nested sublayers Same definition as WMS Group Layer hide_sublayers root resources wms_services WMS service root_layer oneOf WMS 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) print_url root resources wms_services WMS service print_url Type: string Custom WMS URL for printing, e.g. if using a separate QGIS project. print_templates root resources wms_services WMS service print_templates Type: array of string Available print templates No Additional Items Each item of this array must be: root resources wms_services WMS service print_templates print_templates items Type: string internal_print_layers root resources wms_services WMS service internal_print_layers Type: array of string Internal layer names used for printing and raster export of background and external layers No Additional Items Each item of this array must be: root resources wms_services WMS service internal_print_layers internal_print_layers items Type: string wfs_services root resources wfs_services Type: array of object No Additional Items Each item of this array must be: root resources wfs_services WFS service Type: object WFS service with list of layers name Required root resources wfs_services WFS service name Type: string WFS service name wfs_url root resources wfs_services WFS service wfs_url Type: string Custom WFS URL if different from default qgis server_url online_resource root resources wfs_services WFS service online_resource Type: string Custom OnlineResource shown in GetCapabilities layers Required root resources wfs_services WFS service layers Type: array List of WFS layers No Additional Items Each item of this array must be: root resources wfs_services WFS service layers wfs_layer Type: object Single layer name Required root resources wfs_services WFS service layers WFS Layer name Type: string WFS layer name attributes root resources wfs_services WFS service layers WFS Layer attributes Type: array of string Attributes for GetFeature and DescribeFeatureType No Additional Items Each item of this array must be: root resources wfs_services WFS service layers WFS Layer attributes attributes items Type: string Generated using json-schema-for-humans on 2023-08-23 at 12:11:48 +0000","title":"Qwc ogc service"},{"location":"references/qwc-permalink-service/","text":"QWC Permalink Service QWC Permalink Service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-permalink-service/master/schemas/qwc-permalink-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"permalink\" config Required root config Type: object db_url Required root config db_url Type: string DB connection URL. Defaults to postgresql:///?service=qwc_configdb. permalinks_table Required root config permalinks_table Type: string Permalink table. Defaults to qwc_config.permalinks. user_permalink_table root config user_permalink_table Type: string User permalink table. Defaults to qwc config.user permalinks. user_bookmark_table root config user_bookmark_table Type: string User bookmarks table. Defaults to qwc config.user bookmarks. bookmarks_sort_order root config bookmarks_sort_order Type: string Bookmarks sort order, defaults to \"date, description\". Generated using json-schema-for-humans on 2023-08-23 at 12:11:48 +0000","title":"Qwc permalink service"},{"location":"references/qwc-print-service/","text":"QWC Print Service QWC Print Service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-print-service/master/schemas/qwc-print-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"print\" config Required root config Type: object ogc_service_url Required root config ogc_service_url Type: string OGC Service URL (internal) qgis_server_version Required root config qgis_server_version Type: string QGIS Server version (e.g. 2.18.19, 3.4.1) qgs_postfix root config qgs_postfix Type: string optional postfix to QGS name for printing print_pdf_filename root config print_pdf_filename Type: string optional filename for returned PDF (default: .pdf) label_values root config label_values Type: array of object No Additional Items Each item of this array must be: root config label_values label_values items Type: object field Required root config label_values label_values items field Type: string value Required root config label_values label_values items value Type: string label_queries root config label_queries Type: array of object No Additional Items Each item of this array must be: root config label_queries label_queries items Type: object db_url Required root config label_queries label_queries items db_url Type: string query Required root config label_queries label_queries items query Type: string params Required root config label_queries label_queries items params Type: array of string No Additional Items Each item of this array must be: root config label_queries label_queries items params params items Type: string resources Required root resources Type: object print_templates Required root resources print_templates Type: array of object No Additional Items Each item of this array must be: root resources print_templates print_templates items Type: object template Required root resources print_templates print_templates items template Type: string Generated using json-schema-for-humans on 2023-08-23 at 12:11:49 +0000","title":"Qwc print service"},{"location":"references/qwc-search-service/","text":"QWC Fulltext Search Service QWC Fulltext Search Service Type: object $schema root $schema Type: string Format: uri Default: \"https://raw.githubusercontent.com/qwc-services/qwc-fulltext-search-service/master/schemas/qwc-search-service.json\" Reference to JSON schema of this config service Required root service Type: const Specific value: \"search\" config Required root config Type: object solr_service_url Required root config solr_service_url Type: string SOLR service URL word_split_re root config word_split_re Type: string Default: \"[\\\\s,.:;\\\"]+\" Word split Regex search_result_limit root config search_result_limit Type: integer Default: 50 Result count limit per search db_url root config db_url Type: string Default DB connection for geometry result query resources Required root resources Type: object facets Required root resources facets Type: array of object No Additional Items Each item of this array must be: root resources facets Facet Type: object name Required root resources facets Facet name Type: string Facet name filter_word Required root resources facets Facet filter_word Type: string table_name root resources facets Facet table_name Type: string Default: \"search_v\" Table/View for search result geometries geometry_column root resources facets Facet geometry_column Type: string Default: \"geom\" Geometry column in search result table facet_column root resources facets Facet facet_column Type: string Default: \"subclass\" Facet name column in search result table db_url root resources facets Facet db_url Type: string DB connection for geometry result query Generated using json-schema-for-humans on 2023-08-23 at 12:11:50 +0000","title":"Qwc search service"},{"location":"references/qwc-services-permissions/","text":"QWC Services Permissions QWC Services Permissions Type: object $schema root $schema Type: string Format: uri Default: \"https://github.com/qwc-services/qwc-services-core/raw/master/schemas/qwc-services-permissions.json\" Reference to JSON schema of these permissions users Required root users Type: array of object No Additional Items Each item of this array must be: root users User Type: object name Required root users User name Type: string User name groups Required root users User groups Type: array of string No Additional Items Each item of this array must be: root users User groups groups items Type: string roles root users User roles Type: array of string No Additional Items Each item of this array must be: root users User roles roles items Type: string groups Required root groups Type: array of object No Additional Items Each item of this array must be: root groups Group Type: object name Required root groups Group name Type: string Group name roles Required root groups Group roles Type: array of string No Additional Items Each item of this array must be: root groups Group roles roles items Type: string roles Required root roles Type: array of object No Additional Items Each item of this array must be: root roles Role Type: object role Required root roles Role role Type: string Role name permissions root roles Role permissions Type: object wms_services root roles Role permissions wms_services Type: array of object Permitted WMS services and layers for all QWC services using WMS requests (i.e. OGC, FeatureInfo, Legend, Print service) No Additional Items Each item of this array must be: root roles Role permissions wms_services WMS permissions Type: object name Required root roles Role permissions wms_services WMS permissions name Type: string WMS service name layers Required root roles Role permissions wms_services WMS permissions layers Type: array of object Flat list of permitted layers and group layers No Additional Items Each item of this array must be: root roles Role permissions wms_services WMS permissions layers layers items Type: object name Required root roles Role permissions wms_services WMS permissions layers layers items name Type: string WMS layer name attributes root roles Role permissions wms_services WMS permissions layers layers items attributes Type: array of string No Additional Items Each item of this array must be: root roles Role permissions wms_services WMS permissions layers layers items attributes attributes items Type: string info_template root roles Role permissions wms_services WMS permissions layers layers items info_template Type: boolean print_templates root roles Role permissions wms_services WMS permissions print_templates Type: array of string No Additional Items Each item of this array must be: root roles Role permissions wms_services WMS permissions print_templates print_templates items Type: string wfs_services root roles Role permissions wfs_services Type: array of object Permitted WFS services and layers for OGC service No Additional Items Each item of this array must be: root roles Role permissions wfs_services WFS permissions Type: object name Required root roles Role permissions wfs_services WFS permissions name Type: string WFS service name layers Required root roles Role permissions wfs_services WFS permissions layers Type: array of object List of permitted layers No Additional Items Each item of this array must be: root roles Role permissions wfs_services WFS permissions layers layers items Type: object name Required root roles Role permissions wfs_services WFS permissions layers layers items name Type: string WFS layer name attributes root roles Role permissions wfs_services WFS permissions layers layers items attributes Type: array of string No Additional Items Each item of this array must be: root roles Role permissions wfs_services WFS permissions layers layers items attributes attributes items Type: string background_layers root roles Role permissions background_layers Type: array of string No Additional Items Each item of this array must be: root roles Role permissions background_layers background_layers items Type: string data_datasets root roles Role permissions data_datasets Type: array of object Permitted datasets for Data service No Additional Items Each item of this array must be: root roles Role permissions data_datasets Dataset permissions Type: object name Required root roles Role permissions data_datasets Dataset permissions name Type: string Dataset name attributes Required root roles Role permissions data_datasets Dataset permissions attributes Type: array of string No Additional Items Each item of this array must be: root roles Role permissions data_datasets Dataset permissions attributes attributes items Type: string writable root roles Role permissions data_datasets Dataset permissions writable Type: boolean creatable root roles Role permissions data_datasets Dataset permissions creatable Type: boolean readable root roles Role permissions data_datasets Dataset permissions readable Type: boolean updatable root roles Role permissions data_datasets Dataset permissions updatable Type: boolean deletable root roles Role permissions data_datasets Dataset permissions deletable Type: boolean viewer_tasks root roles Role permissions viewer_tasks Type: array of string No Additional Items Each item of this array must be: root roles Role permissions viewer_tasks viewer_tasks items Type: string theme_info_links root roles Role permissions theme_info_links Type: array of string No Additional Items Each item of this array must be: root roles Role permissions theme_info_links theme_info_links items Type: string plugin_data root roles Role permissions plugin_data Type: array of object Permitted resources for custom Map viewer plugins No Additional Items Each item of this array must be: root roles Role permissions plugin_data Plugin permissions Type: object name Required root roles Role permissions plugin_data Plugin permissions name Type: string Plugin name resources Required root roles Role permissions plugin_data Plugin permissions resources Type: array of string Plugin specific resources No Additional Items Each item of this array must be: root roles Role permissions plugin_data Plugin permissions resources resources items Type: string dataproducts root roles Role permissions dataproducts Type: array of string No Additional Items Each item of this array must be: root roles Role permissions dataproducts dataproducts items Type: string document_templates root roles Role permissions document_templates Type: array of string No Additional Items Each item of this array must be: root roles Role permissions document_templates document_templates items Type: string search_providers root roles Role permissions search_providers Type: array of string No Additional Items Each item of this array must be: root roles Role permissions search_providers search_providers items Type: string solr_facets root roles Role permissions solr_facets Type: array of string No Additional Items Each item of this array must be: root roles Role permissions solr_facets solr_facets items Type: string Generated using json-schema-for-humans on 2023-08-23 at 12:11:49 +0000","title":"Qwc services permissions"},{"location":"references/qwc2_plugins/","text":"Plugin reference API AttributeTable Authentication BackgroundSwitcher Bookmark BottomBar Cyclomedia DxfExport Editing FeatureForm HeightProfile Help HomeButton Identify LayerCatalog LayerTree LocateButton LoginUser MapPlugin MapComparePlugin MapCopyright MapInfoTooltip MapLegend MapTip Measure NewsPopup Print ProcessNotifications RasterExport Redlining Routing ScratchDrawing Settings Share StartupMarker TaskButton ThemeSwitcher TimeManager TopBar ZoomButton API Exposes an API for interacting with QWC2 via window.qwc2 . All following action functions are available: display layers locate map task theme windows I.e. setCurrentTask is available via window.qwc2.setCurrentTask . Additionally, the following functions are available: window.qwc2.addExternalLayer(resource, beforeLayerName = null) Convenience method for adding an external layer. resource : An external resource of the form wms:<service_url>#<layername> or wmts:<capabilities_url>#<layername> . beforeLayerName : Insert the new layer before the layer with the specified name. If null or the layer does not exist, the layer is inserted on top. window.qwc2.drawScratch(geomType, message, drawMultiple, callback, style = null) Draw scratch geometries, and return these as GeoJSON to the calling application. geomType : Point , LineString , Polygon , Circle or Box . message : A descriptive string to display in the tool taskbar. drawMultiple : Whether to allow drawing multiple geometries. callback : A function(result, crs) , the result being an array of GeoJSON features, and crs the projection of the feature coordinates. style : Optional, a custom style object to use for the drawn features, in the same format as DEFAULT_FEATURE_STYLE in qwc2/utils/FeatureStyles.js . window.qwc2.getState() Return the current application state. Property Type Description Default value AttributeTable Displaying the attribute table of layers in a dialog. To make a layer available in the attribute table, create a a data resource and matching permissions for it in the qwc-admin-gui . The attribute table works for both read-only as well as read-write data resources. This plugin queries the dataset via the editing service specified by editServiceUrl in config.json (by default the qwc-data-service ). Property Type Description Default value allowAddForGeometryLayers bool Whether to allow adding records for datasets which have a geometry column. undefined showEditFormButton bool Whether to show a button to open the edit form for selected layer. Requires the Editing plugin to be enabled. true zoomLevel number The zoom level for zooming to point features. 1000 Authentication Handles authentication Invokes the the authentication service specified by authServiceUrl in config.json . Property Type Description Default value clearLayerParam bool Whether to clear the layer parameter from the URL on login. undefined idleTimeout number An idle timeout in seconds after which the user is automatically logged of. undefined logoutTargetUrl string An URL to redirect to on logout, instead of the viewer URL. undefined requireLogin bool Whether authentication is required, i.e. the viewer automatically redirects to the login page if no user is authenticated. undefined BackgroundSwitcher Map button for switching the background layer. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). 0 Bookmark Allows managing user bookmarks. Bookmarks are only allowed for authenticated users. Requires permalinkServiceUrl to point to a qwc-permalink-service . Property Type Description Default value side string The side of the application on which to display the sidebar. 'right' BottomBar Bottom bar, displaying mouse coordinate, scale, etc. Property Type Description Default value displayCoordinates bool Whether to display the coordinates in the bottom bar. true displayScales bool Whether to display the scale in the bottom bar. true termsUrl string The URL of the terms label anchor. undefined termsUrlTarget string The target where to open the terms URL. If iframe , it will be displayed in an inline window, otherwise in a new tab. undefined viewertitleUrl string The URL of the viewer title label anchor. undefined viewertitleUrlTarget string The target where to open the viewer title URL. If iframe , it will be displayed in an inline window, otherwise in a new tab. undefined Cyclomedia Cyclomedia integration for QWC2. Property Type Description Default value apikey string The Cyclomedia API key undefined clientId string OAuth client ID. undefined cyclomediaVersion string The cyclomedia version. '23.6' displayMeasurements bool Whether to display Cyclomedia measurement geometries on the map. true geometry { initialWidth: number, initialHeight: number, initialX: number, initialY: number, initiallyDocked: bool, } Default window geometry. { initialWidth: 480, initialHeight: 640, initialX: 0, initialY: 0, initiallyDocked: true } loginRedirectUri string The relative path to the redirect login handling of oauth. undefined logoutRedirectUri string The relative path to the redirect logout handling of oauth. undefined maxMapScale number The maximum map scale above which the recordings WFS won't be displayed. 10000 projection string The projection to use for Cyclomedia. 'EPSG:3857' DxfExport Allows exporting a selected extent of the map as DXF. Uses the DXF format support of QGIS Server. Property Type Description Default value formatOptions string Optional format options to pass to QGIS Server via FORMAT_OPTIONS. undefined layerOptions [{ label: string, layers: string, }] Optional choice of layer sets to pass to QGIS Server via LAYERS. undefined serviceUrl string Optional URL invoked on export instead of the default QGIS Server URL. undefined Editing Allows editing geometries and attributes of datasets. The attribute form is generated from the QGIS attribute form configuration. This plugin queries the dataset via the editing service specified by editServiceUrl in config.json (by default the qwc-data-service ). Property Type Description Default value allowCloneGeometry bool Whether to enable the \"Clone existing geometry\" functionality. true side string The side of the application on which to display the sidebar. 'right' snapping bool Whether snapping is available when editing. true snappingActive bool Whether snapping is enabled by default when editing. true width string The default width of the editing sidebar, as a CSS width string. \"30em\" FeatureForm Displays queried feature attributes in a form. The attribute form is generated from the QGIS attribute form configuration. If the dataset it editable, allows editing the attributes directly in the displayed form. This plugin queries the feature via the editing service specified by editServiceUrl in config.json (by default the qwc-data-service ), rather than over WMS GetFeatureInfo like the Identify plugin. Can be used as default identify tool by setting \"identifyTool\": \"FeatureForm\" in config.json . Property Type Description Default value initialHeight number Initial height of the form window. 480 initialWidth number Initial width of the form window. 320 initialX number Initial x position of the form window. 0 initialY number Initial y position of the form window. 0 HeightProfile Displays a height profile along a measured line. Triggered automatically when a line is measured via the Measure plugin. Requires elevationServiceUrl in config.json to point to a qwc-elevation-service . Property Type Description Default value heighProfilePrecision number The precision of displayed and exported values (0: no decimals, 0.1: 1 decimal position, etc). 0 height number The height of the height profile widget in pixels. 100 samples number The number of elevation samples to query. 500 Help Displays a custom help dialog in a sidebar. Define the help contents by specifying the bodyContentsFragmentUrl prop. Property Type Description Default value bodyContentsFragmentUrl string URL to a document containing a HTML fragment to display in the Help sidebar. undefined side string The side of the application on which to display the sidebar. 'right' HomeButton Map button for reverting to the home extent of the theme. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). 5 Identify Displays queried feature attributes. Uses WMS GetFeatureInfo to query features and displays the result in table, as a HTML fragment or as plain text based on the supported GetFeatureInfo format. Extendable in combination with the qwc-feature-info-service , which provides support for customized queries and templates for the result presentation. Property Type Description Default value attributeCalculator func Optional function for computing derived attributes. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section. undefined attributeTransform func Optional function for transforming attribute values. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section. undefined clearResultsOnClose bool Whether to clear the identify results when exiting the identify tool. true customExporters array Optional list of custom exporters to offer along with the built-in exporters. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section. [] displayResultTree bool Whether to display a tree overview of results (as opposed to a flat list of results). true enableExport bool Whether to enable the export functionality. true featureInfoReturnsLayerName bool Whether to assume that XML GetFeatureInfo responses specify the technical layer name in the name attribute, rather than the layer title. true initialHeight number The initial height of the identify dialog. 320 initialWidth number The initial width of the identify dialog. 240 initialX number The initial x coordinate of the identify dialog. 0 initialY number The initial y coordinate of the identify dialog. 0 initiallyDocked bool Whether the identify dialog should be initially docked. undefined replaceImageUrls bool Whether to replace an attribute value containing an URL to an image with an inline image. true LayerCatalog Displays a pre-configured catalog of external layers in a window. Configured through a catalog JSON containing a tree of external layer identifiers. Example: { \"catalog\": [ { \"title\": \"Bauzonen\", \"resource\": \"wms:http://wms.geo.admin.ch#ch.are.bauzonen\" }, { \"title\": \"Gew\u00e4sserschutz\", \"resource\": \"wms:https://geo.so.ch/api/wms#ch.so.afu.gewaesserschutz[50]\" }, { \"title\": \"Landeskarten\", \"sublayers\": [ { \"title\": \"Landeskarte 1:1 Million | LK1000\", \"resource\": \"wms:http://wms.geo.admin.ch#ch.swisstopo.pixelkarte-farbe-pk1000.noscale\" }, { \"title\": \"Landeskarte 1:100`000 | LK100\", \"resource\": \"wms:http://wms.geo.admin.ch#ch.swisstopo.pixelkarte-farbe-pk100.noscale\" } ] } ] } Property Type Description Default value catalogUrl string The URL to the catalog JSON file. undefined windowSize { width: number, height: number, } The default window size. {width: 320, height: 320} LayerTree Displays the map layer tree in a sidebar. Property Type Description Default value addLayerSeparator func Whether to allow adding separator entries in the layer tree, useful for organizing the tree. undefined allowCompare bool Whether to enable the compare function. Requires the MapCompare plugin. true allowImport bool Whether to allow importing external layers. true allowMapTips bool Whether to allow enabling map tips. true bboxDependentLegend {bool, string} Whether to display a BBOX dependent legend. Can be true|false|\"theme\" , latter means only for theme layers. false enableLegendPrint bool Whether to enable the legend print functionality. true enableServiceInfo bool Whether to display a service info button to display the WMS service metadata. true enableVisibleFilter bool Whether to display a button to filter invisible layers from the layertree. true extraLegendParameters string Additional parameters to pass to the GetLegendGraphics request- undefined flattenGroups bool Whether to display a flat layer tree, omitting any groups. false grayUnchecked bool Whether to display unchecked layers gray in the layertree. true groupTogglesSublayers bool Whether toggling a group also toggles all sublayers. false infoInSettings bool Whether to display the layer info button inside the layer settings menu rather than next to the layer title. true layerInfoWindowSize { width: number, height: number, } The initial size of the layer info window. {width: 320, height: 480} mapTipsEnabled bool Whether map tips are enabled by default. undefined scaleDependentLegend {bool, string} Whether to display a scale dependent legend. Can be true|false|\"theme\" , latter means only for theme layers. undefined showLegendIcons bool Whether to display legend icons. true showQueryableIcon bool Whether to display the queryable icon to indicate that a layer is identifyable. true showRootEntry bool Whether to display the root entry of the layertree. true showToggleAllLayersCheckbox bool Whether to display a checkbox to toggle all layers. true side string The side of the application on which to display the sidebar. 'right' width string The initial width of the layertree, as a CSS width string. \"25em\" LocateButton Map button for controling the locate (GPS) state. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). 2 LoginUser Displays the currently logged in user. Property Type Description Default value MapPlugin The main map component. Property Type Description Default value mapOptions { zoomDuration: number, enableRotation: bool, rotation: number, panStepSize: number, panPageSize: number, } Zoom duration in ms, rotation in degrees, panStepSize and panPageSize as fraction of map width/height. {} showLoading bool Whether to display the loading spinner when layers are loading. true swipeGeometryTypeBlacklist [string] A list of layer geometry types to ignore when determining the top-most layer to compare. [] swipeLayerNameBlacklist [string] A list of layer names to ignore when determining the top-most layer to compare. You can use * as a whildcard character. [] toolsOptions object Map tool configuraiton options. Refer to the sample config.json. {} MapComparePlugin Allows comparing the top layer with the rest of the map. Activated through a checkbox in the LayerTree. Property Type Description Default value MapCopyright Displays layer attributions in the bottom right corner of the map. Property Type Description Default value prefixCopyrightsWithLayerNames bool Whether to prepend the layer name to the attribution string. undefined showThemeCopyrightOnly bool Whether to only display the attribution of the theme, omitting external layers. undefined MapInfoTooltip Provides map context information when right-clicking on the map. Displays the coordinates at the picked position by default. If elevationServiceUrl in config.json to points to a qwc-elevation-service , the height at the picked position is also displayed. If mapInfoService in config.json points to a qwc-mapinfo-service , additional custom information according to the qwc-mapinfo-service configuration is returned. Property Type Description Default value cooPrecision number The number of decimal places to display for metric/imperial coordinates. 0 degreeCooPrecision number The number of decimal places to display for degree coordinates. 4 elevationPrecision number The number of decimal places to display for elevation values. 0 MapLegend Displays the map legend in a floating dialog. The user can toggle whether to display only layers which are enabled, visible in the current extent and/or visible at the current scale. Property Type Description Default value addGroupTitles bool Whether to add group titles to the legend. false addLayerTitles bool Whether to add layer titles to the legend. Note that often the legend image itself already contains the layer title. false bboxDependentLegend bool Whether to display a BBOX-dependent legend by default. false extraLegendParameters string Extra parameters to add to the GetLegendGraphics request. undefined onlyVisibleLegend bool Whether to only include enabled layers in the legend by default. false scaleDependentLegend bool Whether to display a scale-dependent legend by default. false windowSize { width: number, height: number, } The default window size. {width: 320, height: 320} MapTip Displays maptips by hovering over features on the map. Queries the map tips configured in the QGIS layer properites over GetFeatureInfo. The map tip needs to be configured in QGIS Layer Properties \u2192 Display. Property Type Description Default value layerFeatureCount number The maximum number of feature maptips to display for a single layer. 5 Measure Allows measuring points/lines/areas on the map. Property Type Description Default value showMeasureModeSwitcher bool Whether to show the widget to switch between measure modes. true snapping bool Whether snapping is available when editing. true snappingActive bool Whether snapping is enabled by default when editing. true NewsPopup Displays a newsletter in a popup dialog. The popup won't be dispayed anymore, if the user chooses so, until a newer revision is published (specified via newsRev prop). Property Type Description Default value newsDocument string URL to the news HTML document to display in the popup. undefined newsRev string Revision of the document. undefined Print Invokes QGIS Server WMS GetPrint to print the map to PDF. Uses the print layouts defined in the QGIS project. Property Type Description Default value allowGeoPdfExport bool Whether to allow GeoPDF export. Requires QGIS Server 3.32 or newer. undefined defaultDpi number The default print dpi. 300 defaultScaleFactor number The factor to apply to the map scale to determine the initial print map scale. 0.5 displayRotation bool Whether to display the map rotation control. true gridInitiallyEnabled bool Whether the grid is enabled by default. false hideAutopopulatedFields bool Whether to hide form fields which contain autopopulated values (i.e. search result label). undefined inlinePrintOutput bool Whether to display the print output in an inline dialog instead triggering a download. false printExternalLayers bool Whether to print external layers. Requires QGIS Server 3.x! true scaleFactor number Scale factor to apply to line widths, font sizes, ... of redlining drawings passed to GetPrint. 1.9 side string The side of the application on which to display the sidebar. 'right' ProcessNotifications Adds support for displaying notifications of background processes. Only useful for third-party plugins which use this functionality. Property Type Description Default value RasterExport Allows exporting a selected portion of the map to an image (\"screenshot\"). Property Type Description Default value allowedFormats [string] Whitelist of allowed export format mimetypes. If empty, supported formats are listed. undefined allowedScales [number] List of scales at which to export the map. undefined defaultFormat string Default export format mimetype. If empty, first available format is used. undefined defaultScaleFactor number The factor to apply to the map scale to determine the initial export map scale. 0.5 dpis [number] List of dpis at which to export the map. If empty, the default server dpi is used. undefined exportExternalLayers bool Whether to include external layers in the image. Requires QGIS Server 3.x! true pageSizes [{ name: string, width: number, height: number, }] List of image sizes to offer, in addition to the free-hand selection. The width and height are in millimeters. [ {name: '15 x 15 cm', width: 150, height: 150}, {name: '30 x 30 cm', width: 300, height: 300} ] side string The side of the application on which to display the sidebar. 'right' Redlining Allows drawing figures and text labels on the map. Property Type Description Default value allowGeometryLabels bool Whether to allow labeling geometric figures. true snapping bool Whether snapping is available when editing. true snappingActive bool Whether snapping is enabled by default when editing. true Routing Compute routes and isochrones. Requites routingServiceUrl in config.json pointing to a Valhalla routing service. Property Type Description Default value enabledModes [string] List of enabled routing modes. [\"auto\", \"heavyvehicle\", \"transit\", \"bicycle\", \"pedestrian\"] enabledProviders [string] List of search providers to use for routing location search. [\"coordinates\", \"nominatim\"] geometry { initialWidth: number, initialHeight: number, initialX: number, initialY: number, initiallyDocked: bool, } Default window geometry. { initialWidth: 320, initialHeight: 640, initialX: 0, initialY: 0, initiallyDocked: true } ScratchDrawing Task which which can be invoked by other tools to draw a geometry and pass it to a callback. Only useful for third-party code, i.e. over the JavaScript API. Invoke as setCurrentTask(\"ScratchDrawing\", null, null, {callback: <function(features, crs)>}); Property Type Description Default value Settings Settings panel. Allows configuring language and color scheme. Property Type Description Default value colorSchemes [{ title: string, titleMsgId: string, value: string, }] List of available color schemes. Value is the css class name, title/titleMsgId the display name. [] languages array List of available languages. Value is the lang code, title/titleMsgId the display name. [] side string The side of the application on which to display the sidebar. 'right' Share Share the current map as a URL/permalink. Compact permalinks will be generated if permalinkServiceUrl in config.json points to a qwc-permalink-service . Property Type Description Default value showLink bool Show the map URL. true showQRCode bool Show the QR code of the map URL. true showSocials {bool, [string]} Show the social buttons. Either true or false to enable/disable all, or an array of specific buttons to display (possible choices: email , facebook , twitter , linkedin , whatsapp ). true side string The side of the application on which to display the sidebar. 'right' StartupMarker Displays a marker when starting up the viewer. The marked is displayed in the center of the map if c=<x>,<y>&hc=1 is set in the URL. Property Type Description Default value removeMode string When to remove the marker. Possible choices: onpan, onzoom, onclickonmarker. 'onpan' TaskButton Generic map button to launch a task. Property Type Description Default value icon string The icon name. undefined mode string The task mode. undefined position number The position slot index of the map button, from the bottom (0: bottom slot). 1 task string The task name. undefined ThemeSwitcher Theme switcher panel. Property Type Description Default value collapsibleGroups bool Whether to allow collapsing theme groups. undefined showLayerAfterChangeTheme bool Whether to show the LayerTree by default after switching the theme. false side string The side of the application on which to display the sidebar. 'right' themeLayersListWindowSize { width: number, height: number, } The default window size for the theme layers dialog. {width: 400, height: 300} width string Default width as a CSS string. \"50%\" TimeManager Allows controling the time dimension of temporal WMS layers. Property Type Description Default value cursorFormat string The format of the time cursor label. Either date , time or datetime . \"datetime\" dateFormat string The date format in the time controls, i.e. YYYY-MM-DD. \"YYYY-MM-DD[\\n]HH:mm:ss\" defaultAnimationInterval number The default interval for the temporal animation, in seconds. 1 defaultEnabled bool Default for TimeManager enabled when loading application. true or false false defaultFeatureCount number The default number of features that will be requested. 100 defaultStepSize number The default step size for the temporal animation, in step units. 1 defaultStepUnit string The default step unit for the temporal animation, one of ms , s , m , d , M , y , 10y , 100y \"d\" defaultTimelineDisplay string The default timeline display mode. One of hidden , minimal , features , layers . undefined defaultTimelineMode string The default timeline mode. One of fixed , infinite . \"fixed\" markerConfiguration { markersAvailable: bool, gradient: [string], markerOffset: array, markerPins: bool, } The feature marker configuration. { markersAvailable: true, gradient: [\"#f7af7d\", \"#eacc6e\", \"#fef89a\", \"#c5e09b\", \"#a3d29c\", \"#7cc096\", \"#79c8c5\", \"#34afce\"], markerOffset: [0, 0], markerPins: true } stepUnits [string] The available temporal anumation step units. [\"s\", \"m\", \"h\", \"d\", \"M\", \"y\"] TopBar Top bar, containing the logo, searchbar, task buttons and app menu. Property Type Description Default value appMenuClearsTask bool Whether opening the app menu clears the active task. undefined appMenuFilterField bool Whether to display the filter field in the app menu. undefined appMenuShortcut string The shortcut for tiggering the app menu, i.e. alt+shift+m. undefined appMenuVisibleOnStartup bool Whether to open the app menu on application startup. undefined logoFormat string The logo file format. \"svg\" logoSrc string The logo image URL if a different source than the default assets/img/logo. and assets/img/logo-mobile. is desired. undefined logoUrl string The hyperlink to open when the logo is clicked. undefined menuItems array The menu items. Refer to the corresponding chapter of the viewer documentation and the sample config.json. [] searchOptions object Options passed down to the search component. See the searchOption propType of the used search component. {} toolbarItems array The toolbar. Refer to the corresponding chapter of the viewer documentation and the sample config.json. [] toolbarItemsShortcutPrefix string The keyboard shortcut prefix for triggering toolbar tasks. I.e. alt+shift. The task are then triggered by +{1,2,3,...} for the 1st, 2nd, 3rd... toolbar icon. undefined ZoomButton Map button for zooming the map. Two specific plugins exist: ZoomInPlugin and ZoomOutPlugin, which are instances of ZoomButton for the respective zoom directions. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). undefined","title":"Qwc2 plugins"},{"location":"references/qwc2_plugins/#plugin-reference","text":"API AttributeTable Authentication BackgroundSwitcher Bookmark BottomBar Cyclomedia DxfExport Editing FeatureForm HeightProfile Help HomeButton Identify LayerCatalog LayerTree LocateButton LoginUser MapPlugin MapComparePlugin MapCopyright MapInfoTooltip MapLegend MapTip Measure NewsPopup Print ProcessNotifications RasterExport Redlining Routing ScratchDrawing Settings Share StartupMarker TaskButton ThemeSwitcher TimeManager TopBar ZoomButton","title":"Plugin reference"},{"location":"references/qwc2_plugins/#api","text":"Exposes an API for interacting with QWC2 via window.qwc2 . All following action functions are available: display layers locate map task theme windows I.e. setCurrentTask is available via window.qwc2.setCurrentTask . Additionally, the following functions are available: window.qwc2.addExternalLayer(resource, beforeLayerName = null) Convenience method for adding an external layer. resource : An external resource of the form wms:<service_url>#<layername> or wmts:<capabilities_url>#<layername> . beforeLayerName : Insert the new layer before the layer with the specified name. If null or the layer does not exist, the layer is inserted on top. window.qwc2.drawScratch(geomType, message, drawMultiple, callback, style = null) Draw scratch geometries, and return these as GeoJSON to the calling application. geomType : Point , LineString , Polygon , Circle or Box . message : A descriptive string to display in the tool taskbar. drawMultiple : Whether to allow drawing multiple geometries. callback : A function(result, crs) , the result being an array of GeoJSON features, and crs the projection of the feature coordinates. style : Optional, a custom style object to use for the drawn features, in the same format as DEFAULT_FEATURE_STYLE in qwc2/utils/FeatureStyles.js . window.qwc2.getState() Return the current application state. Property Type Description Default value","title":"API"},{"location":"references/qwc2_plugins/#attributetable","text":"Displaying the attribute table of layers in a dialog. To make a layer available in the attribute table, create a a data resource and matching permissions for it in the qwc-admin-gui . The attribute table works for both read-only as well as read-write data resources. This plugin queries the dataset via the editing service specified by editServiceUrl in config.json (by default the qwc-data-service ). Property Type Description Default value allowAddForGeometryLayers bool Whether to allow adding records for datasets which have a geometry column. undefined showEditFormButton bool Whether to show a button to open the edit form for selected layer. Requires the Editing plugin to be enabled. true zoomLevel number The zoom level for zooming to point features. 1000","title":"AttributeTable"},{"location":"references/qwc2_plugins/#authentication","text":"Handles authentication Invokes the the authentication service specified by authServiceUrl in config.json . Property Type Description Default value clearLayerParam bool Whether to clear the layer parameter from the URL on login. undefined idleTimeout number An idle timeout in seconds after which the user is automatically logged of. undefined logoutTargetUrl string An URL to redirect to on logout, instead of the viewer URL. undefined requireLogin bool Whether authentication is required, i.e. the viewer automatically redirects to the login page if no user is authenticated. undefined","title":"Authentication"},{"location":"references/qwc2_plugins/#backgroundswitcher","text":"Map button for switching the background layer. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). 0","title":"BackgroundSwitcher"},{"location":"references/qwc2_plugins/#bookmark","text":"Allows managing user bookmarks. Bookmarks are only allowed for authenticated users. Requires permalinkServiceUrl to point to a qwc-permalink-service . Property Type Description Default value side string The side of the application on which to display the sidebar. 'right'","title":"Bookmark"},{"location":"references/qwc2_plugins/#bottombar","text":"Bottom bar, displaying mouse coordinate, scale, etc. Property Type Description Default value displayCoordinates bool Whether to display the coordinates in the bottom bar. true displayScales bool Whether to display the scale in the bottom bar. true termsUrl string The URL of the terms label anchor. undefined termsUrlTarget string The target where to open the terms URL. If iframe , it will be displayed in an inline window, otherwise in a new tab. undefined viewertitleUrl string The URL of the viewer title label anchor. undefined viewertitleUrlTarget string The target where to open the viewer title URL. If iframe , it will be displayed in an inline window, otherwise in a new tab. undefined","title":"BottomBar"},{"location":"references/qwc2_plugins/#cyclomedia","text":"Cyclomedia integration for QWC2. Property Type Description Default value apikey string The Cyclomedia API key undefined clientId string OAuth client ID. undefined cyclomediaVersion string The cyclomedia version. '23.6' displayMeasurements bool Whether to display Cyclomedia measurement geometries on the map. true geometry { initialWidth: number, initialHeight: number, initialX: number, initialY: number, initiallyDocked: bool, } Default window geometry. { initialWidth: 480, initialHeight: 640, initialX: 0, initialY: 0, initiallyDocked: true } loginRedirectUri string The relative path to the redirect login handling of oauth. undefined logoutRedirectUri string The relative path to the redirect logout handling of oauth. undefined maxMapScale number The maximum map scale above which the recordings WFS won't be displayed. 10000 projection string The projection to use for Cyclomedia. 'EPSG:3857'","title":"Cyclomedia"},{"location":"references/qwc2_plugins/#dxfexport","text":"Allows exporting a selected extent of the map as DXF. Uses the DXF format support of QGIS Server. Property Type Description Default value formatOptions string Optional format options to pass to QGIS Server via FORMAT_OPTIONS. undefined layerOptions [{ label: string, layers: string, }] Optional choice of layer sets to pass to QGIS Server via LAYERS. undefined serviceUrl string Optional URL invoked on export instead of the default QGIS Server URL. undefined","title":"DxfExport"},{"location":"references/qwc2_plugins/#editing","text":"Allows editing geometries and attributes of datasets. The attribute form is generated from the QGIS attribute form configuration. This plugin queries the dataset via the editing service specified by editServiceUrl in config.json (by default the qwc-data-service ). Property Type Description Default value allowCloneGeometry bool Whether to enable the \"Clone existing geometry\" functionality. true side string The side of the application on which to display the sidebar. 'right' snapping bool Whether snapping is available when editing. true snappingActive bool Whether snapping is enabled by default when editing. true width string The default width of the editing sidebar, as a CSS width string. \"30em\"","title":"Editing"},{"location":"references/qwc2_plugins/#featureform","text":"Displays queried feature attributes in a form. The attribute form is generated from the QGIS attribute form configuration. If the dataset it editable, allows editing the attributes directly in the displayed form. This plugin queries the feature via the editing service specified by editServiceUrl in config.json (by default the qwc-data-service ), rather than over WMS GetFeatureInfo like the Identify plugin. Can be used as default identify tool by setting \"identifyTool\": \"FeatureForm\" in config.json . Property Type Description Default value initialHeight number Initial height of the form window. 480 initialWidth number Initial width of the form window. 320 initialX number Initial x position of the form window. 0 initialY number Initial y position of the form window. 0","title":"FeatureForm"},{"location":"references/qwc2_plugins/#heightprofile","text":"Displays a height profile along a measured line. Triggered automatically when a line is measured via the Measure plugin. Requires elevationServiceUrl in config.json to point to a qwc-elevation-service . Property Type Description Default value heighProfilePrecision number The precision of displayed and exported values (0: no decimals, 0.1: 1 decimal position, etc). 0 height number The height of the height profile widget in pixels. 100 samples number The number of elevation samples to query. 500","title":"HeightProfile"},{"location":"references/qwc2_plugins/#help","text":"Displays a custom help dialog in a sidebar. Define the help contents by specifying the bodyContentsFragmentUrl prop. Property Type Description Default value bodyContentsFragmentUrl string URL to a document containing a HTML fragment to display in the Help sidebar. undefined side string The side of the application on which to display the sidebar. 'right'","title":"Help"},{"location":"references/qwc2_plugins/#homebutton","text":"Map button for reverting to the home extent of the theme. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). 5","title":"HomeButton"},{"location":"references/qwc2_plugins/#identify","text":"Displays queried feature attributes. Uses WMS GetFeatureInfo to query features and displays the result in table, as a HTML fragment or as plain text based on the supported GetFeatureInfo format. Extendable in combination with the qwc-feature-info-service , which provides support for customized queries and templates for the result presentation. Property Type Description Default value attributeCalculator func Optional function for computing derived attributes. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section. undefined attributeTransform func Optional function for transforming attribute values. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section. undefined clearResultsOnClose bool Whether to clear the identify results when exiting the identify tool. true customExporters array Optional list of custom exporters to offer along with the built-in exporters. See js/IdentifyExtensions.js for details. This prop can be specified in the appConfig.js cfg section. [] displayResultTree bool Whether to display a tree overview of results (as opposed to a flat list of results). true enableExport bool Whether to enable the export functionality. true featureInfoReturnsLayerName bool Whether to assume that XML GetFeatureInfo responses specify the technical layer name in the name attribute, rather than the layer title. true initialHeight number The initial height of the identify dialog. 320 initialWidth number The initial width of the identify dialog. 240 initialX number The initial x coordinate of the identify dialog. 0 initialY number The initial y coordinate of the identify dialog. 0 initiallyDocked bool Whether the identify dialog should be initially docked. undefined replaceImageUrls bool Whether to replace an attribute value containing an URL to an image with an inline image. true","title":"Identify"},{"location":"references/qwc2_plugins/#layercatalog","text":"Displays a pre-configured catalog of external layers in a window. Configured through a catalog JSON containing a tree of external layer identifiers. Example: { \"catalog\": [ { \"title\": \"Bauzonen\", \"resource\": \"wms:http://wms.geo.admin.ch#ch.are.bauzonen\" }, { \"title\": \"Gew\u00e4sserschutz\", \"resource\": \"wms:https://geo.so.ch/api/wms#ch.so.afu.gewaesserschutz[50]\" }, { \"title\": \"Landeskarten\", \"sublayers\": [ { \"title\": \"Landeskarte 1:1 Million | LK1000\", \"resource\": \"wms:http://wms.geo.admin.ch#ch.swisstopo.pixelkarte-farbe-pk1000.noscale\" }, { \"title\": \"Landeskarte 1:100`000 | LK100\", \"resource\": \"wms:http://wms.geo.admin.ch#ch.swisstopo.pixelkarte-farbe-pk100.noscale\" } ] } ] } Property Type Description Default value catalogUrl string The URL to the catalog JSON file. undefined windowSize { width: number, height: number, } The default window size. {width: 320, height: 320}","title":"LayerCatalog"},{"location":"references/qwc2_plugins/#layertree","text":"Displays the map layer tree in a sidebar. Property Type Description Default value addLayerSeparator func Whether to allow adding separator entries in the layer tree, useful for organizing the tree. undefined allowCompare bool Whether to enable the compare function. Requires the MapCompare plugin. true allowImport bool Whether to allow importing external layers. true allowMapTips bool Whether to allow enabling map tips. true bboxDependentLegend {bool, string} Whether to display a BBOX dependent legend. Can be true|false|\"theme\" , latter means only for theme layers. false enableLegendPrint bool Whether to enable the legend print functionality. true enableServiceInfo bool Whether to display a service info button to display the WMS service metadata. true enableVisibleFilter bool Whether to display a button to filter invisible layers from the layertree. true extraLegendParameters string Additional parameters to pass to the GetLegendGraphics request- undefined flattenGroups bool Whether to display a flat layer tree, omitting any groups. false grayUnchecked bool Whether to display unchecked layers gray in the layertree. true groupTogglesSublayers bool Whether toggling a group also toggles all sublayers. false infoInSettings bool Whether to display the layer info button inside the layer settings menu rather than next to the layer title. true layerInfoWindowSize { width: number, height: number, } The initial size of the layer info window. {width: 320, height: 480} mapTipsEnabled bool Whether map tips are enabled by default. undefined scaleDependentLegend {bool, string} Whether to display a scale dependent legend. Can be true|false|\"theme\" , latter means only for theme layers. undefined showLegendIcons bool Whether to display legend icons. true showQueryableIcon bool Whether to display the queryable icon to indicate that a layer is identifyable. true showRootEntry bool Whether to display the root entry of the layertree. true showToggleAllLayersCheckbox bool Whether to display a checkbox to toggle all layers. true side string The side of the application on which to display the sidebar. 'right' width string The initial width of the layertree, as a CSS width string. \"25em\"","title":"LayerTree"},{"location":"references/qwc2_plugins/#locatebutton","text":"Map button for controling the locate (GPS) state. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). 2","title":"LocateButton"},{"location":"references/qwc2_plugins/#loginuser","text":"Displays the currently logged in user. Property Type Description Default value","title":"LoginUser"},{"location":"references/qwc2_plugins/#mapplugin","text":"The main map component. Property Type Description Default value mapOptions { zoomDuration: number, enableRotation: bool, rotation: number, panStepSize: number, panPageSize: number, } Zoom duration in ms, rotation in degrees, panStepSize and panPageSize as fraction of map width/height. {} showLoading bool Whether to display the loading spinner when layers are loading. true swipeGeometryTypeBlacklist [string] A list of layer geometry types to ignore when determining the top-most layer to compare. [] swipeLayerNameBlacklist [string] A list of layer names to ignore when determining the top-most layer to compare. You can use * as a whildcard character. [] toolsOptions object Map tool configuraiton options. Refer to the sample config.json. {}","title":"MapPlugin"},{"location":"references/qwc2_plugins/#mapcompareplugin","text":"Allows comparing the top layer with the rest of the map. Activated through a checkbox in the LayerTree. Property Type Description Default value","title":"MapComparePlugin"},{"location":"references/qwc2_plugins/#mapcopyright","text":"Displays layer attributions in the bottom right corner of the map. Property Type Description Default value prefixCopyrightsWithLayerNames bool Whether to prepend the layer name to the attribution string. undefined showThemeCopyrightOnly bool Whether to only display the attribution of the theme, omitting external layers. undefined","title":"MapCopyright"},{"location":"references/qwc2_plugins/#mapinfotooltip","text":"Provides map context information when right-clicking on the map. Displays the coordinates at the picked position by default. If elevationServiceUrl in config.json to points to a qwc-elevation-service , the height at the picked position is also displayed. If mapInfoService in config.json points to a qwc-mapinfo-service , additional custom information according to the qwc-mapinfo-service configuration is returned. Property Type Description Default value cooPrecision number The number of decimal places to display for metric/imperial coordinates. 0 degreeCooPrecision number The number of decimal places to display for degree coordinates. 4 elevationPrecision number The number of decimal places to display for elevation values. 0","title":"MapInfoTooltip"},{"location":"references/qwc2_plugins/#maplegend","text":"Displays the map legend in a floating dialog. The user can toggle whether to display only layers which are enabled, visible in the current extent and/or visible at the current scale. Property Type Description Default value addGroupTitles bool Whether to add group titles to the legend. false addLayerTitles bool Whether to add layer titles to the legend. Note that often the legend image itself already contains the layer title. false bboxDependentLegend bool Whether to display a BBOX-dependent legend by default. false extraLegendParameters string Extra parameters to add to the GetLegendGraphics request. undefined onlyVisibleLegend bool Whether to only include enabled layers in the legend by default. false scaleDependentLegend bool Whether to display a scale-dependent legend by default. false windowSize { width: number, height: number, } The default window size. {width: 320, height: 320}","title":"MapLegend"},{"location":"references/qwc2_plugins/#maptip","text":"Displays maptips by hovering over features on the map. Queries the map tips configured in the QGIS layer properites over GetFeatureInfo. The map tip needs to be configured in QGIS Layer Properties \u2192 Display. Property Type Description Default value layerFeatureCount number The maximum number of feature maptips to display for a single layer. 5","title":"MapTip"},{"location":"references/qwc2_plugins/#measure","text":"Allows measuring points/lines/areas on the map. Property Type Description Default value showMeasureModeSwitcher bool Whether to show the widget to switch between measure modes. true snapping bool Whether snapping is available when editing. true snappingActive bool Whether snapping is enabled by default when editing. true","title":"Measure"},{"location":"references/qwc2_plugins/#newspopup","text":"Displays a newsletter in a popup dialog. The popup won't be dispayed anymore, if the user chooses so, until a newer revision is published (specified via newsRev prop). Property Type Description Default value newsDocument string URL to the news HTML document to display in the popup. undefined newsRev string Revision of the document. undefined","title":"NewsPopup"},{"location":"references/qwc2_plugins/#print","text":"Invokes QGIS Server WMS GetPrint to print the map to PDF. Uses the print layouts defined in the QGIS project. Property Type Description Default value allowGeoPdfExport bool Whether to allow GeoPDF export. Requires QGIS Server 3.32 or newer. undefined defaultDpi number The default print dpi. 300 defaultScaleFactor number The factor to apply to the map scale to determine the initial print map scale. 0.5 displayRotation bool Whether to display the map rotation control. true gridInitiallyEnabled bool Whether the grid is enabled by default. false hideAutopopulatedFields bool Whether to hide form fields which contain autopopulated values (i.e. search result label). undefined inlinePrintOutput bool Whether to display the print output in an inline dialog instead triggering a download. false printExternalLayers bool Whether to print external layers. Requires QGIS Server 3.x! true scaleFactor number Scale factor to apply to line widths, font sizes, ... of redlining drawings passed to GetPrint. 1.9 side string The side of the application on which to display the sidebar. 'right'","title":"Print"},{"location":"references/qwc2_plugins/#processnotifications","text":"Adds support for displaying notifications of background processes. Only useful for third-party plugins which use this functionality. Property Type Description Default value","title":"ProcessNotifications"},{"location":"references/qwc2_plugins/#rasterexport","text":"Allows exporting a selected portion of the map to an image (\"screenshot\"). Property Type Description Default value allowedFormats [string] Whitelist of allowed export format mimetypes. If empty, supported formats are listed. undefined allowedScales [number] List of scales at which to export the map. undefined defaultFormat string Default export format mimetype. If empty, first available format is used. undefined defaultScaleFactor number The factor to apply to the map scale to determine the initial export map scale. 0.5 dpis [number] List of dpis at which to export the map. If empty, the default server dpi is used. undefined exportExternalLayers bool Whether to include external layers in the image. Requires QGIS Server 3.x! true pageSizes [{ name: string, width: number, height: number, }] List of image sizes to offer, in addition to the free-hand selection. The width and height are in millimeters. [ {name: '15 x 15 cm', width: 150, height: 150}, {name: '30 x 30 cm', width: 300, height: 300} ] side string The side of the application on which to display the sidebar. 'right'","title":"RasterExport"},{"location":"references/qwc2_plugins/#redlining","text":"Allows drawing figures and text labels on the map. Property Type Description Default value allowGeometryLabels bool Whether to allow labeling geometric figures. true snapping bool Whether snapping is available when editing. true snappingActive bool Whether snapping is enabled by default when editing. true","title":"Redlining"},{"location":"references/qwc2_plugins/#routing","text":"Compute routes and isochrones. Requites routingServiceUrl in config.json pointing to a Valhalla routing service. Property Type Description Default value enabledModes [string] List of enabled routing modes. [\"auto\", \"heavyvehicle\", \"transit\", \"bicycle\", \"pedestrian\"] enabledProviders [string] List of search providers to use for routing location search. [\"coordinates\", \"nominatim\"] geometry { initialWidth: number, initialHeight: number, initialX: number, initialY: number, initiallyDocked: bool, } Default window geometry. { initialWidth: 320, initialHeight: 640, initialX: 0, initialY: 0, initiallyDocked: true }","title":"Routing"},{"location":"references/qwc2_plugins/#scratchdrawing","text":"Task which which can be invoked by other tools to draw a geometry and pass it to a callback. Only useful for third-party code, i.e. over the JavaScript API. Invoke as setCurrentTask(\"ScratchDrawing\", null, null, {callback: <function(features, crs)>}); Property Type Description Default value","title":"ScratchDrawing"},{"location":"references/qwc2_plugins/#settings","text":"Settings panel. Allows configuring language and color scheme. Property Type Description Default value colorSchemes [{ title: string, titleMsgId: string, value: string, }] List of available color schemes. Value is the css class name, title/titleMsgId the display name. [] languages array List of available languages. Value is the lang code, title/titleMsgId the display name. [] side string The side of the application on which to display the sidebar. 'right'","title":"Settings"},{"location":"references/qwc2_plugins/#share","text":"Share the current map as a URL/permalink. Compact permalinks will be generated if permalinkServiceUrl in config.json points to a qwc-permalink-service . Property Type Description Default value showLink bool Show the map URL. true showQRCode bool Show the QR code of the map URL. true showSocials {bool, [string]} Show the social buttons. Either true or false to enable/disable all, or an array of specific buttons to display (possible choices: email , facebook , twitter , linkedin , whatsapp ). true side string The side of the application on which to display the sidebar. 'right'","title":"Share"},{"location":"references/qwc2_plugins/#startupmarker","text":"Displays a marker when starting up the viewer. The marked is displayed in the center of the map if c=<x>,<y>&hc=1 is set in the URL. Property Type Description Default value removeMode string When to remove the marker. Possible choices: onpan, onzoom, onclickonmarker. 'onpan'","title":"StartupMarker"},{"location":"references/qwc2_plugins/#taskbutton","text":"Generic map button to launch a task. Property Type Description Default value icon string The icon name. undefined mode string The task mode. undefined position number The position slot index of the map button, from the bottom (0: bottom slot). 1 task string The task name. undefined","title":"TaskButton"},{"location":"references/qwc2_plugins/#themeswitcher","text":"Theme switcher panel. Property Type Description Default value collapsibleGroups bool Whether to allow collapsing theme groups. undefined showLayerAfterChangeTheme bool Whether to show the LayerTree by default after switching the theme. false side string The side of the application on which to display the sidebar. 'right' themeLayersListWindowSize { width: number, height: number, } The default window size for the theme layers dialog. {width: 400, height: 300} width string Default width as a CSS string. \"50%\"","title":"ThemeSwitcher"},{"location":"references/qwc2_plugins/#timemanager","text":"Allows controling the time dimension of temporal WMS layers. Property Type Description Default value cursorFormat string The format of the time cursor label. Either date , time or datetime . \"datetime\" dateFormat string The date format in the time controls, i.e. YYYY-MM-DD. \"YYYY-MM-DD[\\n]HH:mm:ss\" defaultAnimationInterval number The default interval for the temporal animation, in seconds. 1 defaultEnabled bool Default for TimeManager enabled when loading application. true or false false defaultFeatureCount number The default number of features that will be requested. 100 defaultStepSize number The default step size for the temporal animation, in step units. 1 defaultStepUnit string The default step unit for the temporal animation, one of ms , s , m , d , M , y , 10y , 100y \"d\" defaultTimelineDisplay string The default timeline display mode. One of hidden , minimal , features , layers . undefined defaultTimelineMode string The default timeline mode. One of fixed , infinite . \"fixed\" markerConfiguration { markersAvailable: bool, gradient: [string], markerOffset: array, markerPins: bool, } The feature marker configuration. { markersAvailable: true, gradient: [\"#f7af7d\", \"#eacc6e\", \"#fef89a\", \"#c5e09b\", \"#a3d29c\", \"#7cc096\", \"#79c8c5\", \"#34afce\"], markerOffset: [0, 0], markerPins: true } stepUnits [string] The available temporal anumation step units. [\"s\", \"m\", \"h\", \"d\", \"M\", \"y\"]","title":"TimeManager"},{"location":"references/qwc2_plugins/#topbar","text":"Top bar, containing the logo, searchbar, task buttons and app menu. Property Type Description Default value appMenuClearsTask bool Whether opening the app menu clears the active task. undefined appMenuFilterField bool Whether to display the filter field in the app menu. undefined appMenuShortcut string The shortcut for tiggering the app menu, i.e. alt+shift+m. undefined appMenuVisibleOnStartup bool Whether to open the app menu on application startup. undefined logoFormat string The logo file format. \"svg\" logoSrc string The logo image URL if a different source than the default assets/img/logo. and assets/img/logo-mobile. is desired. undefined logoUrl string The hyperlink to open when the logo is clicked. undefined menuItems array The menu items. Refer to the corresponding chapter of the viewer documentation and the sample config.json. [] searchOptions object Options passed down to the search component. See the searchOption propType of the used search component. {} toolbarItems array The toolbar. Refer to the corresponding chapter of the viewer documentation and the sample config.json. [] toolbarItemsShortcutPrefix string The keyboard shortcut prefix for triggering toolbar tasks. I.e. alt+shift. The task are then triggered by +{1,2,3,...} for the 1st, 2nd, 3rd... toolbar icon. undefined","title":"TopBar"},{"location":"references/qwc2_plugins/#zoombutton","text":"Map button for zooming the map. Two specific plugins exist: ZoomInPlugin and ZoomOutPlugin, which are instances of ZoomButton for the respective zoom directions. Property Type Description Default value position number The position slot index of the map button, from the bottom (0: bottom slot). undefined","title":"ZoomButton"},{"location":"release_notes/QWC2UpgradeNotes/","text":"Upgrade notes This document describes incompatibilites and other aspects which QWC2 applications need to address when updating against the latest qwc2 submodule. When updating the qwc2 submodule, run yarn install to ensure the dependencies are up to date! Update to qwc2 submodule revision 7409372 (23.08.2023) MapInfoToolTip plugin instantation change The instantation of the MapInfoToolTip in appConfig.js needs to be changed to MapInfoTooltipPlugin: MapInfoTooltipPlugin(), Note the extra braces at the end. As a new feature, you can pass a list of plugins to the MapInfoTooltipPlugin . Configuration changes The window size configuration of various plugins has been uniformized to the geometry config prop (rather than occasionally windowSize before). Affected plugins are: FeatureForm , Identify , LayerCatalog , LayerTree , MapLegend . Please check the respective plugin reference for more details on the new format. Update to qwc2 submodule revision 96aaa51 (09.02.2023) Config setting change Geodesic measurement mode is now configured at toplevel in config.json via geodesicMeasurements: true|false rather than below Map -> cfg -> toolsOptions -> MeasurementSupport . Update to qwc2 submodule revision 7a474e3 (23.01.2023) Dependency update Most dependencies have been updated to the latest version. The following adjustments need to be performed by hand: Use createRoot in app.jsx , see the demo app.jsx . Update uuid imports in external components, examples: import {v1 as uuidv1} from 'uuid'; import {v4 as uuidv4} from 'uuid'; and then instead of uuid.v1() use uuidv1() etc. Adjust webpack.config.js from { test: /.mjs$/, type: 'javascript/auto' } to { test: /(.mjs|.js)$/, type: 'javascript/auto' } Update to qwc2 submodule revision fe063b6 (13.01.2023) Reworked search provider support The arguments and expected behaviour of the provider onSearch and getResultGeometry have changed. Please refer to the documentation chapter in the Documentation . Consult js/SearchProviders.js and static/assets/searchProviders.js for full examples. It is now possible to define search providers in a external JS file loaded at runtime rather than compiled into the application bundle. See static/assets/searchProviders.js , which is loaded by index.html . js/SearchProviders.js now only includes coordinates and nominatim as built-in search providers for the demo application. The searchProviderFactory function has been removed from js/SearchProviders.js . Instead, custom parameters to be passed to a provider can be specified directly in the theme item searchProviders entry: { key: \"<providerkey2>\", params: {...} } and read from searchParams.cfgParams in the provider onSearch function. Load Help dialog contents from HTML fragment Instead of requiring users to implement the renderHelp function in js/Help.jsx , for simple cases the users can provide a plain HTML fragment which is loaded at runtime from the assets. Consult the Documentation . Update to qwc2 submodule revision 90c613a (28.11.2022) Reworked color scheme support The styleConfig.js file is deprecated and won't be honoured anymore for the styling of core QWC2 components. Instead, base theme colors can be defined via CSS, refer to documentation for details. Renamed config variable The maxGetUrlLength variable in config.json has been renamed to wmsMaxGetUrlLength . Update to qwc2 submodule revision e357152 (27.06.2022) Reworked interface for handling 1:N relations between qwc2 and qwc-data-service The interface for reading and writing 1:n relations between the qwc2 and the qwc-data-service was reworked. If you are using the qwc-data-service, make sure to update to qwc-data-service-v2022.06.27 or later when updating to qwc2 submodule revision e357152 or later. Update to qwc2 submodule revision 76ec566 (17.06.2022) Refactoring of editing components The editing components have been heavily refactored internally. The changes are mostly transparent, but two points are important: The editDataset field of an editConfig entry is now mandatory. editConfig s generated by qwc-config-generator already write this field, so this applies only to manually written editConfig s for use outside of qwc-services. The changeEditingState action has been replaced by setEditContext (and clearEditContext ). This allows for storing and switching between multiple edit contexts in the application state. Custom components interacting with editing also should be changed to verify that the current edit context is the desired one. Update to qwc2 submodule revision 7929587 (21.04.2022) Format change for external layer resource strings For a short period of time (after submodule revision cb870a1 ), QWC2 supported external resource strings in the form wms:<service_url>#<layername>?<options> . The format has been changed to wms:<service_url>?<options>#<layername> i.e. by moving the query portion before the hash portion, which is inline with the URL scheme format. Update to qwc2 submodule revision eb5e358 (25.10.2021) Update to Webpack 5, React 17 Synchronize the webpack.config.js and the dependencies and package scripts from the demo app package.json . Note that the build package script is now an alias with the prod script. Remove the dist/App.js script include from index.html , it is now added automatically by Webpack. All static files of the app need to be placed below a toplevel static folder, which will contain assets , translations , config.json , themes.json , etc. The themesConfig script will write themes.json to that folder. In custom components, replace any use of Swipeable from react-swipeable : import {Swipeable} from 'react-swipeable'; import {Swipeable} from 'qwc2/components/Swipeable'; Update to qwc2 submodule revision e08aed5 (18.05.2021) Reworked Identify plugin The Identify plugin has been completely reworked, and the IdentifyRegion plugin has been merged into the Identify plugin: Remove the IdentifyRegion plugin from js/appConfig.js and config.json Create menu/toolbar entries in config.json for the region identify tool mode by specifying \"mode\": \"Region\" , i.e.: {\"key\": \"Identify\", \"icon\": \"identify_region\", \"mode\": \"Region\"}, The translation message id identifyregion.info has been changed to infotool.clickhelpPolygon (unless the string is overridden, yarn run tsupdate will take care of this automatically). Note : The identify tool state is now handled internally by the Identify component, it does not store the results in the global application state anymore. Update to qwc2 submodule revision 317eea3 (03.01.2021) Updated dependencies Many dependencies in the qwc2 submodule have been update, please run yarn install to update them in your application. In the demo app, also many dependencies in the application package.json have been updated. It's recommended to synchronize the application package.json and webpack.config.js with the ones of the demo app. Plugins do not need to specify the reducers they use anymore Action files register now the reducers they use automatically, so whenever a symbol is imported from an action file, the respective reducer is automatically enabled. If you have a custom action/reducer file outside the qwc2 submodule folder (i.e. js/{actions,reducers}/myfunctionality.js ), you should add lines similar to import ReducerIndex from 'qwc2/reducers/index'; import myfunctionalityReducer from '/reducers/myfunctionality'; ReducerIndex.register(\"myfunctionality\", myfunctionalityReducer); to js/actions/myfunctionality.js . If you have custom QWC2 plugins, remove the reducers field of the plugin export. ES6 imports QWC2 now uses the ES6 import/export syntax throughout. For instance const Icon = require('qwc2/components/Icon'); const {addLayer} = require('qwc2/actions/layers'); become import Icon from 'qwc2/components/Icon'; import {addLayer} from 'qwc2/actions/layers'; And module.exports = MyClass; becomes export default MyClass; resp. function foo() {...}; function bar() {...}; module.exports = {foo, bar}; becomes export function foo() {...}; export function bar() {...}; In particular, js/appConfig.js needs to be heavily adapted. Update to React 16.14 As per React 16.3, various component lifecycle methods have been deprecated. All qwc2 core components are updated to avoid their use. Custom components should also be updated. See https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html for details. Reworked localization Localization in QWC2 has been reworked: - Instead of <Message msgId=\"<msgid>\" /> and LocaleUtils.getMessageById() , use LocaleUtils.tr(<msgid>) . - For message IDs which are not translated directly via LocaleUtils.tr , use LocaleUtils.trmsg to mark the string as a message ID. - The Message component has been dropped. - Static message IDs are now picked up automatically by updateTranslations.js (invoked by yarn run tsupdate ). - Message IDs built at runtime will beed to be specified manually in tsconfig.json in the extra_strings section. - The translation files are now called translations/<lang>-<COUNTRY>.json rather than translations/data.<lang>-<COUNTRY> . The format of the files remains unchanged. - The supportedLocales section in appConfig.js needs to be dropped. - Previously, the fallback locale was specified as fallbacklocale in config.json. Now, it must be specified as defaultLocaleData in appConfig.js . Default editing interface now shipped in the qwc2 submodule The js/EditingInterface.js in the demo app has been moved to qwc2/utils/EditingInterface.js . This is the interface which acts as a counterpart to the QWC data service . If you want to use a custom editing interface, you can still do so, passing it to the Editing plugin in appConfig.js as before. Assets and translations path now optional Assets and translations path can now be omitted from the config.json , and are resolved to assets resp translations relative to the index.html path of the QWC2 application by default. Use ConfigUtils.getAssetsPath() and ConfigUtils.getTranslationsPath() in your custom components instead of ConfigUtils.getConfigProp . You can still specify assetsPath and translationsPath in config.json to override the default values. Changes to map click point/feature state The previous state.map.clickPoint and state.map.clickFeature have been merged to a single state.map.click . The clickFeatureOnMap action has been removed.","title":"QWC2 upgrade notes"},{"location":"release_notes/QWC2UpgradeNotes/#upgrade-notes","text":"This document describes incompatibilites and other aspects which QWC2 applications need to address when updating against the latest qwc2 submodule. When updating the qwc2 submodule, run yarn install to ensure the dependencies are up to date!","title":"Upgrade notes"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-7409372-23082023","text":"MapInfoToolTip plugin instantation change The instantation of the MapInfoToolTip in appConfig.js needs to be changed to MapInfoTooltipPlugin: MapInfoTooltipPlugin(), Note the extra braces at the end. As a new feature, you can pass a list of plugins to the MapInfoTooltipPlugin . Configuration changes The window size configuration of various plugins has been uniformized to the geometry config prop (rather than occasionally windowSize before). Affected plugins are: FeatureForm , Identify , LayerCatalog , LayerTree , MapLegend . Please check the respective plugin reference for more details on the new format.","title":"Update to qwc2 submodule revision 7409372 (23.08.2023)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-96aaa51-09022023","text":"Config setting change Geodesic measurement mode is now configured at toplevel in config.json via geodesicMeasurements: true|false rather than below Map -> cfg -> toolsOptions -> MeasurementSupport .","title":"Update to qwc2 submodule revision 96aaa51 (09.02.2023)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-7a474e3-23012023","text":"Dependency update Most dependencies have been updated to the latest version. The following adjustments need to be performed by hand: Use createRoot in app.jsx , see the demo app.jsx . Update uuid imports in external components, examples: import {v1 as uuidv1} from 'uuid'; import {v4 as uuidv4} from 'uuid'; and then instead of uuid.v1() use uuidv1() etc. Adjust webpack.config.js from { test: /.mjs$/, type: 'javascript/auto' } to { test: /(.mjs|.js)$/, type: 'javascript/auto' }","title":"Update to qwc2 submodule revision 7a474e3 (23.01.2023)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-fe063b6-13012023","text":"Reworked search provider support The arguments and expected behaviour of the provider onSearch and getResultGeometry have changed. Please refer to the documentation chapter in the Documentation . Consult js/SearchProviders.js and static/assets/searchProviders.js for full examples. It is now possible to define search providers in a external JS file loaded at runtime rather than compiled into the application bundle. See static/assets/searchProviders.js , which is loaded by index.html . js/SearchProviders.js now only includes coordinates and nominatim as built-in search providers for the demo application. The searchProviderFactory function has been removed from js/SearchProviders.js . Instead, custom parameters to be passed to a provider can be specified directly in the theme item searchProviders entry: { key: \"<providerkey2>\", params: {...} } and read from searchParams.cfgParams in the provider onSearch function. Load Help dialog contents from HTML fragment Instead of requiring users to implement the renderHelp function in js/Help.jsx , for simple cases the users can provide a plain HTML fragment which is loaded at runtime from the assets. Consult the Documentation .","title":"Update to qwc2 submodule revision fe063b6 (13.01.2023)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-90c613a-28112022","text":"Reworked color scheme support The styleConfig.js file is deprecated and won't be honoured anymore for the styling of core QWC2 components. Instead, base theme colors can be defined via CSS, refer to documentation for details. Renamed config variable The maxGetUrlLength variable in config.json has been renamed to wmsMaxGetUrlLength .","title":"Update to qwc2 submodule revision 90c613a (28.11.2022)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-e357152-27062022","text":"Reworked interface for handling 1:N relations between qwc2 and qwc-data-service The interface for reading and writing 1:n relations between the qwc2 and the qwc-data-service was reworked. If you are using the qwc-data-service, make sure to update to qwc-data-service-v2022.06.27 or later when updating to qwc2 submodule revision e357152 or later.","title":"Update to qwc2 submodule revision e357152 (27.06.2022)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-76ec566-17062022","text":"Refactoring of editing components The editing components have been heavily refactored internally. The changes are mostly transparent, but two points are important: The editDataset field of an editConfig entry is now mandatory. editConfig s generated by qwc-config-generator already write this field, so this applies only to manually written editConfig s for use outside of qwc-services. The changeEditingState action has been replaced by setEditContext (and clearEditContext ). This allows for storing and switching between multiple edit contexts in the application state. Custom components interacting with editing also should be changed to verify that the current edit context is the desired one.","title":"Update to qwc2 submodule revision 76ec566 (17.06.2022)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-7929587-21042022","text":"Format change for external layer resource strings For a short period of time (after submodule revision cb870a1 ), QWC2 supported external resource strings in the form wms:<service_url>#<layername>?<options> . The format has been changed to wms:<service_url>?<options>#<layername> i.e. by moving the query portion before the hash portion, which is inline with the URL scheme format.","title":"Update to qwc2 submodule revision 7929587 (21.04.2022)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-eb5e358-25102021","text":"Update to Webpack 5, React 17 Synchronize the webpack.config.js and the dependencies and package scripts from the demo app package.json . Note that the build package script is now an alias with the prod script. Remove the dist/App.js script include from index.html , it is now added automatically by Webpack. All static files of the app need to be placed below a toplevel static folder, which will contain assets , translations , config.json , themes.json , etc. The themesConfig script will write themes.json to that folder. In custom components, replace any use of Swipeable from react-swipeable : import {Swipeable} from 'react-swipeable'; import {Swipeable} from 'qwc2/components/Swipeable';","title":"Update to qwc2 submodule revision eb5e358 (25.10.2021)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-e08aed5-18052021","text":"Reworked Identify plugin The Identify plugin has been completely reworked, and the IdentifyRegion plugin has been merged into the Identify plugin: Remove the IdentifyRegion plugin from js/appConfig.js and config.json Create menu/toolbar entries in config.json for the region identify tool mode by specifying \"mode\": \"Region\" , i.e.: {\"key\": \"Identify\", \"icon\": \"identify_region\", \"mode\": \"Region\"}, The translation message id identifyregion.info has been changed to infotool.clickhelpPolygon (unless the string is overridden, yarn run tsupdate will take care of this automatically). Note : The identify tool state is now handled internally by the Identify component, it does not store the results in the global application state anymore.","title":"Update to qwc2 submodule revision e08aed5 (18.05.2021)"},{"location":"release_notes/QWC2UpgradeNotes/#update-to-qwc2-submodule-revision-317eea3-03012021","text":"Updated dependencies Many dependencies in the qwc2 submodule have been update, please run yarn install to update them in your application. In the demo app, also many dependencies in the application package.json have been updated. It's recommended to synchronize the application package.json and webpack.config.js with the ones of the demo app. Plugins do not need to specify the reducers they use anymore Action files register now the reducers they use automatically, so whenever a symbol is imported from an action file, the respective reducer is automatically enabled. If you have a custom action/reducer file outside the qwc2 submodule folder (i.e. js/{actions,reducers}/myfunctionality.js ), you should add lines similar to import ReducerIndex from 'qwc2/reducers/index'; import myfunctionalityReducer from '/reducers/myfunctionality'; ReducerIndex.register(\"myfunctionality\", myfunctionalityReducer); to js/actions/myfunctionality.js . If you have custom QWC2 plugins, remove the reducers field of the plugin export. ES6 imports QWC2 now uses the ES6 import/export syntax throughout. For instance const Icon = require('qwc2/components/Icon'); const {addLayer} = require('qwc2/actions/layers'); become import Icon from 'qwc2/components/Icon'; import {addLayer} from 'qwc2/actions/layers'; And module.exports = MyClass; becomes export default MyClass; resp. function foo() {...}; function bar() {...}; module.exports = {foo, bar}; becomes export function foo() {...}; export function bar() {...}; In particular, js/appConfig.js needs to be heavily adapted. Update to React 16.14 As per React 16.3, various component lifecycle methods have been deprecated. All qwc2 core components are updated to avoid their use. Custom components should also be updated. See https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html for details. Reworked localization Localization in QWC2 has been reworked: - Instead of <Message msgId=\"<msgid>\" /> and LocaleUtils.getMessageById() , use LocaleUtils.tr(<msgid>) . - For message IDs which are not translated directly via LocaleUtils.tr , use LocaleUtils.trmsg to mark the string as a message ID. - The Message component has been dropped. - Static message IDs are now picked up automatically by updateTranslations.js (invoked by yarn run tsupdate ). - Message IDs built at runtime will beed to be specified manually in tsconfig.json in the extra_strings section. - The translation files are now called translations/<lang>-<COUNTRY>.json rather than translations/data.<lang>-<COUNTRY> . The format of the files remains unchanged. - The supportedLocales section in appConfig.js needs to be dropped. - Previously, the fallback locale was specified as fallbacklocale in config.json. Now, it must be specified as defaultLocaleData in appConfig.js . Default editing interface now shipped in the qwc2 submodule The js/EditingInterface.js in the demo app has been moved to qwc2/utils/EditingInterface.js . This is the interface which acts as a counterpart to the QWC data service . If you want to use a custom editing interface, you can still do so, passing it to the Editing plugin in appConfig.js as before. Assets and translations path now optional Assets and translations path can now be omitted from the config.json , and are resolved to assets resp translations relative to the index.html path of the QWC2 application by default. Use ConfigUtils.getAssetsPath() and ConfigUtils.getTranslationsPath() in your custom components instead of ConfigUtils.getConfigProp . You can still specify assetsPath and translationsPath in config.json to override the default values. Changes to map click point/feature state The previous state.map.clickPoint and state.map.clickFeature have been merged to a single state.map.click . The clickFeatureOnMap action has been removed.","title":"Update to qwc2 submodule revision 317eea3 (03.01.2021)"},{"location":"release_notes/QwcDockerUpgradeNotes/","text":"Upgrading to qwc service images v2022.01.26 The qwc-uwsgi-base images have been changed to allow for configurable UID/GID of the uwsgi process. The default is UID=33 and GID=33 , you can override it by setting the SERVICE_UID and SERVICE_GID environment variables in docker-compose.yml . As a consequence, /var/www is not necessarily anymore the home directory of the user wich runs uwsgi , and therefore the qwc-uwsgi-base images now set ENV PGSERVICEFILE=\"/srv/pg_service.conf\" . You'll therefore need to adapt your pg_service.conf volume mounts in your docker-compose.yml to point to that location, i.e. [...] - ./pg_service.conf:/srv/pg_service.conf:ro [...] Upgrading to qwc-config-generator-v2022.01.12 scanned_projects_path_prefix has been dropped as a config setting. Instead, qgis_projects_scan_base_dir must be a directory below qgis_projects_base_dir , and the prefix is automatically computed internally. scanned_projects_path_prefix has been added as a config setting as the output path for preprocessed qgis projects. It must be a directory below qgis_projects_base_dir to which the config service is allowed to write. Upgrading from qwc service images v2021.x to v2022.01.08 or later Starting with v2022.01.08, the requirements of all services where updated to use Flask-JWT-Extended 4.3.1. Flask-JWT-4.x changes the JWT format (see 4.0.0 Breaking Changes ), which can result in QWC Services returning a Missing claim: identity error message. To avoid this: * Change your JWT secret key in .env . * Ensure all services are upgraded to v2022.01.12 or later (if such a version exists). Please omit v2022.01.08 and v2022.01.11.","title":"qwc-docker upgrade notes"},{"location":"release_notes/QwcDockerUpgradeNotes/#upgrading-to-qwc-service-images-v20220126","text":"The qwc-uwsgi-base images have been changed to allow for configurable UID/GID of the uwsgi process. The default is UID=33 and GID=33 , you can override it by setting the SERVICE_UID and SERVICE_GID environment variables in docker-compose.yml . As a consequence, /var/www is not necessarily anymore the home directory of the user wich runs uwsgi , and therefore the qwc-uwsgi-base images now set ENV PGSERVICEFILE=\"/srv/pg_service.conf\" . You'll therefore need to adapt your pg_service.conf volume mounts in your docker-compose.yml to point to that location, i.e. [...] - ./pg_service.conf:/srv/pg_service.conf:ro [...]","title":"Upgrading to qwc service images v2022.01.26"},{"location":"release_notes/QwcDockerUpgradeNotes/#upgrading-to-qwc-config-generator-v20220112","text":"scanned_projects_path_prefix has been dropped as a config setting. Instead, qgis_projects_scan_base_dir must be a directory below qgis_projects_base_dir , and the prefix is automatically computed internally. scanned_projects_path_prefix has been added as a config setting as the output path for preprocessed qgis projects. It must be a directory below qgis_projects_base_dir to which the config service is allowed to write.","title":"Upgrading to qwc-config-generator-v2022.01.12"},{"location":"release_notes/QwcDockerUpgradeNotes/#upgrading-from-qwc-service-images-v2021x-to-v20220108-or-later","text":"Starting with v2022.01.08, the requirements of all services where updated to use Flask-JWT-Extended 4.3.1. Flask-JWT-4.x changes the JWT format (see 4.0.0 Breaking Changes ), which can result in QWC Services returning a Missing claim: identity error message. To avoid this: * Change your JWT secret key in .env . * Ensure all services are upgraded to v2022.01.12 or later (if such a version exists). Please omit v2022.01.08 and v2022.01.11.","title":"Upgrading from qwc service images v2021.x to v2022.01.08 or later"},{"location":"topics/Editing/","text":"Editing QWC2 offers comprehensive editing support through a variety of plugins: The Editing plugin allows creating, editing and removing features of an editable vector layer. It supports editing both geometry and attributes, displaying customizeable attribute forms. The AttributeTable plugin also allows creating, editing and removing features of an editable vector layer. It displays all features of the editable layer in a tabularized view, and allows editing attributes, but not geometries. Noteably, it will allow editing geometryless datasets. The FeatureForm works similarly to the feature-info, but will display the feature form according to the QGIS form configuration, and also allows editing the attributes and geometry of a picked feature. It can configured as identifyTool instead of the standard Identify plugin in config.json . Quick start The easiest way to use the editing functionality is by using the pre-configured qwc-docker with the qwc-data-service and qwc-config-generator . To make a layer editable, follow these steps: The datasource of the layer needs to be a PostGIS database. In particular, make sure that a primary key is configured for your dataset! Configure the QGIS PostgreSQL connection using a service name, add the corresponding service definition to your host pg_service.conf and to qwc-docker/pg_service-write.conf . Make sure your database host is reachable within the docker containers! Especially when your primary key field type is serial , you'll want to mark the corresponding field widget type as Hidden in the QGIS Attributes Form settings. Create a Data resource as child of the corresponding Map resource in the administration backend, and create a new permission for the Map and Data resources for the roles which should be allowed to edit the layer. Note: if you leave the \"Write\" checkbox in the Data resource permission unchecked, the dataset will be available as read-only, which can be useful if you want to use the AttributeTable and/or FeatureForm to just display the dataset without allowing any edits. Run the config generator from the administration backend to update service configuration. Designing the edit forms Much of the power of the QWC2 editing functionality resides in its fully customizeable forms, providing support for different input widget types, file uploads and 1:N relations. The qwc-config-generator will automatically generate forms based on the configuration specified in the QGIS Layer Properties \u2192 Attributes Form. If Autogenerate or Drag and Drop Designer is chosen, a corresponding Qt UI form is automatically generated for QWC2 in assets/forms/autogen . If Provide ui-file is chosen, the specified UI form will copied to assets/forms/autogen . Localized translation forms are supported. To this end, place a Qt Translation file called <form_basename>_<lang>.ts next to the designer form <form_basename>.ui , where lang is a language or language/country code, i.e. en or en-US . There is a translateui.sh script to help generate the translation files. Example: ./translateui.sh .../qwc2/assets/forms/form.ui de it fr File uploads You can configure a text-like field of your dataset as an upload field as follows: For Autogenerated and Drag and Drop Designer forms configuration, set the widget type to Attachment. You can set the file type filter in the widget configuration under Display button to open file dialog -> Filter , in the format *.ext1, *.ext2 . For manually created Qt Designed Ui forms, use a QLineEdit widget named <fieldname>__upload , and optionally as the text value of the QLineEdit set a comma separated list of suggested file extensions. Attachments are stored on disk below the attachments_base_dir defined in the data service configuration, and the path to the attachments stored in the dataset. Note: If you set the fomrat constraint to *.jpeg and your browser has access to a camera, QWC2 will allow you to directly upload images captured from the camera. You can set the allowed attachment extensions and maximum file sizes globally by setting allowed_attachment_extensions and max_attachment_file_size in the data service configuration. You may also need to set/increase client_max_body_size in qwc-docker/api-gateway/nginx.conf . You can also set the allowed attachment extensions and maximum file sizes per dataset by setting max_attachment_file_size_per_dataset and allowed_extensions_per_dataset in the data service configuration. If you set the per dataset values, the global settings will be disregarded (i.e. if an attachment satisfies the per dataset constraint it will be considered valid, even if it violates the global constraint). To ensure the uploaded files are properly rendered as download links in GetFeatureInfo responses, use the qwc-feature-info-service . Key-value relations (value mappings) Value relations allow mapping technical values to a human readable display strings, displayed in a combo box. For Autogenerated and Drag and Drop Designer , use widgets of type Value Relation . In a manually created Qt-Designer Ui form, you can use key-value relations for combo box entries by naming the QComboBox widget according to the following pattern: kvrel__<fieldname>__<kvtablename>__<kvtable_valuefield>__<kvtable_labelfield> . <kvtablename> refers to a table containing a field called <kvtable_valuefield> for the value of the entry and a field <kvtable_labelfield> for the label of the entry. For key-value relations inside a 1:N relation, use kvrel__<reltablename>__<fieldname>__<kvtablename>__<kvtable_valuefield>__<kvtable_labelfield> . Note: The relation table needs to be added as a (geometryless) table to the QGIS Project. You also need to set appropriate permissions for the relation table dataset in the QWC admin backend. Alternatively, you can set autogen_keyvaltable_datasets to true in the config generator configuration, to automatically generate resources and read-only permissions as required. 1:N relations 1:N relations allow associating multiple child records to the target feature, displayed in a table. For Autogenerated and Drag and Drop Designer , configure the 1:N relation in QGIS Project \u2192 Properties \u2192 Relations. Note that the child table foreign key must refer to parent primary key. In a manually created Qt-Designer Ui form, create a widget of type QWidget , QGroupBox or QFrame named according to the pattern nrel__<reltablename>__<foreignkeyfield> , where <reltablename> is the name of the relation table and <foreignkeyfield> the name of the foreign key field in the relation table. Inside this widget, add the edit widgets for the values of the relation table. Name the widgets <reltablename>__<fieldname> . These edit widgets will be replicated for each relation record. Notes : In a manually created Qt-Designer Ui form, you can also specify a sort column for the 1:N relation in the form nrel__<reltablename>__<foreignkeyfield>__<sortcol> . If a sort-column is specified, QWC2 will display sort arrows for each entry in the relation widget. The relation table needs to be added as a (geometryless) table to the QGIS Project. You also need to set appropriate permissions for the relation table dataset in the QWC admin backend. Special form widgets In manually created Qt-Designer Ui forms, there are a number of special widgets you can use: Images : To display attribute values which contain an image URL as an inline image, use a QLabel named img__<fieldname> . Linked features : To display a button to choose a linked feature and edit its attributes in a nested edit form, create a QPushButton named featurelink__<linkdataset>__<fieldname> (simple join) or featurelink__<linkdataset>__<reltable>__<fieldname> in a 1:N relation. In a 1:N relation, linkdataset can be equal to reltable to edit the relation record itself in the nested form. fieldname will contain the id of the linked feature. External fields : Some times it is useful to display information from an external source in the edit form. This can be accomplished by creating a QWidget with name ext__<fieldname> and using a form preprocessor hook (see registerFormPreprocessor in QtDesignerForm.jsx to populate the field by assigning a React fragment to formData.externalFields.<fieldname> . Buttons : To add a button with a custom action, add a QPushButton with name btn__<buttonname> , and use a form preprocessor hook to set the custom function to formData.buttons.buttonname.onClick . Logging mutations The qwc-data-service offers some basic functionality for logging mutations: If you set upload_user_field_suffix in the data service config, the username of the last user who performed a mutation to <fieldname> will be logged to <fieldname>__<upload_user_field_suffix> . If you set edit_user_field in the data service config, the username of the last user who performed a mutation to a record with be logged to the <edit_user_field> field of the record. If you set edit_timestamp_field in the data service config, the timestamp of the last mutation to a record will be logged to the <edit_timestamp_field> field of the record. Note : for these fields to be written, ensure the qgis project is also up-to-date, i.e. that contain the up-to-date table schemas. You can set the respective field types to hidden in the QGIS layer properties to avoid them showing up in the autogenerated edit forms. Using a custom editing backend You can also use a custom editing backend instead of the qwc-data-service by following these steps: Implement the custom editing interface, taking default EditingInterface.js as a template. Enable the desired editing plugins in js/appConfig.js , passing your custom editing interface to Editing , AttributeTable and FeatureForm . Set up an editing backend. If you are using the qwc-config-generator , the edit configuration will be automatically generated from the QGIS project. Otherwise, you need to write a custom editConfig in themesConfig.json as follows: Entry Description { \u2063 <LayerId>: { A WMS layer ID. Should be a theme WMS layer name, to ensure the WMS is correctly refreshed. \u2063 \"layerName\": \"<LayerName>\", The layer name to show in the selection combo box. \u2063 \"editDataset\": \"<DatasetName>\", The name of the edit dataset passed to the editing interface. \u2063 \"geomType\": \"<GeomType>\", The geometry type, either Point , LineString or Polygon . \u2063 \"displayField\": \"<FieldId>\", The ID of the field to use in the feature selection menu. \u2063 \"permissions\": { A list of different write permissions to specify rights and buttons. \u2063 \"creatable\": <boolean>, If true , Draw button will appear in Editing interface and Add button in Attribute Table. \u2063 \"updatable\": <boolean>, If true , Pick button will appear in Editing interface. \u2063 \"deletable\": <boolean>, If true , Delete button will appear in Editing interface and Attribute Table. \u2063 }, \u2063 \"fields\": [{ A list of field definitions, for each exposed attribute. \u2063 \"id\": \"<FieldID>\", The field ID. \u2063 \"name\": \"<FieldName>\", The field name, as displayed in the editing form. \u2063 \"type\": \"<FieldType>\", A field type. Either bool , list or a regular HTML input element type . \u2063 \"constraints\": { Constraints for the input field. \u2063 \"values\": [<Entries>], Only if type is list : an array of arbitrary strings. \u2063 ... For regular HTML input types, the ReactJS API name of any applicable HTML input constraint , i.e. maxLength or readOnly . \u2063 } \u2063 }], \u2063 \"form\": \"<PathToUiFile>\", Optional, a QtDesigner UI file. \u2063 } } If you specify just fields , a simple form is autogenerated based on the field definitions. Alternatively you can specify the URL to a Qt Designer UI form in form (use :/<path> to specify a path below the assets folder).","title":"Editing"},{"location":"topics/Editing/#editing","text":"QWC2 offers comprehensive editing support through a variety of plugins: The Editing plugin allows creating, editing and removing features of an editable vector layer. It supports editing both geometry and attributes, displaying customizeable attribute forms. The AttributeTable plugin also allows creating, editing and removing features of an editable vector layer. It displays all features of the editable layer in a tabularized view, and allows editing attributes, but not geometries. Noteably, it will allow editing geometryless datasets. The FeatureForm works similarly to the feature-info, but will display the feature form according to the QGIS form configuration, and also allows editing the attributes and geometry of a picked feature. It can configured as identifyTool instead of the standard Identify plugin in config.json .","title":"Editing"},{"location":"topics/Editing/#quick-start","text":"The easiest way to use the editing functionality is by using the pre-configured qwc-docker with the qwc-data-service and qwc-config-generator . To make a layer editable, follow these steps: The datasource of the layer needs to be a PostGIS database. In particular, make sure that a primary key is configured for your dataset! Configure the QGIS PostgreSQL connection using a service name, add the corresponding service definition to your host pg_service.conf and to qwc-docker/pg_service-write.conf . Make sure your database host is reachable within the docker containers! Especially when your primary key field type is serial , you'll want to mark the corresponding field widget type as Hidden in the QGIS Attributes Form settings. Create a Data resource as child of the corresponding Map resource in the administration backend, and create a new permission for the Map and Data resources for the roles which should be allowed to edit the layer. Note: if you leave the \"Write\" checkbox in the Data resource permission unchecked, the dataset will be available as read-only, which can be useful if you want to use the AttributeTable and/or FeatureForm to just display the dataset without allowing any edits. Run the config generator from the administration backend to update service configuration.","title":"Quick start "},{"location":"topics/Editing/#designing-the-edit-forms","text":"Much of the power of the QWC2 editing functionality resides in its fully customizeable forms, providing support for different input widget types, file uploads and 1:N relations. The qwc-config-generator will automatically generate forms based on the configuration specified in the QGIS Layer Properties \u2192 Attributes Form. If Autogenerate or Drag and Drop Designer is chosen, a corresponding Qt UI form is automatically generated for QWC2 in assets/forms/autogen . If Provide ui-file is chosen, the specified UI form will copied to assets/forms/autogen . Localized translation forms are supported. To this end, place a Qt Translation file called <form_basename>_<lang>.ts next to the designer form <form_basename>.ui , where lang is a language or language/country code, i.e. en or en-US . There is a translateui.sh script to help generate the translation files. Example: ./translateui.sh .../qwc2/assets/forms/form.ui de it fr","title":"Designing the edit forms"},{"location":"topics/Editing/#file-uploads","text":"You can configure a text-like field of your dataset as an upload field as follows: For Autogenerated and Drag and Drop Designer forms configuration, set the widget type to Attachment. You can set the file type filter in the widget configuration under Display button to open file dialog -> Filter , in the format *.ext1, *.ext2 . For manually created Qt Designed Ui forms, use a QLineEdit widget named <fieldname>__upload , and optionally as the text value of the QLineEdit set a comma separated list of suggested file extensions. Attachments are stored on disk below the attachments_base_dir defined in the data service configuration, and the path to the attachments stored in the dataset. Note: If you set the fomrat constraint to *.jpeg and your browser has access to a camera, QWC2 will allow you to directly upload images captured from the camera. You can set the allowed attachment extensions and maximum file sizes globally by setting allowed_attachment_extensions and max_attachment_file_size in the data service configuration. You may also need to set/increase client_max_body_size in qwc-docker/api-gateway/nginx.conf . You can also set the allowed attachment extensions and maximum file sizes per dataset by setting max_attachment_file_size_per_dataset and allowed_extensions_per_dataset in the data service configuration. If you set the per dataset values, the global settings will be disregarded (i.e. if an attachment satisfies the per dataset constraint it will be considered valid, even if it violates the global constraint). To ensure the uploaded files are properly rendered as download links in GetFeatureInfo responses, use the qwc-feature-info-service .","title":"File uploads"},{"location":"topics/Editing/#key-value-relations-value-mappings","text":"Value relations allow mapping technical values to a human readable display strings, displayed in a combo box. For Autogenerated and Drag and Drop Designer , use widgets of type Value Relation . In a manually created Qt-Designer Ui form, you can use key-value relations for combo box entries by naming the QComboBox widget according to the following pattern: kvrel__<fieldname>__<kvtablename>__<kvtable_valuefield>__<kvtable_labelfield> . <kvtablename> refers to a table containing a field called <kvtable_valuefield> for the value of the entry and a field <kvtable_labelfield> for the label of the entry. For key-value relations inside a 1:N relation, use kvrel__<reltablename>__<fieldname>__<kvtablename>__<kvtable_valuefield>__<kvtable_labelfield> . Note: The relation table needs to be added as a (geometryless) table to the QGIS Project. You also need to set appropriate permissions for the relation table dataset in the QWC admin backend. Alternatively, you can set autogen_keyvaltable_datasets to true in the config generator configuration, to automatically generate resources and read-only permissions as required.","title":"Key-value relations (value mappings)"},{"location":"topics/Editing/#1n-relations","text":"1:N relations allow associating multiple child records to the target feature, displayed in a table. For Autogenerated and Drag and Drop Designer , configure the 1:N relation in QGIS Project \u2192 Properties \u2192 Relations. Note that the child table foreign key must refer to parent primary key. In a manually created Qt-Designer Ui form, create a widget of type QWidget , QGroupBox or QFrame named according to the pattern nrel__<reltablename>__<foreignkeyfield> , where <reltablename> is the name of the relation table and <foreignkeyfield> the name of the foreign key field in the relation table. Inside this widget, add the edit widgets for the values of the relation table. Name the widgets <reltablename>__<fieldname> . These edit widgets will be replicated for each relation record. Notes : In a manually created Qt-Designer Ui form, you can also specify a sort column for the 1:N relation in the form nrel__<reltablename>__<foreignkeyfield>__<sortcol> . If a sort-column is specified, QWC2 will display sort arrows for each entry in the relation widget. The relation table needs to be added as a (geometryless) table to the QGIS Project. You also need to set appropriate permissions for the relation table dataset in the QWC admin backend.","title":"1:N relations"},{"location":"topics/Editing/#special-form-widgets","text":"In manually created Qt-Designer Ui forms, there are a number of special widgets you can use: Images : To display attribute values which contain an image URL as an inline image, use a QLabel named img__<fieldname> . Linked features : To display a button to choose a linked feature and edit its attributes in a nested edit form, create a QPushButton named featurelink__<linkdataset>__<fieldname> (simple join) or featurelink__<linkdataset>__<reltable>__<fieldname> in a 1:N relation. In a 1:N relation, linkdataset can be equal to reltable to edit the relation record itself in the nested form. fieldname will contain the id of the linked feature. External fields : Some times it is useful to display information from an external source in the edit form. This can be accomplished by creating a QWidget with name ext__<fieldname> and using a form preprocessor hook (see registerFormPreprocessor in QtDesignerForm.jsx to populate the field by assigning a React fragment to formData.externalFields.<fieldname> . Buttons : To add a button with a custom action, add a QPushButton with name btn__<buttonname> , and use a form preprocessor hook to set the custom function to formData.buttons.buttonname.onClick .","title":"Special form widgets"},{"location":"topics/Editing/#logging-mutations","text":"The qwc-data-service offers some basic functionality for logging mutations: If you set upload_user_field_suffix in the data service config, the username of the last user who performed a mutation to <fieldname> will be logged to <fieldname>__<upload_user_field_suffix> . If you set edit_user_field in the data service config, the username of the last user who performed a mutation to a record with be logged to the <edit_user_field> field of the record. If you set edit_timestamp_field in the data service config, the timestamp of the last mutation to a record will be logged to the <edit_timestamp_field> field of the record. Note : for these fields to be written, ensure the qgis project is also up-to-date, i.e. that contain the up-to-date table schemas. You can set the respective field types to hidden in the QGIS layer properties to avoid them showing up in the autogenerated edit forms.","title":"Logging mutations"},{"location":"topics/Editing/#using-a-custom-editing-backend","text":"You can also use a custom editing backend instead of the qwc-data-service by following these steps: Implement the custom editing interface, taking default EditingInterface.js as a template. Enable the desired editing plugins in js/appConfig.js , passing your custom editing interface to Editing , AttributeTable and FeatureForm . Set up an editing backend. If you are using the qwc-config-generator , the edit configuration will be automatically generated from the QGIS project. Otherwise, you need to write a custom editConfig in themesConfig.json as follows: Entry Description { \u2063 <LayerId>: { A WMS layer ID. Should be a theme WMS layer name, to ensure the WMS is correctly refreshed. \u2063 \"layerName\": \"<LayerName>\", The layer name to show in the selection combo box. \u2063 \"editDataset\": \"<DatasetName>\", The name of the edit dataset passed to the editing interface. \u2063 \"geomType\": \"<GeomType>\", The geometry type, either Point , LineString or Polygon . \u2063 \"displayField\": \"<FieldId>\", The ID of the field to use in the feature selection menu. \u2063 \"permissions\": { A list of different write permissions to specify rights and buttons. \u2063 \"creatable\": <boolean>, If true , Draw button will appear in Editing interface and Add button in Attribute Table. \u2063 \"updatable\": <boolean>, If true , Pick button will appear in Editing interface. \u2063 \"deletable\": <boolean>, If true , Delete button will appear in Editing interface and Attribute Table. \u2063 }, \u2063 \"fields\": [{ A list of field definitions, for each exposed attribute. \u2063 \"id\": \"<FieldID>\", The field ID. \u2063 \"name\": \"<FieldName>\", The field name, as displayed in the editing form. \u2063 \"type\": \"<FieldType>\", A field type. Either bool , list or a regular HTML input element type . \u2063 \"constraints\": { Constraints for the input field. \u2063 \"values\": [<Entries>], Only if type is list : an array of arbitrary strings. \u2063 ... For regular HTML input types, the ReactJS API name of any applicable HTML input constraint , i.e. maxLength or readOnly . \u2063 } \u2063 }], \u2063 \"form\": \"<PathToUiFile>\", Optional, a QtDesigner UI file. \u2063 } } If you specify just fields , a simple form is autogenerated based on the field definitions. Alternatively you can specify the URL to a Qt Designer UI form in form (use :/<path> to specify a path below the assets folder).","title":"Using a custom editing backend"},{"location":"topics/FeatureInfo/","text":"Feature info The feature info behaviour in QWC2 is controlled by configuring identifyTool in config.json (or per-theme in themesConfig.json ) to the desired plugin as well as whether a qwc-feature-info-service is used. The feature info is by default triggered when clicking on a feature in the map. You can also configure the feature info as an explicit viewer tool by setting identifyTool: null and adding a menuItems or toolbarItems entry. The following approaches are available for feature info: Identify plugin: WMS GetFeatureInfo , rendered in a table or in a custom HTML template DB feature info with custom SQL queries FeatureForm plugin : custom attribute forms with qwc-data-service WMS GetFeatureInfo To query features over WMS GetFeatureInfo, set identifyTool: \"Identify\" . By default, results are displayed in a table. To display the results in a custom HTML template, the qwc-feature-info-service can be used . Note: Use of the qwc-feature-info-service is also recommended if the qwc-data-service is used for editing, to ensure attribute values containing paths to uploaded files are properly converted to clickable hyperlinks. Set whether a layer is identifyable in QGIS → Project Properties → Data sources . To highlight the geometry, make sure QGIS → Project Properties → QGIS Server → Add geometry to feature response is checked. Suppressing attributes You can suppress attributes globally by selecting \"Do not expose via WMS\" in QGIS \u2192 Layer properties \u2192 Fields. Alternatively, you can selectively restrict attributes using the qwc-admin-gui and assigning Attribute resource permissions as desired. You can also omit empty attributes by setting skipEmptyFeatureAttributes: true in the theme configuration entry in themesConfig.json . If you use the qwc-feature-info-service , you can also omit empty attributes directly in the GetFeatureInfo by setting skip_empty_attributes: true in the featureInfo service configuration in tenantConfig.json . Attribute values: HTML markup, hyperlinks, images In general, HTML markup in attribute values is preserved. For displaying interactive hyperlinks, the following options are supported: URLs in attribute text values with no HTML markup are automatically converted to an interactive hyperlink. Alternatively, you can enclose the URL in a HTML <a> tag in the attribute value. To open the linked page in an inline dialog within QWC2, you can set the anchor target to :iframedialog:<dialogname>:<optkey>=<optval>:<optkey>=<optval>:... where the supported options are: w : Dialog width in pixels, default: 640 . h : Dialog height in pixels, default: 480 . title : Dialog window title, by default the translation string windows.<dialogname> . print : Whether to add a print icon for printing the dialog contents, default: true . dockable : Whether the dialog can be docked, default false . docked : Whether the dialog is initially docked, default false . Example: <a href=\"https://example.com\" target=\":iframedialog:w=1024:h=768:title=Example\">Link text</a> For displaying images, the following options are supported: If replaceImageUrls: true is set in the Identify plugin configuration in config.json , attribute text values which contain exactly an URL to an image are converted to inline images. If you use the qwc-feature-info-service , you need to set transform_image_urls in the featureInfo service configuration in tenantConfig.json . Alternatively, you can add a <img> tag directly in the attribute value. This applies in particular to <a /> anchor and <img /> tags for displaying links an images in an attribute value. Client side attribute transformations This functionality is only available without the qwc-feature-info-service . To compute derived attributes client-side, you can implement the customAttributeCalculator in qwc2-app/js/IdentifyExtensions.js (which is passed to the Identify plugin in appConfig.js ). To transform attributes client-side you can implement the attributeTransform in qwc2-app/js/IdentifyExtensions.js (which is passed to the Identify plugin in appConfig.js ). Custom export By default, the identify dialog in QWC2 allows you to export the results to json (QWC2 feature storage format), geojson (standard GeoJSON without QWC2 specific fields), csv (single CSV with all layers) or csv+zip (ZIP with one CSV per layer). You can define additional export functions by extending customExporters in qwc2-app/js/IdentifyExtensions.js . Custom HTML templates You can specify a custom HTML template for displaying the feature rather than the default table view by using the qwc-feature-info-service and providing the template in the featureInfo service configuration in tenantConfig.json , either inline or as a path: { \"name\": \"featureInfo\", \"config\": ..., \"resources\": { \"wms_services\": [ { \"name\": \"<service_name>\", \"root_layer\": { \"name\": \"<root_layer_name>\", \"layers\": [ { \"name\": \"<layer_name>\", \"info_template\": { <See below> } } ] } } ] } } Example info_template with inline template: \"info_template\": { \"type\": \"wms\", \"template\": \"<div><h2>Demo Template</h2>Pos: {{ x }}, {{ y }}<br>Name: {{ feature.Name }}</div>\" } Example info_template with template path: \"info_template\": { \"type\": \"wms\", \"template_path\": \"/info_templates/template.html\" } Note: - x and y are the info query coordinates. feature.<attr> renders the attr attribute value of the feature. - The templates must be HTML fragments without html or body tags. - The templates folder needs to be mounted into the qwc-feature-info-service container, i.e.: qwc-feature-info-service: image: sourcepole/qwc-feature-info-service:vYYYY.MM.DD volumes: ... - ./volumes/info-templates:/info_templates:ro DB query feature info When using the Identify plugin and the qwc-feature-info-service , you can query features directly from a database instead of over WMS GetFeatureInfo, by providing the featureInfo service configuration as described in HTML templates , but specifying a db_url and sql , for example \"info_template\": { \"type\": \"sql\", \"db_url\": \"postgresql:///?service=qwc_geodb\", \"sql\": \"SELECT ogc_fid as _fid_, name, formal_en, pop_est, subregion, ST_AsText(wkb_geometry) as wkt_geom FROM qwc_geodb.ne_10m_admin_0_countries WHERE ST_Intersects(wkb_geometry, ST_GeomFromText(:geom, :srid)) LIMIT :feature_count;\", \"template\": \"<div><h2>Demo Template</h2>Pos: {{ x }}, {{ y }}<br>Name: {{ feature.Name }}</div>\" } Note: x , y and geom are passed as parameters to the SQL query. If a GetFeatureInfo request is being processed with a filter_geom parameter, geom will correspond to that parameter. Otherwise geom will be POINT(x y) . Feature form The FeatureForm plugin displays picked features in a feature form as configured in QGIS → Layer properties → Attributes form . It queries the features via qwc-data-service , and hence only works for layers with postgresql data source. See Designing the edit forms for more information on designing edit forms. To use it as default identify-tool, set identifyTool: \"FeatureForm\" in config.json . A layer is only identifyable with the FeatureForm plugin if corresponding Data resources and permissions are configured for the layer data source in the qwc-admin-gui . If a write permission is configured, the feature will be editable. Permissions When using the Identify plugin and the qwc-feature-info-service , you can manage the permissions in the qwc-admin-gui as follows: To restrict the display of single layer attributes to specific roles, create a Layer and Attribute resource (latter as child of the created Layer resource) and create permissions assigning the desired roles to the Attribute resources. Note : The name of the Attribute resource needs to be equal to the attribute alias name if one is defined in the QGIS project! To restrict whether a layer is identifiable to specific roles, create a FeatureInfo service and FeatureInfo layer resource (latter as child of the created FeatureInfo service resource), and create permissions assigning the desired roles to the FeatureInfo layer resources. When using the FeatureForm plugin and the qwc-data-service , the Data resource permissions are used, see Editing .","title":"Feature info"},{"location":"topics/FeatureInfo/#feature-info","text":"The feature info behaviour in QWC2 is controlled by configuring identifyTool in config.json (or per-theme in themesConfig.json ) to the desired plugin as well as whether a qwc-feature-info-service is used. The feature info is by default triggered when clicking on a feature in the map. You can also configure the feature info as an explicit viewer tool by setting identifyTool: null and adding a menuItems or toolbarItems entry. The following approaches are available for feature info: Identify plugin: WMS GetFeatureInfo , rendered in a table or in a custom HTML template DB feature info with custom SQL queries FeatureForm plugin : custom attribute forms with qwc-data-service","title":"Feature info"},{"location":"topics/FeatureInfo/#wms-getfeatureinfo","text":"To query features over WMS GetFeatureInfo, set identifyTool: \"Identify\" . By default, results are displayed in a table. To display the results in a custom HTML template, the qwc-feature-info-service can be used . Note: Use of the qwc-feature-info-service is also recommended if the qwc-data-service is used for editing, to ensure attribute values containing paths to uploaded files are properly converted to clickable hyperlinks. Set whether a layer is identifyable in QGIS → Project Properties → Data sources . To highlight the geometry, make sure QGIS → Project Properties → QGIS Server → Add geometry to feature response is checked.","title":"WMS GetFeatureInfo"},{"location":"topics/FeatureInfo/#suppressing-attributes","text":"You can suppress attributes globally by selecting \"Do not expose via WMS\" in QGIS \u2192 Layer properties \u2192 Fields. Alternatively, you can selectively restrict attributes using the qwc-admin-gui and assigning Attribute resource permissions as desired. You can also omit empty attributes by setting skipEmptyFeatureAttributes: true in the theme configuration entry in themesConfig.json . If you use the qwc-feature-info-service , you can also omit empty attributes directly in the GetFeatureInfo by setting skip_empty_attributes: true in the featureInfo service configuration in tenantConfig.json .","title":"Suppressing attributes"},{"location":"topics/FeatureInfo/#attribute-values-html-markup-hyperlinks-images","text":"In general, HTML markup in attribute values is preserved. For displaying interactive hyperlinks, the following options are supported: URLs in attribute text values with no HTML markup are automatically converted to an interactive hyperlink. Alternatively, you can enclose the URL in a HTML <a> tag in the attribute value. To open the linked page in an inline dialog within QWC2, you can set the anchor target to :iframedialog:<dialogname>:<optkey>=<optval>:<optkey>=<optval>:... where the supported options are: w : Dialog width in pixels, default: 640 . h : Dialog height in pixels, default: 480 . title : Dialog window title, by default the translation string windows.<dialogname> . print : Whether to add a print icon for printing the dialog contents, default: true . dockable : Whether the dialog can be docked, default false . docked : Whether the dialog is initially docked, default false . Example: <a href=\"https://example.com\" target=\":iframedialog:w=1024:h=768:title=Example\">Link text</a> For displaying images, the following options are supported: If replaceImageUrls: true is set in the Identify plugin configuration in config.json , attribute text values which contain exactly an URL to an image are converted to inline images. If you use the qwc-feature-info-service , you need to set transform_image_urls in the featureInfo service configuration in tenantConfig.json . Alternatively, you can add a <img> tag directly in the attribute value. This applies in particular to <a /> anchor and <img /> tags for displaying links an images in an attribute value.","title":"Attribute values: HTML markup, hyperlinks, images"},{"location":"topics/FeatureInfo/#client-side-attribute-transformations","text":"This functionality is only available without the qwc-feature-info-service . To compute derived attributes client-side, you can implement the customAttributeCalculator in qwc2-app/js/IdentifyExtensions.js (which is passed to the Identify plugin in appConfig.js ). To transform attributes client-side you can implement the attributeTransform in qwc2-app/js/IdentifyExtensions.js (which is passed to the Identify plugin in appConfig.js ).","title":"Client side attribute transformations"},{"location":"topics/FeatureInfo/#custom-export","text":"By default, the identify dialog in QWC2 allows you to export the results to json (QWC2 feature storage format), geojson (standard GeoJSON without QWC2 specific fields), csv (single CSV with all layers) or csv+zip (ZIP with one CSV per layer). You can define additional export functions by extending customExporters in qwc2-app/js/IdentifyExtensions.js .","title":"Custom export"},{"location":"topics/FeatureInfo/#custom-html-templates","text":"You can specify a custom HTML template for displaying the feature rather than the default table view by using the qwc-feature-info-service and providing the template in the featureInfo service configuration in tenantConfig.json , either inline or as a path: { \"name\": \"featureInfo\", \"config\": ..., \"resources\": { \"wms_services\": [ { \"name\": \"<service_name>\", \"root_layer\": { \"name\": \"<root_layer_name>\", \"layers\": [ { \"name\": \"<layer_name>\", \"info_template\": { <See below> } } ] } } ] } } Example info_template with inline template: \"info_template\": { \"type\": \"wms\", \"template\": \"<div><h2>Demo Template</h2>Pos: {{ x }}, {{ y }}<br>Name: {{ feature.Name }}</div>\" } Example info_template with template path: \"info_template\": { \"type\": \"wms\", \"template_path\": \"/info_templates/template.html\" } Note: - x and y are the info query coordinates. feature.<attr> renders the attr attribute value of the feature. - The templates must be HTML fragments without html or body tags. - The templates folder needs to be mounted into the qwc-feature-info-service container, i.e.: qwc-feature-info-service: image: sourcepole/qwc-feature-info-service:vYYYY.MM.DD volumes: ... - ./volumes/info-templates:/info_templates:ro","title":"Custom HTML templates"},{"location":"topics/FeatureInfo/#db-query-feature-info","text":"When using the Identify plugin and the qwc-feature-info-service , you can query features directly from a database instead of over WMS GetFeatureInfo, by providing the featureInfo service configuration as described in HTML templates , but specifying a db_url and sql , for example \"info_template\": { \"type\": \"sql\", \"db_url\": \"postgresql:///?service=qwc_geodb\", \"sql\": \"SELECT ogc_fid as _fid_, name, formal_en, pop_est, subregion, ST_AsText(wkb_geometry) as wkt_geom FROM qwc_geodb.ne_10m_admin_0_countries WHERE ST_Intersects(wkb_geometry, ST_GeomFromText(:geom, :srid)) LIMIT :feature_count;\", \"template\": \"<div><h2>Demo Template</h2>Pos: {{ x }}, {{ y }}<br>Name: {{ feature.Name }}</div>\" } Note: x , y and geom are passed as parameters to the SQL query. If a GetFeatureInfo request is being processed with a filter_geom parameter, geom will correspond to that parameter. Otherwise geom will be POINT(x y) .","title":"DB query feature info"},{"location":"topics/FeatureInfo/#feature-form","text":"The FeatureForm plugin displays picked features in a feature form as configured in QGIS → Layer properties → Attributes form . It queries the features via qwc-data-service , and hence only works for layers with postgresql data source. See Designing the edit forms for more information on designing edit forms. To use it as default identify-tool, set identifyTool: \"FeatureForm\" in config.json . A layer is only identifyable with the FeatureForm plugin if corresponding Data resources and permissions are configured for the layer data source in the qwc-admin-gui . If a write permission is configured, the feature will be editable.","title":"Feature form"},{"location":"topics/FeatureInfo/#permissions","text":"When using the Identify plugin and the qwc-feature-info-service , you can manage the permissions in the qwc-admin-gui as follows: To restrict the display of single layer attributes to specific roles, create a Layer and Attribute resource (latter as child of the created Layer resource) and create permissions assigning the desired roles to the Attribute resources. Note : The name of the Attribute resource needs to be equal to the attribute alias name if one is defined in the QGIS project! To restrict whether a layer is identifiable to specific roles, create a FeatureInfo service and FeatureInfo layer resource (latter as child of the created FeatureInfo service resource), and create permissions assigning the desired roles to the FeatureInfo layer resources. When using the FeatureForm plugin and the qwc-data-service , the Data resource permissions are used, see Editing .","title":"Permissions"},{"location":"topics/Interfacing/","text":"Interfacing with other applications QWC2 offers a number of options to interface it with other applications. URL parameters The following parameters can appear in the URL of the QWC2 application: t : The active theme l : The layers in the map, see below. bl : The visible background layer e : The visible extent c : The center of the visible extent s : The current scale crs : The CRS of extent/center coordinates hc : If c is specified and hc is true or 1 , a marker is set at c when starting the application. Note: requires the StartupMarkerPlugin plugin to be active. st : The search text hp , hf , ht : Startup highlight parameters used in conjunction with the qwc-fulltext-search-service , see below. The l parameter lists all layers in the map (redlining and background layers) as a comma separated list of entries of the form <layername>[<transparency>]! where - layername is the WMS name of a theme layer or group, or an external layer resource string in the format <wms|wfs>:<service_url>#<layername> for external layers, i.e. wms:https://wms.geo.admin.ch/?#ch.are.bauzonen . - <transparency> denotes the layer transparency, betwen 0 and 100. If the [<transparency>] portion is omitted, the layer is fully opaque. - ! denotes that the layer is invisible. If omitted, the layer is visible. Note : If group name is specified instead of the layer name, QWC2 will automatically resolve this to all layer names contained in that group, and will apply transparency and visibility settings as specified for the group. The urlPositionFormat parameter in config.json determines whether the extent or the center and scale appears in the URL. The urlPositionCrs parameter in config.json determines the projection to use for the extent resp. center coordinates in the URL. By default the map projection of the current theme is used. If urlPositionCrs is equal to the map projection, the crs parameter is omitted in the URL. Highlight feature on startup If a search text passed via st results in a unique result, the viewer automatically zooms to this result on startup. If the search result does not provide a bounding box, the minScale defined in the searchOptions of the TopBar configuration in config.json is used. When using the qwc-fulltext-search-service , you can hightlight a feature on startup as follows: - Either specify hp=<search product>&hf=<search filter> - Or specify ht=<search text>&hp=<search product> See Fulltext search for more details. Launching external websites QWC2 menu entries can be configured to launch external websites as described in opening external websites . Javascript API The API plugin exposes many application actions via the window.qwc2 object and makes them accessible for external applications. See API plugin reference for more details. See api_examples.js for some concrete examples.","title":"Interfacing with applications"},{"location":"topics/Interfacing/#interfacing-with-other-applications","text":"QWC2 offers a number of options to interface it with other applications.","title":"Interfacing with other applications"},{"location":"topics/Interfacing/#url-parameters","text":"The following parameters can appear in the URL of the QWC2 application: t : The active theme l : The layers in the map, see below. bl : The visible background layer e : The visible extent c : The center of the visible extent s : The current scale crs : The CRS of extent/center coordinates hc : If c is specified and hc is true or 1 , a marker is set at c when starting the application. Note: requires the StartupMarkerPlugin plugin to be active. st : The search text hp , hf , ht : Startup highlight parameters used in conjunction with the qwc-fulltext-search-service , see below. The l parameter lists all layers in the map (redlining and background layers) as a comma separated list of entries of the form <layername>[<transparency>]! where - layername is the WMS name of a theme layer or group, or an external layer resource string in the format <wms|wfs>:<service_url>#<layername> for external layers, i.e. wms:https://wms.geo.admin.ch/?#ch.are.bauzonen . - <transparency> denotes the layer transparency, betwen 0 and 100. If the [<transparency>] portion is omitted, the layer is fully opaque. - ! denotes that the layer is invisible. If omitted, the layer is visible. Note : If group name is specified instead of the layer name, QWC2 will automatically resolve this to all layer names contained in that group, and will apply transparency and visibility settings as specified for the group. The urlPositionFormat parameter in config.json determines whether the extent or the center and scale appears in the URL. The urlPositionCrs parameter in config.json determines the projection to use for the extent resp. center coordinates in the URL. By default the map projection of the current theme is used. If urlPositionCrs is equal to the map projection, the crs parameter is omitted in the URL.","title":"URL parameters "},{"location":"topics/Interfacing/#highlight-feature-on-startup","text":"If a search text passed via st results in a unique result, the viewer automatically zooms to this result on startup. If the search result does not provide a bounding box, the minScale defined in the searchOptions of the TopBar configuration in config.json is used. When using the qwc-fulltext-search-service , you can hightlight a feature on startup as follows: - Either specify hp=<search product>&hf=<search filter> - Or specify ht=<search text>&hp=<search product> See Fulltext search for more details.","title":"Highlight feature on startup"},{"location":"topics/Interfacing/#launching-external-websites","text":"QWC2 menu entries can be configured to launch external websites as described in opening external websites .","title":"Launching external websites"},{"location":"topics/Interfacing/#javascript-api","text":"The API plugin exposes many application actions via the window.qwc2 object and makes them accessible for external applications. See API plugin reference for more details. See api_examples.js for some concrete examples.","title":"Javascript API"},{"location":"topics/LegendGraphics/","text":"Legend graphics By default, QWC2 will obtain the legend graphics of a layer from QGIS Server. Customizing the GetLegendGraphics request You can customize the GetLegendGraphics request by specifying additional query parameters in via extraLegendParameters in the theme configuration block . The list of supported query parameters is documented in the QGIS Server documentation . Providing custom legend images You can provide custom legend images by enabling the qwc-legend-service . Configure legend_images_path in the legend service configuration in tenantConfig.json : { \"name\": \"legend\", \"config\": { \"default_qgis_server_url\": \"http://qwc-qgis-server/ows/\", \"legend_images_path\": \"/legends/\" } } Note: The legend folder needs to be mounted into the qwc-legend-service container, i.e.: qwc-legend-service: image: sourcepole/qwc-feature-info-service:vYYYY.MM.DD volumes: ... - ./volumes/legends:/legends Then, legend images will be searched for in this order (the first one found is used): A <legend_images_path>/<service_name>/<layername><suffix>.png file, where service_name is the name of the WMS service layername is the WMS layer name suffix : empty, or one of _thumbnail , _tooltip . The suffix is passed by QWC2 to the legend service depending on the requested image type. A <legend_images_path>/default<suffix>.png file for a default legend image. A <legend_images_path>/<legend_image> file with legend_image as specified for the desired layer in the legend service configuration, for example: { \"name\": \"legend\", \"config\": ..., \"resources\": { \"wms_services\": [ { \"name\": \"<service name>\", \"root_layer\": { \"name\": \"<root_layer_name>\", \"layers\": [ { \"name\": \"<layer_name>\", \"legend_image\": \"edit_points.png\" } ] } } ] } }","title":"Legend graphics"},{"location":"topics/LegendGraphics/#legend-graphics","text":"By default, QWC2 will obtain the legend graphics of a layer from QGIS Server.","title":"Legend graphics"},{"location":"topics/LegendGraphics/#customizing-the-getlegendgraphics-request","text":"You can customize the GetLegendGraphics request by specifying additional query parameters in via extraLegendParameters in the theme configuration block . The list of supported query parameters is documented in the QGIS Server documentation .","title":"Customizing the GetLegendGraphics request"},{"location":"topics/LegendGraphics/#providing-custom-legend-images","text":"You can provide custom legend images by enabling the qwc-legend-service . Configure legend_images_path in the legend service configuration in tenantConfig.json : { \"name\": \"legend\", \"config\": { \"default_qgis_server_url\": \"http://qwc-qgis-server/ows/\", \"legend_images_path\": \"/legends/\" } } Note: The legend folder needs to be mounted into the qwc-legend-service container, i.e.: qwc-legend-service: image: sourcepole/qwc-feature-info-service:vYYYY.MM.DD volumes: ... - ./volumes/legends:/legends Then, legend images will be searched for in this order (the first one found is used): A <legend_images_path>/<service_name>/<layername><suffix>.png file, where service_name is the name of the WMS service layername is the WMS layer name suffix : empty, or one of _thumbnail , _tooltip . The suffix is passed by QWC2 to the legend service depending on the requested image type. A <legend_images_path>/default<suffix>.png file for a default legend image. A <legend_images_path>/<legend_image> file with legend_image as specified for the desired layer in the legend service configuration, for example: { \"name\": \"legend\", \"config\": ..., \"resources\": { \"wms_services\": [ { \"name\": \"<service name>\", \"root_layer\": { \"name\": \"<root_layer_name>\", \"layers\": [ { \"name\": \"<layer_name>\", \"legend_image\": \"edit_points.png\" } ] } } ] } }","title":"Providing custom legend images"},{"location":"topics/Mapinfo/","text":"Map info The map-info popup is displayed when right-clicking any position on the map. By default, it displayes the picked coordinates. If the qwc-elevation-service is enabled , it also returns the height at the picked position. If the qwc-mapinfo-service is enabled, queries can be configured in the service configuration in tenantConfig.json to return additional information. Example: { \"name\": \"mapinfo\", \"config\": { \"queries\": [ { \"db_url\": \"postgresql:///?service=qwc_geodb\", \"info_table\": \"qwc_geodb.ne_10m_admin_0_countries\", \"info_geom_col\": \"wkb_geometry\", \"info_display_col\": \"name\", \"info_where\": \"type = 'Sovereign country'\", \"info_title\": \"Country\" }, { \"db_url\": \"postgresql:///?service=qwc_geodb\", \"info_sql\": \"SELECT type FROM qwc_geodb.ne_10m_admin_0_countries WHERE ST_contains(wkb_geometry, ST_SetSRID(ST_Point(:x, :y), :srid)) LIMIT 1\", \"info_title\": \"Type\" } ] } } If info_table , info_geom_col , info_display_col and optionally info_where are provided, the result obtained from SELECT {info_display_col} FROM {info_table} WHERE ST_contains({info_table}.{info_geom_col}, ST_SetSRID(ST_Point(:x, :y), :srid)) AND {info_where} LIMIT 1; will be returned and displayed in the map-info popup as with title as specified in info_title . If info_sql is provided, the result obtained from the specified query will be returned. Use the :x , :y and :srid placeholders.","title":"Map info"},{"location":"topics/Mapinfo/#map-info","text":"The map-info popup is displayed when right-clicking any position on the map. By default, it displayes the picked coordinates. If the qwc-elevation-service is enabled , it also returns the height at the picked position. If the qwc-mapinfo-service is enabled, queries can be configured in the service configuration in tenantConfig.json to return additional information. Example: { \"name\": \"mapinfo\", \"config\": { \"queries\": [ { \"db_url\": \"postgresql:///?service=qwc_geodb\", \"info_table\": \"qwc_geodb.ne_10m_admin_0_countries\", \"info_geom_col\": \"wkb_geometry\", \"info_display_col\": \"name\", \"info_where\": \"type = 'Sovereign country'\", \"info_title\": \"Country\" }, { \"db_url\": \"postgresql:///?service=qwc_geodb\", \"info_sql\": \"SELECT type FROM qwc_geodb.ne_10m_admin_0_countries WHERE ST_contains(wkb_geometry, ST_SetSRID(ST_Point(:x, :y), :srid)) LIMIT 1\", \"info_title\": \"Type\" } ] } } If info_table , info_geom_col , info_display_col and optionally info_where are provided, the result obtained from SELECT {info_display_col} FROM {info_table} WHERE ST_contains({info_table}.{info_geom_col}, ST_SetSRID(ST_Point(:x, :y), :srid)) AND {info_where} LIMIT 1; will be returned and displayed in the map-info popup as with title as specified in info_title . If info_sql is provided, the result obtained from the specified query will be returned. Use the :x , :y and :srid placeholders.","title":"Map info"},{"location":"topics/MultiTenancy/","text":"Multi-Tenancy Multi-tenancy allows serving multiple viewer configurations from a single installation. Specifically, it allows separate theme, viewer (plugins, appearance, etc.) and user/permissions configurations for each tenant. By default, qwc-docker includes a single default tenant, with the respective configuration file located at qwc-docker/volumes/config-in/default/tenantConfig.json . To configure additional tenants, the main steps are as follows: Define how the tenant name is extracted from the requests. Write a tenantConfig.json , specifying the location of the configuration database, the viewer configuration and viewer assets. Extracting the tenant name from the requests Multi-tenancy works by extracting a tenant name from the request URL and passing it to the respective QWC services. A typical setup is to run the application at the base address https://<hostname>/<tenant>/ The simplest approach is to extract the tenant name in a rewrite rule and set a corresponding header which will be read by the QWC services. This can be accomplished as follows: Define the name of the tenant header in qwc-docker/docker-compose.yml by setting the TENANT_HEADER environment variable in the qwc-service-variables block, i.e.: x-qwc-service-variables: &qwc-service-variables [...] TENANT_HEADER: Tenant Add rewrite rules to the api-gateway configuration file qwc-docker/api-gateway/nginx.conf , extracting the tenant name and setting the tenant header. For example server { listen 80; server_name localhost; proxy_redirect off; server_tokens off; location ~ ^/(?<t>tenant1|tenant2) { # Extract tenant proxy_set_header Tenant $t; # Set headers for original request host proxy_set_header Host $http_host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; location ~ ^/[^/]+/auth { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-auth-service:9090; } location ~ ^/[^/]+/ows { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-ogc-service:9090; } location ~ ^/[^/]+/api/v1/featureinfo { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-feature-info-service:9090; } # etc... location ~ ^/[^/]+/qwc_admin { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-admin-gui:9090; } # Place these last to give precedence to the other rules: # Redirect request without trailing slash location ~ ^(/[^/]+)$ { return 301 $scheme://$http_host$1/; } location ~ ^/[^/]+/ { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-map-viewer:9090; } } } Writing the tenantConfig.json The tenant configuration file tenantConfig.json is located at qwc-docker/volumes/config-in/<tenant>/tenantConfig.json with <tenant> the name of the tenant. There are a number of configuration options which specifically affect the type of multi-tenancy setup, which is very flexible. Possible choices are: Shared vs. separate configuration database / admin backend Shared vs. separate viewer build Shared vs. separate qgs-resources tree etc... In general, you need to ensure that All the service URLs point to locations which are handled by the api-gateway configuration. All the paths refers to locations which are mounted in qwc-docker/docker-compose.yml . All database connection service names refer to connections which are defined qwc-docker/pg_service.conf . A minimal configuration for tenant tenant_name may look as follows: { \"$schema\": \"https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json\", \"service\": \"config-generator\", \"config\": { \"tenant\": \"tenant_name\", \"default_qgis_server_url\": \"http://qwc-qgis-server/ows/\", \"config_db_url\": \"postgresql:///?service=qwc_configdb\", \"qgis_projects_base_dir\": \"/data/tenant_name\", \"qgis_projects_scan_base_dir\": \"/data/tenant_name/scan\", \"qwc2_base_dir\": \"/qwc2\", \"ows_prefix\": \"/tenant_name/ows\", ... }, \"themesConfig\": \"./themesConfig.json\", \"services\": [ { \"name\": \"adminGui\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"qgs_resources_path\": \"/qgs-resources/tenant_name/\", \"ows_prefix\": \"/tenant_name/ows\", ... } }, { \"name\": \"dbAuth\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"config_generator_service_url\": \"http://qwc-config-service:9090\" } }, { \"name\": \"mapViewer\", \"generator_config\": { \"qwc2_config\": { \"qwc2_config_file\": \"/srv/qwc_service/config-in/tenant_name/config.json\", \"qwc2_index_file\": \"/srv/qwc_service/config-in/tenant_name/index.html\" } }, \"config\": { \"qwc2_path\": \"/qwc2/\", \"auth_service_url\": \"/tenant_name/auth/\", \"ogc_service_url\": \"/tenant_name/ows/\", \"info_service_url\": \"/tenant_name/api/v1/featureinfo/\", ... } } ] } Notes : The database URL ( postgresql:///?service=qwc_configdb ) will determine whether a shared or sperate configuration database is used for each tenant. The qwc2_config_file , qwc2_index_file , qwc2_base_dir and qwc2_path paths will determine whether the viewer build/configuration is shared or separate for each tenant. To use a separate assets folder for each tenant, you can set an appropriate assetsPath in the qwc2_config_file of each tenant. The various service URLs in the mapViewer configuration and in other service configurations need to match what is expected in the api-gateway configuration. tenantConfig template In particular when managing a large number of tenants, it can be tedious and error-prone to manage separate tenantConfig.json files for each tenant which might be nearly identical aside from the tenant name. To alleviate this, you can create a tenantConfig template, using the $tenant$ placeholder where appropriate, and point to this file in the respective tenantConfig.json files. The contents of the template will then be merged with the contents of tenantConfig.json , and occurence of $tenant$ in the template will be replaced with the current tenant name. For example, a minimal tenantConfig.json in qwc-docker/volumes/config-in/tenant_name/ could look as follows: { \"template\": \"../tenantConfig.template.json\", \"config\": { \"tenant\": \"tenant_name\" }, \"themesConfig\": \"./themesConfig.json\" } And the tenantConfig.template.json in qwc-docker/volumes/config-in/ as follows: { \"$schema\": \"https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json\", \"service\": \"config-generator\", \"config\": { \"default_qgis_server_url\": \"http://qwc-qgis-server/ows/\", \"config_db_url\": \"postgresql:///?service=qwc_configdb\", \"qgis_projects_base_dir\": \"/data\", \"qgis_projects_scan_base_dir\": \"/data/$tenant$/scan\", \"qwc2_base_dir\": \"/qwc2\", \"ows_prefix\": \"/ows\", ... }, \"themesConfig\": \"./themesConfig.json\", \"services\": [ { \"name\": \"adminGui\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"qgs_resources_path\": \"/qgs-resources/\", \"ows_prefix\": \"/ows\", ... } }, { \"name\": \"dbAuth\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"config_generator_service_url\": \"http://qwc-config-service:9090\" } }, { \"name\": \"mapViewer\", \"generator_config\": { \"qwc2_config\": { \"qwc2_config_file\": \"/srv/qwc_service/config-in/$tenant$/config.json\", \"qwc2_index_file\": \"/srv/qwc_service/config-in/$tenant$/index.html\" } }, \"config\": { \"qwc2_path\": \"/qwc2/\", \"auth_service_url\": \"/$tenant$/auth/\", \"ogc_service_url\": \"/$tenant$/ows/\", \"info_service_url\": \"/$tenant$/api/v1/featureinfo/\", ... } } ] }","title":"Multi-tenancy"},{"location":"topics/MultiTenancy/#multi-tenancy","text":"Multi-tenancy allows serving multiple viewer configurations from a single installation. Specifically, it allows separate theme, viewer (plugins, appearance, etc.) and user/permissions configurations for each tenant. By default, qwc-docker includes a single default tenant, with the respective configuration file located at qwc-docker/volumes/config-in/default/tenantConfig.json . To configure additional tenants, the main steps are as follows: Define how the tenant name is extracted from the requests. Write a tenantConfig.json , specifying the location of the configuration database, the viewer configuration and viewer assets.","title":"Multi-Tenancy"},{"location":"topics/MultiTenancy/#extracting-the-tenant-name-from-the-requests","text":"Multi-tenancy works by extracting a tenant name from the request URL and passing it to the respective QWC services. A typical setup is to run the application at the base address https://<hostname>/<tenant>/ The simplest approach is to extract the tenant name in a rewrite rule and set a corresponding header which will be read by the QWC services. This can be accomplished as follows: Define the name of the tenant header in qwc-docker/docker-compose.yml by setting the TENANT_HEADER environment variable in the qwc-service-variables block, i.e.: x-qwc-service-variables: &qwc-service-variables [...] TENANT_HEADER: Tenant Add rewrite rules to the api-gateway configuration file qwc-docker/api-gateway/nginx.conf , extracting the tenant name and setting the tenant header. For example server { listen 80; server_name localhost; proxy_redirect off; server_tokens off; location ~ ^/(?<t>tenant1|tenant2) { # Extract tenant proxy_set_header Tenant $t; # Set headers for original request host proxy_set_header Host $http_host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; location ~ ^/[^/]+/auth { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-auth-service:9090; } location ~ ^/[^/]+/ows { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-ogc-service:9090; } location ~ ^/[^/]+/api/v1/featureinfo { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-feature-info-service:9090; } # etc... location ~ ^/[^/]+/qwc_admin { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-admin-gui:9090; } # Place these last to give precedence to the other rules: # Redirect request without trailing slash location ~ ^(/[^/]+)$ { return 301 $scheme://$http_host$1/; } location ~ ^/[^/]+/ { rewrite ^/[^/]+(.+) $1 break; proxy_pass http://qwc-map-viewer:9090; } } }","title":"Extracting the tenant name from the requests"},{"location":"topics/MultiTenancy/#writing-the-tenantconfigjson","text":"The tenant configuration file tenantConfig.json is located at qwc-docker/volumes/config-in/<tenant>/tenantConfig.json with <tenant> the name of the tenant. There are a number of configuration options which specifically affect the type of multi-tenancy setup, which is very flexible. Possible choices are: Shared vs. separate configuration database / admin backend Shared vs. separate viewer build Shared vs. separate qgs-resources tree etc... In general, you need to ensure that All the service URLs point to locations which are handled by the api-gateway configuration. All the paths refers to locations which are mounted in qwc-docker/docker-compose.yml . All database connection service names refer to connections which are defined qwc-docker/pg_service.conf . A minimal configuration for tenant tenant_name may look as follows: { \"$schema\": \"https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json\", \"service\": \"config-generator\", \"config\": { \"tenant\": \"tenant_name\", \"default_qgis_server_url\": \"http://qwc-qgis-server/ows/\", \"config_db_url\": \"postgresql:///?service=qwc_configdb\", \"qgis_projects_base_dir\": \"/data/tenant_name\", \"qgis_projects_scan_base_dir\": \"/data/tenant_name/scan\", \"qwc2_base_dir\": \"/qwc2\", \"ows_prefix\": \"/tenant_name/ows\", ... }, \"themesConfig\": \"./themesConfig.json\", \"services\": [ { \"name\": \"adminGui\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"qgs_resources_path\": \"/qgs-resources/tenant_name/\", \"ows_prefix\": \"/tenant_name/ows\", ... } }, { \"name\": \"dbAuth\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"config_generator_service_url\": \"http://qwc-config-service:9090\" } }, { \"name\": \"mapViewer\", \"generator_config\": { \"qwc2_config\": { \"qwc2_config_file\": \"/srv/qwc_service/config-in/tenant_name/config.json\", \"qwc2_index_file\": \"/srv/qwc_service/config-in/tenant_name/index.html\" } }, \"config\": { \"qwc2_path\": \"/qwc2/\", \"auth_service_url\": \"/tenant_name/auth/\", \"ogc_service_url\": \"/tenant_name/ows/\", \"info_service_url\": \"/tenant_name/api/v1/featureinfo/\", ... } } ] } Notes : The database URL ( postgresql:///?service=qwc_configdb ) will determine whether a shared or sperate configuration database is used for each tenant. The qwc2_config_file , qwc2_index_file , qwc2_base_dir and qwc2_path paths will determine whether the viewer build/configuration is shared or separate for each tenant. To use a separate assets folder for each tenant, you can set an appropriate assetsPath in the qwc2_config_file of each tenant. The various service URLs in the mapViewer configuration and in other service configurations need to match what is expected in the api-gateway configuration.","title":"Writing the tenantConfig.json"},{"location":"topics/MultiTenancy/#tenantconfig-template","text":"In particular when managing a large number of tenants, it can be tedious and error-prone to manage separate tenantConfig.json files for each tenant which might be nearly identical aside from the tenant name. To alleviate this, you can create a tenantConfig template, using the $tenant$ placeholder where appropriate, and point to this file in the respective tenantConfig.json files. The contents of the template will then be merged with the contents of tenantConfig.json , and occurence of $tenant$ in the template will be replaced with the current tenant name. For example, a minimal tenantConfig.json in qwc-docker/volumes/config-in/tenant_name/ could look as follows: { \"template\": \"../tenantConfig.template.json\", \"config\": { \"tenant\": \"tenant_name\" }, \"themesConfig\": \"./themesConfig.json\" } And the tenantConfig.template.json in qwc-docker/volumes/config-in/ as follows: { \"$schema\": \"https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json\", \"service\": \"config-generator\", \"config\": { \"default_qgis_server_url\": \"http://qwc-qgis-server/ows/\", \"config_db_url\": \"postgresql:///?service=qwc_configdb\", \"qgis_projects_base_dir\": \"/data\", \"qgis_projects_scan_base_dir\": \"/data/$tenant$/scan\", \"qwc2_base_dir\": \"/qwc2\", \"ows_prefix\": \"/ows\", ... }, \"themesConfig\": \"./themesConfig.json\", \"services\": [ { \"name\": \"adminGui\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"qgs_resources_path\": \"/qgs-resources/\", \"ows_prefix\": \"/ows\", ... } }, { \"name\": \"dbAuth\", \"config\": { \"db_url\": \"postgresql:///?service=qwc_configdb\", \"config_generator_service_url\": \"http://qwc-config-service:9090\" } }, { \"name\": \"mapViewer\", \"generator_config\": { \"qwc2_config\": { \"qwc2_config_file\": \"/srv/qwc_service/config-in/$tenant$/config.json\", \"qwc2_index_file\": \"/srv/qwc_service/config-in/$tenant$/index.html\" } }, \"config\": { \"qwc2_path\": \"/qwc2/\", \"auth_service_url\": \"/$tenant$/auth/\", \"ogc_service_url\": \"/$tenant$/ows/\", \"info_service_url\": \"/$tenant$/api/v1/featureinfo/\", ... } } ] }","title":"tenantConfig template"},{"location":"topics/Printing/","text":"Printing QWC2 supports printing to PDF via the QGIS Server GetPrint request. The basic steps are: Ensure the Print plugin is enabled in the QWC2 viewer. Create print layouts in the QGIS project as desired. The layouts must contain one Map element. Generate the themes configuration . The available print layouts will then appear in the QWC2 print plugin. You can limit the available print scales by setting printScales (or defaultPrintScales ) in the theme configuration to a list of scale denominators. If the list is empty, the print scale can be freely chosen. Similarly, you can limit the available print resolutions by setting printResolutions (or defaultPrintResolutions ) in the theme configuration to a list of resolutions. If the list is empty, the print resolution can be freely chosen. External WMS layers are automatically printed if the Print plugin config option printExternalLayers is true (default). Note that printing external WMTS layers is currently not supported by the QGIS Server. You can enable the option to generate a GeoPDF by setting the the Print plugin config option allowGeoPdfExport to true . Note: This is only supported on QGIS Server 3.32 and newer. Some additional tasks include: Configuring the print background layers Configuring user labels Configuring the print grid Configuring layouts with legend Configuring atlas printing Configuring print background layers Background layers are handled purely client-side in QWC2. There are two options for printing the background layer: The first option is to mark a QGIS project layer as print layer by adding a printLayer to the background layer entry when writing the themes configuration , i.e.: { ... \"backgroundLayers\": [ {\"name\": \"<background layer name>\", \"printLayer\": \"<qgis layer name>\"} ] } A QGIS layer marked as printLayer will be filtered out from the QWC2 layer tree. This approach allows i.e. using a WMTS background layer in the web client for higher performance, and using a WMS background layer when printing for higher quality/resolution. The second option is to use WMS background layers, which are automatically printed a external layers. User labels User labels appear as free-text input fields in the QWC2 print dialog. To configure user labels, it is sufficient to add item id s to layout label items in the print layout. The specified id will appear as input field label in the QWC2 print dialog. Note : Label id s beginning with __ (two underscore characters) are ignored as user labels by QWC2. You can can customize the input field (max length, number of rows) by setting the printLabelConfig in the theme configuration . Also, in the theme configuration, you can also set: printLabelForSearchResult : The id of the label to which to write the current search result label, if any. printLabelForAttribution : The id of the label to which to write the current map attribution text, if any. If you set the Print plugin config option hideAutopopulatedFields to true , these labels will not be shown in the print dialog, otherwise they will be displayed as read-only fields. Print grid In alternative to configuring a grid directly in the print layout, one can also define a printGrid configuration in the theme configuration . For example \"printGrid\": { \"s\": 1000, \"x\": 500, \"y\": 500, \"s\": 2000, \"y\": 1000, \"y\": 1000, \"s\": 10000, \"y\": 5000, \"y\": 5000, } will print a 500x500 (map units) grid for scales up to 1:1000 , a 1000x1000 grid for scales up to 1:2000 , etc. Layouts with legend The QWC2 print dialog will expose a toggle switch to enable the legend in the print output for layout <layout_name> if the QGIS project contains a second layout named <layout_name>_legend . The layout with the _legend suffix is expected to contain a legend item. Atlas printing To enable atlas printing in QWC2, configure the QGIS project as follows: Check the Generate an atlas checkbox in the desired layout in QGIS layout designer → Atlas → Atlas settings , selecting the coverage layer as desired. In the layout map item properties, check Controlled by Atlas . In the Project properties → QGIS Server , set Maximum features for Atlas print requests to the desired value. QWC2 will then display a feature picked in the print dialog which will allow picking the desired atlas features, and QGIS Server will generate a multi-page PDF accordingly.","title":"Printing"},{"location":"topics/Printing/#printing","text":"QWC2 supports printing to PDF via the QGIS Server GetPrint request. The basic steps are: Ensure the Print plugin is enabled in the QWC2 viewer. Create print layouts in the QGIS project as desired. The layouts must contain one Map element. Generate the themes configuration . The available print layouts will then appear in the QWC2 print plugin. You can limit the available print scales by setting printScales (or defaultPrintScales ) in the theme configuration to a list of scale denominators. If the list is empty, the print scale can be freely chosen. Similarly, you can limit the available print resolutions by setting printResolutions (or defaultPrintResolutions ) in the theme configuration to a list of resolutions. If the list is empty, the print resolution can be freely chosen. External WMS layers are automatically printed if the Print plugin config option printExternalLayers is true (default). Note that printing external WMTS layers is currently not supported by the QGIS Server. You can enable the option to generate a GeoPDF by setting the the Print plugin config option allowGeoPdfExport to true . Note: This is only supported on QGIS Server 3.32 and newer. Some additional tasks include: Configuring the print background layers Configuring user labels Configuring the print grid Configuring layouts with legend Configuring atlas printing","title":"Printing"},{"location":"topics/Printing/#configuring-print-background-layers","text":"Background layers are handled purely client-side in QWC2. There are two options for printing the background layer: The first option is to mark a QGIS project layer as print layer by adding a printLayer to the background layer entry when writing the themes configuration , i.e.: { ... \"backgroundLayers\": [ {\"name\": \"<background layer name>\", \"printLayer\": \"<qgis layer name>\"} ] } A QGIS layer marked as printLayer will be filtered out from the QWC2 layer tree. This approach allows i.e. using a WMTS background layer in the web client for higher performance, and using a WMS background layer when printing for higher quality/resolution. The second option is to use WMS background layers, which are automatically printed a external layers.","title":"Configuring print background layers "},{"location":"topics/Printing/#user-labels","text":"User labels appear as free-text input fields in the QWC2 print dialog. To configure user labels, it is sufficient to add item id s to layout label items in the print layout. The specified id will appear as input field label in the QWC2 print dialog. Note : Label id s beginning with __ (two underscore characters) are ignored as user labels by QWC2. You can can customize the input field (max length, number of rows) by setting the printLabelConfig in the theme configuration . Also, in the theme configuration, you can also set: printLabelForSearchResult : The id of the label to which to write the current search result label, if any. printLabelForAttribution : The id of the label to which to write the current map attribution text, if any. If you set the Print plugin config option hideAutopopulatedFields to true , these labels will not be shown in the print dialog, otherwise they will be displayed as read-only fields.","title":"User labels "},{"location":"topics/Printing/#print-grid","text":"In alternative to configuring a grid directly in the print layout, one can also define a printGrid configuration in the theme configuration . For example \"printGrid\": { \"s\": 1000, \"x\": 500, \"y\": 500, \"s\": 2000, \"y\": 1000, \"y\": 1000, \"s\": 10000, \"y\": 5000, \"y\": 5000, } will print a 500x500 (map units) grid for scales up to 1:1000 , a 1000x1000 grid for scales up to 1:2000 , etc.","title":"Print grid "},{"location":"topics/Printing/#layouts-with-legend","text":"The QWC2 print dialog will expose a toggle switch to enable the legend in the print output for layout <layout_name> if the QGIS project contains a second layout named <layout_name>_legend . The layout with the _legend suffix is expected to contain a legend item.","title":"Layouts with legend "},{"location":"topics/Printing/#atlas-printing","text":"To enable atlas printing in QWC2, configure the QGIS project as follows: Check the Generate an atlas checkbox in the desired layout in QGIS layout designer → Atlas → Atlas settings , selecting the coverage layer as desired. In the layout map item properties, check Controlled by Atlas . In the Project properties → QGIS Server , set Maximum features for Atlas print requests to the desired value. QWC2 will then display a feature picked in the print dialog which will allow picking the desired atlas features, and QGIS Server will generate a multi-page PDF accordingly.","title":"Atlas printing "},{"location":"topics/Search/","text":"Search QWC2 can be configured to use arbitrary custom search providers. In addition, the qwc-fulltext-search-service provided by the qwc-services ecosystem can be used. Adding search providers Search providers can be defined as follows: Built-in, defined in js/SearchProviders.js . This file is structured as follows: export const SearchProviders = { <providerkey1>: <ProviderDefinition1>, <providerkey2>: <ProviderDefinition2>, ... }; Built-in search providers are compiled into the application bundle and avoid the need for an extra resource to be loaded on application startup. The downside is that you need to rebuild QWC2 to add/modify search providers. As resource, defined in static/assets/searchProviders.js . This file is structured as follows: window.QWC2SearchProviders = { <providerkey1>: <ProviderDefinition1>, <providerkey2>: <ProviderDefinition2>, ... }; This script file needs to be loaded explicitly by index.html via <script type=\"text/javascript\" src=\"assets/searchProviders.js\" ></script> The format of ProviderDefinition is { label: \"<human readable provider name>\", // OR labelmsgid: \"<translation message ID for human readable provider name>\", onSearch: function(searchText, searchParams, callback, axios) => { const results = []; // See below /* Populate results... */ callback({results: results}); }, getResultGeometry: function(resultItem, callback, axios) => { /* Retreive geometry... */ // resultItem is a search result entry as returned by onSearch, which provides the context for retreiving the geometry const geometry = \"<wktString>\"; const crs = \"EPSG:XXXX\"; const hidemarker = <boolean>; // Whether to suppress displaying a search marker on top of the search geometry callback({geometry: wktString, crs: crs, hidemarker: hidemarker}); } } Notes: The format of searchParams is { displaycrs: \"EPSG:XXXX\", // Currently selected mouse coordinate display CRS mapcrs: \"EPSG:XXXX\", // The current map CRS lang: \"<code>\", // The current application language, i.e. en-US or en cfgParams: <params> // Additional parameters passed in the theme search provider configuration, see below } axios is passed for convenience so that providers can use the compiled-in axios library for network requests. The format of the results list returned by onSearch is as follows: results = [ { id: \"<categoryid>\", // Unique category ID title: \"<display_title>\", // Text to display as group title in the search results priority: priority_nr, // Optional: search result group priority. Groups with higher priority are displayed first in the list. items: [ { // Location search result: type: SearchResultType.PLACE, // Specifies that this is a location search result id: \"<itemId\">, // Unique item ID text: \"<display text>\", // Text to display as search result label: \"<map marker text>\", // Optional, text to show next to the position marker on the map instead of `text` x: x, // X coordinate of result y: y, // Y coordinate of result crs: crs, // CRS of result coordinates and bbox bbox: [xmin, ymin, xmax, ymax] // Bounding box of result (if non-empty, map will zoom to this extent when selecting result) }, { // Theme layer search result (advanced): type: SearchResultType.THEMELAYER, // Specifies that this is a theme layer search result id: \"<itemId\">, // Unique item ID text: \"<display text>\", // Text to display as search result layer: {<Layer definition>} // Layer definition, in the same format as a \"sublayers\" entry in themes.json. } ] }, { ... } ] Consult js/SearchProviders.js and static/assets/searchProviders.js for full examples. Configuring theme search providers For each theme item in themesConfig.json , you can define a list of search providers to enable for the theme as follows: ... searchProviders: [ \"<providerkey1>\", // Simple form { // Provider with custom params key: \"<providerkey2>\", params: { ... // Arbitrary params passed to the provider `onSearch` function as `searchParams.cfgParams` } }, { // Fulltext search configuration using qwc-fulltext-search-service \"provider\":\"solr\", // Identifier for solr search provider \"default\":[<default terms>] // Default search terms, concatenated with additional search terms from visible theme layers } ], ... Note: The qwc2-demo-app (also used by the qwc-map-viewer-demo docker image) includes two providers by default: coordinates and nominatim (OpenStreetMap location search). Configuring the fulltext search service For more information on the full-text search provider, see qwc-fulltext-search-service .","title":"Search"},{"location":"topics/Search/#search","text":"QWC2 can be configured to use arbitrary custom search providers. In addition, the qwc-fulltext-search-service provided by the qwc-services ecosystem can be used.","title":"Search"},{"location":"topics/Search/#adding-search-providers","text":"Search providers can be defined as follows: Built-in, defined in js/SearchProviders.js . This file is structured as follows: export const SearchProviders = { <providerkey1>: <ProviderDefinition1>, <providerkey2>: <ProviderDefinition2>, ... }; Built-in search providers are compiled into the application bundle and avoid the need for an extra resource to be loaded on application startup. The downside is that you need to rebuild QWC2 to add/modify search providers. As resource, defined in static/assets/searchProviders.js . This file is structured as follows: window.QWC2SearchProviders = { <providerkey1>: <ProviderDefinition1>, <providerkey2>: <ProviderDefinition2>, ... }; This script file needs to be loaded explicitly by index.html via <script type=\"text/javascript\" src=\"assets/searchProviders.js\" ></script> The format of ProviderDefinition is { label: \"<human readable provider name>\", // OR labelmsgid: \"<translation message ID for human readable provider name>\", onSearch: function(searchText, searchParams, callback, axios) => { const results = []; // See below /* Populate results... */ callback({results: results}); }, getResultGeometry: function(resultItem, callback, axios) => { /* Retreive geometry... */ // resultItem is a search result entry as returned by onSearch, which provides the context for retreiving the geometry const geometry = \"<wktString>\"; const crs = \"EPSG:XXXX\"; const hidemarker = <boolean>; // Whether to suppress displaying a search marker on top of the search geometry callback({geometry: wktString, crs: crs, hidemarker: hidemarker}); } } Notes: The format of searchParams is { displaycrs: \"EPSG:XXXX\", // Currently selected mouse coordinate display CRS mapcrs: \"EPSG:XXXX\", // The current map CRS lang: \"<code>\", // The current application language, i.e. en-US or en cfgParams: <params> // Additional parameters passed in the theme search provider configuration, see below } axios is passed for convenience so that providers can use the compiled-in axios library for network requests. The format of the results list returned by onSearch is as follows: results = [ { id: \"<categoryid>\", // Unique category ID title: \"<display_title>\", // Text to display as group title in the search results priority: priority_nr, // Optional: search result group priority. Groups with higher priority are displayed first in the list. items: [ { // Location search result: type: SearchResultType.PLACE, // Specifies that this is a location search result id: \"<itemId\">, // Unique item ID text: \"<display text>\", // Text to display as search result label: \"<map marker text>\", // Optional, text to show next to the position marker on the map instead of `text` x: x, // X coordinate of result y: y, // Y coordinate of result crs: crs, // CRS of result coordinates and bbox bbox: [xmin, ymin, xmax, ymax] // Bounding box of result (if non-empty, map will zoom to this extent when selecting result) }, { // Theme layer search result (advanced): type: SearchResultType.THEMELAYER, // Specifies that this is a theme layer search result id: \"<itemId\">, // Unique item ID text: \"<display text>\", // Text to display as search result layer: {<Layer definition>} // Layer definition, in the same format as a \"sublayers\" entry in themes.json. } ] }, { ... } ] Consult js/SearchProviders.js and static/assets/searchProviders.js for full examples.","title":"Adding search providers"},{"location":"topics/Search/#configuring-theme-search-providers","text":"For each theme item in themesConfig.json , you can define a list of search providers to enable for the theme as follows: ... searchProviders: [ \"<providerkey1>\", // Simple form { // Provider with custom params key: \"<providerkey2>\", params: { ... // Arbitrary params passed to the provider `onSearch` function as `searchParams.cfgParams` } }, { // Fulltext search configuration using qwc-fulltext-search-service \"provider\":\"solr\", // Identifier for solr search provider \"default\":[<default terms>] // Default search terms, concatenated with additional search terms from visible theme layers } ], ... Note: The qwc2-demo-app (also used by the qwc-map-viewer-demo docker image) includes two providers by default: coordinates and nominatim (OpenStreetMap location search).","title":"Configuring theme search providers"},{"location":"topics/Search/#configuring-the-fulltext-search-service","text":"For more information on the full-text search provider, see qwc-fulltext-search-service .","title":"Configuring the fulltext search service "},{"location":"topics/Snapping/","text":"Snapping QWC2 ships a plugin for snapping support while drawing (redlining / measuring / editing). To enable it, make sure the SnappingSupport plugin is enabled in appConfig.js (see the sample sample js/appConfig.js ). Then, for each theme for which you want snapping to be available, you can add a snapping block to your theme item in themesConfig.json as follows: ... \"snapping\": { \"snaplayers\": [ { \"name\": \"<layername>\", \"min\": <min_scale>, \"max\": <max_scale> } ], \"featureCount\": <feature_count> } ... where: layername is the name of the theme sublayer from which to retreive the snapping geometries min is the minimum scale denominator (inclusive) from which this layer should be used for snapping max is the maximum scale denominator (exclusive) up to which this layer should be used for snapping feature_count is the maximum number of snapping geometries to retreive for the current map extent (default: 500). Note : Snapping works by querying the geometries of all snapping layers inside the scale range via WMS GetFeatureInfo and refreshing the geometries every time the map extent changes. Therefore, it is recommended to ensure the geometry complexity of the snap layers is appropriate for the specified scale ranges to avoid overloading the server with the GetFeatureInfo requests. Also, the QGIS project will need to be configured so that snap layers are queryable and that feature info responses contain geometries. For the Redlining , Measure and Editing plugins, the availability of snapping can be independently configured: { \"name\":\"<Redlining|Measure|Editing>\", \"cfg\": { \"snapping\": <true|false>, \"snappingActive\": <true|false>, ... } } where: snapping determines whether snapping is available for the specified plugin snappingActive determines whether snapping is active by default for the specified plugin When snapping is available, a small toolbar appears on the bottom border of the map with the possibility to toggle snapping.","title":"Snapping"},{"location":"topics/Snapping/#snapping","text":"QWC2 ships a plugin for snapping support while drawing (redlining / measuring / editing). To enable it, make sure the SnappingSupport plugin is enabled in appConfig.js (see the sample sample js/appConfig.js ). Then, for each theme for which you want snapping to be available, you can add a snapping block to your theme item in themesConfig.json as follows: ... \"snapping\": { \"snaplayers\": [ { \"name\": \"<layername>\", \"min\": <min_scale>, \"max\": <max_scale> } ], \"featureCount\": <feature_count> } ... where: layername is the name of the theme sublayer from which to retreive the snapping geometries min is the minimum scale denominator (inclusive) from which this layer should be used for snapping max is the maximum scale denominator (exclusive) up to which this layer should be used for snapping feature_count is the maximum number of snapping geometries to retreive for the current map extent (default: 500). Note : Snapping works by querying the geometries of all snapping layers inside the scale range via WMS GetFeatureInfo and refreshing the geometries every time the map extent changes. Therefore, it is recommended to ensure the geometry complexity of the snap layers is appropriate for the specified scale ranges to avoid overloading the server with the GetFeatureInfo requests. Also, the QGIS project will need to be configured so that snap layers are queryable and that feature info responses contain geometries. For the Redlining , Measure and Editing plugins, the availability of snapping can be independently configured: { \"name\":\"<Redlining|Measure|Editing>\", \"cfg\": { \"snapping\": <true|false>, \"snappingActive\": <true|false>, ... } } where: snapping determines whether snapping is available for the specified plugin snappingActive determines whether snapping is active by default for the specified plugin When snapping is available, a small toolbar appears on the bottom border of the map with the possibility to toggle snapping.","title":"Snapping"},{"location":"topics/TimeManager/","text":"Temporal layers (Time Manager) QWC2 supports WMS layers with time dimension (WMS-T) through the TimeManager plugin. To view and manage temporal layers in QWC2, add a new time dimension, selecting appropriate temporal fields as start- and end-attributes in the QGIS Layer Properties \u2192 QGIS Server \u2192 Dimensions. For the time markers functionality in the Time Manager plugin to work correctly, you also need to enable the qwc-feature-info-service . Note: The QGIS Layer Properties \u2192 Temporal settings are ignored by QGIS Server and hence have no effect in QWC2.","title":"Temporal layers"},{"location":"topics/TimeManager/#temporal-layers-time-manager","text":"QWC2 supports WMS layers with time dimension (WMS-T) through the TimeManager plugin. To view and manage temporal layers in QWC2, add a new time dimension, selecting appropriate temporal fields as start- and end-attributes in the QGIS Layer Properties \u2192 QGIS Server \u2192 Dimensions. For the time markers functionality in the Time Manager plugin to work correctly, you also need to enable the qwc-feature-info-service . Note: The QGIS Layer Properties \u2192 Temporal settings are ignored by QGIS Server and hence have no effect in QWC2.","title":"Temporal layers (Time Manager)"}]} \ No newline at end of file diff --git a/search/worker.js b/search/worker.js new file mode 100644 index 00000000..8628dbce --- /dev/null +++ b/search/worker.js @@ -0,0 +1,133 @@ +var base_path = 'function' === typeof importScripts ? '.' : '/search/'; +var allowSearch = false; +var index; +var documents = {}; +var lang = ['en']; +var data; + +function getScript(script, callback) { + console.log('Loading script: ' + script); + $.getScript(base_path + script).done(function () { + callback(); + }).fail(function (jqxhr, settings, exception) { + console.log('Error: ' + exception); + }); +} + +function getScriptsInOrder(scripts, callback) { + if (scripts.length === 0) { + callback(); + return; + } + getScript(scripts[0], function() { + getScriptsInOrder(scripts.slice(1), callback); + }); +} + +function loadScripts(urls, callback) { + if( 'function' === typeof importScripts ) { + importScripts.apply(null, urls); + callback(); + } else { + getScriptsInOrder(urls, callback); + } +} + +function onJSONLoaded () { + data = JSON.parse(this.responseText); + var scriptsToLoad = ['lunr.js']; + if (data.config && data.config.lang && data.config.lang.length) { + lang = data.config.lang; + } + if (lang.length > 1 || lang[0] !== "en") { + scriptsToLoad.push('lunr.stemmer.support.js'); + if (lang.length > 1) { + scriptsToLoad.push('lunr.multi.js'); + } + if (lang.includes("ja") || lang.includes("jp")) { + scriptsToLoad.push('tinyseg.js'); + } + for (var i=0; i < lang.length; i++) { + if (lang[i] != 'en') { + scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); + } + } + } + loadScripts(scriptsToLoad, onScriptsLoaded); +} + +function onScriptsLoaded () { + console.log('All search scripts loaded, building Lunr index...'); + if (data.config && data.config.separator && data.config.separator.length) { + lunr.tokenizer.separator = new RegExp(data.config.separator); + } + + if (data.index) { + index = lunr.Index.load(data.index); + data.docs.forEach(function (doc) { + documents[doc.location] = doc; + }); + console.log('Lunr pre-built index loaded, search ready'); + } else { + index = lunr(function () { + if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { + this.use(lunr[lang[0]]); + } else if (lang.length > 1) { + this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility + } + this.field('title'); + this.field('text'); + this.ref('location'); + + for (var i=0; i < data.docs.length; i++) { + var doc = data.docs[i]; + this.add(doc); + documents[doc.location] = doc; + } + }); + console.log('Lunr index built, search ready'); + } + allowSearch = true; + postMessage({config: data.config}); + postMessage({allowSearch: allowSearch}); +} + +function init () { + var oReq = new XMLHttpRequest(); + oReq.addEventListener("load", onJSONLoaded); + var index_path = base_path + '/search_index.json'; + if( 'function' === typeof importScripts ){ + index_path = 'search_index.json'; + } + oReq.open("GET", index_path); + oReq.send(); +} + +function search (query) { + if (!allowSearch) { + console.error('Assets for search still loading'); + return; + } + + var resultDocuments = []; + var results = index.search(query); + for (var i=0; i < results.length; i++){ + var result = results[i]; + doc = documents[result.ref]; + doc.summary = doc.text.substring(0, 200); + resultDocuments.push(doc); + } + return resultDocuments; +} + +if( 'function' === typeof importScripts ) { + onmessage = function (e) { + if (e.data.init) { + init(); + } else if (e.data.query) { + postMessage({ results: search(e.data.query) }); + } else { + console.error("Worker - Unrecognized message: " + e); + } + }; +} diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..acc6c8c0 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,188 @@ +<?xml version="1.0" encoding="UTF-8"?> +<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> + <url> + <loc>None</loc> + <lastmod>2023-08-23</lastmod> + <changefreq>daily</changefreq> + </url> +</urlset> \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 00000000..a4399ff8 Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/topics/Editing/index.html b/topics/Editing/index.html new file mode 100644 index 00000000..a27221f4 --- /dev/null +++ b/topics/Editing/index.html @@ -0,0 +1,372 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + <meta http-equiv="X-UA-Compatible" content="IE=edge" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <link rel="shortcut icon" href="../../img/favicon.ico" /> + <title>Editing - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Editing
    • +
  • +
    • +
+
+
+
+
+ +

Editing

+

QWC2 offers comprehensive editing support through a variety of plugins:

+
    +
  • The Editing plugin allows creating, editing and removing features of an editable vector layer. It supports editing both geometry and attributes, displaying customizeable attribute forms.
    • +
  • The AttributeTable plugin also allows creating, editing and removing features of an editable vector layer. It displays all features of the editable layer in a tabularized view, and allows editing attributes, but not geometries. Noteably, it will allow editing geometryless datasets.
    • +
  • The FeatureForm works similarly to the feature-info, but will display the feature form according to the QGIS form configuration, and also allows editing the attributes and geometry of a picked feature. It can configured as identifyTool instead of the standard Identify plugin in config.json.
    • +
+

Quick start

+

The easiest way to use the editing functionality is by using the pre-configured qwc-docker with the qwc-data-service and qwc-config-generator.

+

To make a layer editable, follow these steps:

+
    +
  • The datasource of the layer needs to be a PostGIS database. In particular, make sure that a primary key is configured for your dataset!
    • +
  • Configure the QGIS PostgreSQL connection using a service name, add the corresponding service definition to your host pg_service.conf and to qwc-docker/pg_service-write.conf. Make sure your database host is reachable within the docker containers!
    • +
  • Especially when your primary key field type is serial, you'll want to mark the corresponding field widget type as Hidden in the QGIS Attributes Form settings.
    • +
  • Create a Data resource as child of the corresponding Map resource in the administration backend, and create a new permission for the Map and Data resources for the roles which should be allowed to edit the layer.
    • +
  • Note: if you leave the "Write" checkbox in the Data resource permission unchecked, the dataset will be available as read-only, which can be useful if you want to use the AttributeTable and/or FeatureForm to just display the dataset without allowing any edits.
    • +
  • Run the config generator from the administration backend to update service configuration.
    • +
+

Designing the edit forms

+

Much of the power of the QWC2 editing functionality resides in its fully customizeable forms, providing support for different input widget types, file uploads and 1:N relations.

+

The qwc-config-generator will automatically generate forms based on the configuration specified in the QGIS Layer Properties → Attributes Form. If Autogenerate or Drag and Drop Designer is chosen, a corresponding Qt UI form is automatically generated for QWC2 in assets/forms/autogen. If Provide ui-file is chosen, the specified UI form will copied to assets/forms/autogen.

+

Localized translation forms are supported. To this end, place a Qt Translation file called <form_basename>_<lang>.ts next to the designer form <form_basename>.ui, where lang is a language or language/country code, i.e. en or en-US. There is a translateui.sh script to help generate the translation files. Example:

+
./translateui.sh .../qwc2/assets/forms/form.ui de it fr
+
+

File uploads

+

You can configure a text-like field of your dataset as an upload field as follows:

+
    +
  • For Autogenerated and Drag and Drop Designer forms configuration, set the widget type to Attachment. You can set the file type filter in the widget configuration under Display button to open file dialog -> Filter, in the format *.ext1, *.ext2.
    • +
  • For manually created Qt Designed Ui forms, use a QLineEdit widget named <fieldname>__upload, and optionally as the text value of the QLineEdit set a comma separated list of suggested file extensions.
    • +
+

Attachments are stored on disk below the attachments_base_dir defined in the data service configuration, and the path to the attachments stored in the dataset.

+

Note:

+
    +
  • If you set the fomrat constraint to *.jpeg and your browser has access to a camera, QWC2 will allow you to directly upload images captured from the camera.
    • +
  • You can set the allowed attachment extensions and maximum file sizes globally by setting allowed_attachment_extensions and max_attachment_file_size in the data service configuration. You may also need to set/increase client_max_body_size in qwc-docker/api-gateway/nginx.conf.
    • +
  • You can also set the allowed attachment extensions and maximum file sizes per dataset by setting max_attachment_file_size_per_dataset and allowed_extensions_per_dataset in the data service configuration. If you set the per dataset values, the global settings will be disregarded (i.e. if an attachment satisfies the per dataset constraint it will be considered valid, even if it violates the global constraint).
    • +
  • To ensure the uploaded files are properly rendered as download links in GetFeatureInfo responses, use the qwc-feature-info-service.
    • +
+

Key-value relations (value mappings)

+

Value relations allow mapping technical values to a human readable display strings, displayed in a combo box.

+

For Autogenerated and Drag and Drop Designer, use widgets of type Value Relation.

+

In a manually created Qt-Designer Ui form, you can use key-value relations for combo box entries by naming the QComboBox widget according to the following pattern: kvrel__<fieldname>__<kvtablename>__<kvtable_valuefield>__<kvtable_labelfield>. <kvtablename> refers to a table containing a field called <kvtable_valuefield> for the value of the entry and a field <kvtable_labelfield> for the label of the entry. For key-value relations inside a 1:N relation, use kvrel__<reltablename>__<fieldname>__<kvtablename>__<kvtable_valuefield>__<kvtable_labelfield>.

+

Note: The relation table needs to be added as a (geometryless) table to the QGIS Project. You also need to set appropriate permissions for the relation table dataset in the QWC admin backend. Alternatively, you can set autogen_keyvaltable_datasetsto true in the config generator configuration, to automatically generate resources and read-only permissions as required.

+

1:N relations

+

1:N relations allow associating multiple child records to the target feature, displayed in a table.

+

For Autogenerated and Drag and Drop Designer, configure the 1:N relation in QGIS Project → Properties → Relations. Note that the child table foreign key must refer to parent primary key.

+

In a manually created Qt-Designer Ui form, create a widget of type QWidget, QGroupBox or QFrame named according to the pattern nrel__<reltablename>__<foreignkeyfield>, where <reltablename> is the name of the relation table and <foreignkeyfield> the name of the foreign key field in the relation table. Inside this widget, add the edit widgets for the values of the relation table. Name the widgets <reltablename>__<fieldname>. These edit widgets will be replicated for each relation record.

+

Notes:

+
    +
  • In a manually created Qt-Designer Ui form, you can also specify a sort column for the 1:N relation in the form nrel__<reltablename>__<foreignkeyfield>__<sortcol>. If a sort-column is specified, QWC2 will display sort arrows for each entry in the relation widget.
    • +
  • The relation table needs to be added as a (geometryless) table to the QGIS Project. You also need to set appropriate permissions for the relation table dataset in the QWC admin backend.
    • +
+

Special form widgets

+

In manually created Qt-Designer Ui forms, there are a number of special widgets you can use:

+
    +
  • Images: To display attribute values which contain an image URL as an inline image, use a QLabel named img__<fieldname>.
    • +
  • Linked features: To display a button to choose a linked feature and edit its attributes in a nested edit form, create a QPushButton named featurelink__<linkdataset>__<fieldname> (simple join) or featurelink__<linkdataset>__<reltable>__<fieldname> in a 1:N relation. In a 1:N relation, linkdataset can be equal to reltable to edit the relation record itself in the nested form. fieldname will contain the id of the linked feature.
    • +
  • External fields: Some times it is useful to display information from an external source in the edit form. This can be accomplished by creating a QWidget with name ext__<fieldname> and using a form preprocessor hook (see registerFormPreprocessor in QtDesignerForm.jsx to populate the field by assigning a React fragment to formData.externalFields.<fieldname>.
    • +
  • Buttons: To add a button with a custom action, add a QPushButton with name btn__<buttonname>, and use a form preprocessor hook to set the custom function to formData.buttons.buttonname.onClick.
    • +
+

Logging mutations

+

The qwc-data-service offers some basic functionality for logging mutations:

+
    +
  • If you set upload_user_field_suffix in the data service config, the username of the last user who performed a mutation to <fieldname> will be logged to <fieldname>__<upload_user_field_suffix>.
    • +
  • If you set edit_user_field in the data service config, the username of the last user who performed a mutation to a record with be logged to the <edit_user_field> field of the record.
    • +
  • If you set edit_timestamp_field in the data service config, the timestamp of the last mutation to a record will be logged to the <edit_timestamp_field> field of the record.
    • +
+

Note: for these fields to be written, ensure the qgis project is also up-to-date, i.e. that contain the up-to-date table schemas. You can set the respective field types to hidden in the QGIS layer properties to avoid them showing up in the autogenerated edit forms.

+

Using a custom editing backend

+

You can also use a custom editing backend instead of the qwc-data-service by following these steps:

+
    +
  • Implement the custom editing interface, taking default EditingInterface.js as a template.
    • +
  • Enable the desired editing plugins in js/appConfig.js, passing your custom editing interface to Editing, AttributeTable and FeatureForm.
    • +
  • Set up an editing backend.
    • +
  • If you are using the qwc-config-generator, the edit configuration will be automatically generated from the QGIS project. Otherwise, you need to write a custom editConfig in themesConfig.json as follows:
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EntryDescription
{
⁣  <LayerId>: {A WMS layer ID. Should be a theme WMS layer name, to ensure the WMS is correctly refreshed.
⁣    "layerName": "<LayerName>",The layer name to show in the selection combo box.
⁣    "editDataset": "<DatasetName>",The name of the edit dataset passed to the editing interface.
⁣    "geomType": "<GeomType>",The geometry type, either Point, LineString or Polygon.
⁣    "displayField": "<FieldId>",The ID of the field to use in the feature selection menu.
⁣    "permissions": {A list of different write permissions to specify rights and buttons.
⁣      "creatable": <boolean>,If true, Draw button will appear in Editing interface and Add button in Attribute Table.
⁣      "updatable": <boolean>,If true, Pick button will appear in Editing interface.
⁣      "deletable": <boolean>,If true, Delete button will appear in Editing interface and Attribute Table.
⁣    },
⁣    "fields": [{A list of field definitions, for each exposed attribute.
⁣      "id": "<FieldID>",The field ID.
⁣      "name": "<FieldName>",The field name, as displayed in the editing form.
⁣      "type": "<FieldType>",A field type. Either bool, list or a regular HTML input element type.
⁣      "constraints": {Constraints for the input field.
⁣        "values": [<Entries>],Only if type is list: an array of arbitrary strings.
⁣        ...For regular HTML input types, the ReactJS API name of any applicable HTML input constraint, i.e. maxLength or readOnly.
⁣      }
⁣    }],
⁣    "form": "<PathToUiFile>",Optional, a QtDesigner UI file.
⁣  }
}
+
    +
  • If you specify just fields, a simple form is autogenerated based on the field definitions.
    • +
  • Alternatively you can specify the URL to a Qt Designer UI form in form (use :/<path> to specify a path below the assets folder).
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/FeatureInfo/index.html b/topics/FeatureInfo/index.html new file mode 100644 index 00000000..4d1d286a --- /dev/null +++ b/topics/FeatureInfo/index.html @@ -0,0 +1,310 @@ + + + + + + + + Feature info - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Feature info
    • +
  • +
    • +
+
+
+
+
+ +

Feature info

+

The feature info behaviour in QWC2 is controlled by configuring identifyTool in config.json (or per-theme in themesConfig.json) to the desired plugin as well as whether a qwc-feature-info-service is used.

+

The feature info is by default triggered when clicking on a feature in the map. You can also configure the feature info as an explicit viewer tool by setting identifyTool: null and adding a menuItems or toolbarItems entry.

+

The following approaches are available for feature info:

+ +

WMS GetFeatureInfo

+

To query features over WMS GetFeatureInfo, set identifyTool: "Identify". By default, results are displayed in a table. To display the results in a custom HTML template, the qwc-feature-info-service can be used.

+

Note: Use of the qwc-feature-info-service is also recommended if the qwc-data-service is used for editing, to ensure attribute values containing paths to uploaded files are properly converted to clickable hyperlinks.

+

Set whether a layer is identifyable in QGIS &rarr; Project Properties &rarr; Data sources.

+

To highlight the geometry, make sure QGIS &rarr; Project Properties &rarr; QGIS Server &rarr; Add geometry to feature response is checked.

+

Suppressing attributes

+

You can suppress attributes globally by selecting "Do not expose via WMS" in QGIS → Layer properties → Fields.

+

Alternatively, you can selectively restrict attributes using the qwc-admin-gui and assigning Attribute resource permissions as desired.

+

You can also omit empty attributes by setting skipEmptyFeatureAttributes: true in the theme configuration entry in themesConfig.json.

+

If you use the qwc-feature-info-service, you can also omit empty attributes directly in the GetFeatureInfo by setting skip_empty_attributes: true in the featureInfo service configuration in tenantConfig.json.

+ +

In general, HTML markup in attribute values is preserved.

+

For displaying interactive hyperlinks, the following options are supported:

+
    +
  • URLs in attribute text values with no HTML markup are automatically converted to an interactive hyperlink.
    • +
  • Alternatively, you can enclose the URL in a HTML <a> tag in the attribute value. To open the linked page in an inline dialog within QWC2, you can set the anchor target to :iframedialog:<dialogname>:<optkey>=<optval>:<optkey>=<optval>:... where the supported options are:
    • +
  • w: Dialog width in pixels, default: 640.
    • +
  • h: Dialog height in pixels, default: 480.
    • +
  • title: Dialog window title, by default the translation string windows.<dialogname>.
    • +
  • print: Whether to add a print icon for printing the dialog contents, default: true.
    • +
  • dockable: Whether the dialog can be docked, default false.
    • +
  • docked: Whether the dialog is initially docked, default false. + Example:
    • +
+
<a href="https://example.com" target=":iframedialog:w=1024:h=768:title=Example">Link text</a>
+
+

For displaying images, the following options are supported:

+
    +
  • If replaceImageUrls: true is set in the Identify plugin configuration in config.json, attribute text values which contain exactly an URL to an image are converted to inline images. If you use the qwc-feature-info-service, you need to set transform_image_urls in the featureInfo service configuration in tenantConfig.json.
    • +
  • Alternatively, you can add a <img> tag directly in the attribute value.
    • +
+

This applies in particular to <a /> anchor and <img /> tags for displaying links an images in an attribute value.

+

Client side attribute transformations

+

This functionality is only available without the qwc-feature-info-service.

+

To compute derived attributes client-side, you can implement the customAttributeCalculator in qwc2-app/js/IdentifyExtensions.js (which is passed to the Identify plugin in appConfig.js).

+

To transform attributes client-side you can implement the attributeTransform in qwc2-app/js/IdentifyExtensions.js (which is passed to the Identify plugin in appConfig.js).

+

Custom export

+

By default, the identify dialog in QWC2 allows you to export the results to json (QWC2 feature storage format), geojson (standard GeoJSON without QWC2 specific fields), csv (single CSV with all layers) or csv+zip (ZIP with one CSV per layer). You can define additional export functions by extending customExporters in qwc2-app/js/IdentifyExtensions.js.

+

Custom HTML templates

+

You can specify a custom HTML template for displaying the feature rather than the default table view by using the qwc-feature-info-service and providing the template in the featureInfo service configuration in tenantConfig.json, either inline or as a path:

+
{
+  "name": "featureInfo",
+  "config": ...,
+  "resources": {
+    "wms_services": [
+      {
+        "name": "<service_name>",
+        "root_layer": {
+          "name": "<root_layer_name>",
+          "layers": [
+            {
+              "name": "<layer_name>",
+              "info_template": {
+                <See below>
+              }
+            }
+          ]
+        }
+      }
+    ]
+  }
+}
+
+

Example info_template with inline template:

+
"info_template": {
+  "type": "wms",
+  "template": "<div><h2>Demo Template</h2>Pos: {{ x }}, {{ y }}<br>Name: {{ feature.Name }}</div>"
+}
+
+

Example info_template with template path:

+
"info_template": {
+  "type": "wms",
+  "template_path": "/info_templates/template.html"
+}
+
+

Note: +- x and y are the info query coordinates. feature.<attr> renders the attr attribute value of the feature. +- The templates must be HTML fragments without html or body tags. +- The templates folder needs to be mounted into the qwc-feature-info-service container, i.e.:

+
  qwc-feature-info-service:
+    image: sourcepole/qwc-feature-info-service:vYYYY.MM.DD
+    volumes:
+      ...
+      - ./volumes/info-templates:/info_templates:ro
+
+

DB query feature info

+

When using the Identify plugin and the qwc-feature-info-service, you can query features directly from a database instead of over WMS GetFeatureInfo, by providing the featureInfo service configuration as described in HTML templates, but specifying a db_url and sql, for example

+
"info_template": {
+  "type": "sql",
+  "db_url": "postgresql:///?service=qwc_geodb",
+  "sql": "SELECT ogc_fid as _fid_, name, formal_en, pop_est, subregion, ST_AsText(wkb_geometry) as wkt_geom FROM qwc_geodb.ne_10m_admin_0_countries WHERE ST_Intersects(wkb_geometry, ST_GeomFromText(:geom, :srid)) LIMIT :feature_count;",
+  "template": "<div><h2>Demo Template</h2>Pos: {{ x }}, {{ y }}<br>Name: {{ feature.Name }}</div>"
+}
+
+

Note: x, y and geom are passed as parameters to the SQL query. If a GetFeatureInfo request is being processed with a filter_geom parameter, geom will correspond to that parameter. Otherwise geom will be POINT(x y).

+

Feature form

+

The FeatureForm plugin displays picked features in a feature form as configured in QGIS &rarr; Layer properties &rarr; Attributes form. It queries the features via qwc-data-service, and hence only works for layers with postgresql data source.

+

See Designing the edit forms for more information on designing edit forms.

+

To use it as default identify-tool, set identifyTool: "FeatureForm" in config.json.

+

A layer is only identifyable with the FeatureForm plugin if corresponding Data resources and permissions are configured for the layer data source in the qwc-admin-gui. If a write permission is configured, the feature will be editable.

+

Permissions

+

When using the Identify plugin and the qwc-feature-info-service, you can manage the permissions in the qwc-admin-gui as follows:

+
    +
  • To restrict the display of single layer attributes to specific roles, create a Layer and Attribute resource (latter as child of the created Layer resource) and create permissions assigning the desired roles to the Attribute resources.
    • +
  • Note: The name of the Attribute resource needs to be equal to the attribute alias name if one is defined in the QGIS project!
    • +
  • To restrict whether a layer is identifiable to specific roles, create a FeatureInfo service and FeatureInfo layer resource (latter as child of the created FeatureInfo service resource), and create permissions assigning the desired roles to the FeatureInfo layer resources.
    • +
+

When using the FeatureForm plugin and the qwc-data-service, the Data resource permissions are used, see Editing.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/Interfacing/index.html b/topics/Interfacing/index.html new file mode 100644 index 00000000..a6a6b042 --- /dev/null +++ b/topics/Interfacing/index.html @@ -0,0 +1,222 @@ + + + + + + + + Interfacing with applications - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Interfacing with applications
    • +
  • +
    • +
+
+
+
+
+ +

Interfacing with other applications

+

QWC2 offers a number of options to interface it with other applications.

+

URL parameters

+

The following parameters can appear in the URL of the QWC2 application:

+
    +
  • t: The active theme
    • +
  • l: The layers in the map, see below.
    • +
  • bl: The visible background layer
    • +
  • e: The visible extent
    • +
  • c: The center of the visible extent
    • +
  • s: The current scale
    • +
  • crs: The CRS of extent/center coordinates
    • +
  • hc: If c is specified and hc is true or 1, a marker is set at c when starting the application. Note: requires the StartupMarkerPlugin plugin to be active.
    • +
  • st: The search text
    • +
  • hp, hf, ht: Startup highlight parameters used in conjunction with the qwc-fulltext-search-service, see below.
    • +
+

The l parameter lists all layers in the map (redlining and background layers) as a comma separated list of entries of the form

+
<layername>[<transparency>]!
+
+

where +- layername is the WMS name of a theme layer or group, or an external layer resource string in the format

+
<wms|wfs>:<service_url>#<layername>
+
+

for external layers, i.e. wms:https://wms.geo.admin.ch/?#ch.are.bauzonen. +- <transparency> denotes the layer transparency, betwen 0 and 100. If the [<transparency>] portion is omitted, the layer is fully opaque. +- ! denotes that the layer is invisible. If omitted, the layer is visible.

+

Note: If group name is specified instead of the layer name, QWC2 will automatically resolve this to all layer names contained in that group, and will apply transparency and visibility settings as specified for the group.

+

The urlPositionFormat parameter in config.json determines whether the extent or the center and scale appears in the URL.

+

The urlPositionCrs parameter in config.json determines the projection to use for the extent resp. center coordinates in the URL. By default the map projection of the current theme is used. If urlPositionCrs is equal to the map projection, the crs parameter is omitted in the URL.

+

Highlight feature on startup

+

If a search text passed via st results in a unique result, the viewer automatically zooms to this result on startup. If the search result does not provide a bounding box, the minScale defined in the searchOptions of the TopBar configuration in config.json is used.

+

When using the qwc-fulltext-search-service, you can hightlight a feature on startup as follows: +- Either specify hp=<search product>&hf=<search filter> +- Or specify ht=<search text>&hp=<search product>

+

See Fulltext search for more details.

+

Launching external websites

+

QWC2 menu entries can be configured to launch external websites as described in opening external websites.

+

Javascript API

+

The API plugin exposes many application actions via the window.qwc2 object and makes them accessible for external applications. See API plugin reference for more details.

+

See api_examples.js for some concrete examples.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/LegendGraphics/index.html b/topics/LegendGraphics/index.html new file mode 100644 index 00000000..df61c7e6 --- /dev/null +++ b/topics/LegendGraphics/index.html @@ -0,0 +1,228 @@ + + + + + + + + Legend graphics - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Legend graphics
    • +
  • +
    • +
+
+
+
+
+ +

Legend graphics

+

By default, QWC2 will obtain the legend graphics of a layer from QGIS Server.

+

Customizing the GetLegendGraphics request

+

You can customize the GetLegendGraphics request by specifying additional query parameters in via extraLegendParameters in the theme configuration block. The list of supported query parameters is documented in the QGIS Server documentation.

+

Providing custom legend images

+

You can provide custom legend images by enabling the qwc-legend-service.

+

Configure legend_images_path in the legend service configuration in tenantConfig.json:

+
{
+  "name": "legend",
+  "config": {
+    "default_qgis_server_url": "http://qwc-qgis-server/ows/",
+    "legend_images_path": "/legends/"
+  }
+}
+
+

Note: The legend folder needs to be mounted into the qwc-legend-service container, i.e.:

+
  qwc-legend-service:
+    image: sourcepole/qwc-feature-info-service:vYYYY.MM.DD
+    volumes:
+      ...
+      - ./volumes/legends:/legends
+
+

Then, legend images will be searched for in this order (the first one found is used):

+
    +
  • A <legend_images_path>/<service_name>/<layername><suffix>.png file, where
    • +
  • service_name is the name of the WMS service
    • +
  • layername is the WMS layer name
    • +
  • suffix: empty, or one of _thumbnail, _tooltip. The suffix is passed by QWC2 to the legend service depending on the requested image type.
    • +
  • A <legend_images_path>/default<suffix>.png file for a default legend image.
    • +
  • A <legend_images_path>/<legend_image> file with legend_image as specified for the desired layer in the legend service configuration, for example:
    • +
+
{
+  "name": "legend",
+  "config": ...,
+  "resources": {
+    "wms_services": [
+      {
+        "name": "<service name>",
+        "root_layer": {
+          "name": "<root_layer_name>",
+          "layers": [
+            {
+              "name": "<layer_name>",
+              "legend_image": "edit_points.png"
+            }
+          ]
+        }
+      }
+    ]
+  }
+}
+
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/Mapinfo/index.html b/topics/Mapinfo/index.html new file mode 100644 index 00000000..efee64f0 --- /dev/null +++ b/topics/Mapinfo/index.html @@ -0,0 +1,210 @@ + + + + + + + + Map info - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Map info
    • +
  • +
    • +
+
+
+
+
+ +

Map info

+

The map-info popup is displayed when right-clicking any position on the map.

+

By default, it displayes the picked coordinates.

+

If the qwc-elevation-service is enabled, it also returns the height at the picked position.

+

If the qwc-mapinfo-service is enabled, queries can be configured in the service configuration in tenantConfig.json to return additional information. Example:

+
{
+  "name": "mapinfo",
+  "config": {
+    "queries": [
+      {
+        "db_url": "postgresql:///?service=qwc_geodb",
+        "info_table": "qwc_geodb.ne_10m_admin_0_countries",
+        "info_geom_col": "wkb_geometry",
+        "info_display_col": "name",
+        "info_where": "type = 'Sovereign country'",
+        "info_title": "Country"
+      },
+      {
+        "db_url": "postgresql:///?service=qwc_geodb",
+        "info_sql": "SELECT type FROM qwc_geodb.ne_10m_admin_0_countries WHERE ST_contains(wkb_geometry, ST_SetSRID(ST_Point(:x, :y), :srid)) LIMIT 1",
+        "info_title": "Type"
+      }
+    ]
+  }
+}
+
+
    +
  • If info_table, info_geom_col, info_display_col and optionally info_where are provided, the result obtained from
    • +
+
    SELECT {info_display_col}
+    FROM {info_table}
+    WHERE ST_contains({info_table}.{info_geom_col}, ST_SetSRID(ST_Point(:x, :y), :srid)) AND {info_where}
+    LIMIT 1;
+
+

will be returned and displayed in the map-info popup as with title as specified in info_title.

+
    +
  • If info_sql is provided, the result obtained from the specified query will be returned. Use the :x, :y and :srid placeholders.
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/MultiTenancy/index.html b/topics/MultiTenancy/index.html new file mode 100644 index 00000000..da299c4e --- /dev/null +++ b/topics/MultiTenancy/index.html @@ -0,0 +1,385 @@ + + + + + + + + Multi-tenancy - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Multi-tenancy
    • +
  • +
    • +
+
+
+
+
+ +

Multi-Tenancy

+

Multi-tenancy allows serving multiple viewer configurations from a single installation. Specifically, it allows separate theme, viewer (plugins, appearance, etc.) and user/permissions configurations for each tenant.

+

By default, qwc-docker includes a single default tenant, with the respective configuration file located at qwc-docker/volumes/config-in/default/tenantConfig.json.

+

To configure additional tenants, the main steps are as follows:

+
    +
  • Define how the tenant name is extracted from the requests.
    • +
  • Write a tenantConfig.json, specifying the location of the configuration database, the viewer configuration and viewer assets.
    • +
+

Extracting the tenant name from the requests

+

Multi-tenancy works by extracting a tenant name from the request URL and passing it to the respective QWC services. A typical setup is to run the application at the base address

+
https://<hostname>/<tenant>/
+
+

The simplest approach is to extract the tenant name in a rewrite rule and set a corresponding header which will be read by the QWC services. This can be accomplished as follows:

+
    +
  1. Define the name of the tenant header in qwc-docker/docker-compose.yml by setting the TENANT_HEADER environment variable in the qwc-service-variables block, i.e.:
    2. +
+
x-qwc-service-variables: &qwc-service-variables
+  [...]
+  TENANT_HEADER: Tenant
+
+
    +
  1. Add rewrite rules to the api-gateway configuration file qwc-docker/api-gateway/nginx.conf, extracting the tenant name and setting the tenant header. For example
    2. +
+
server {
+    listen       80;
+    server_name  localhost;
+
+    proxy_redirect off;
+    server_tokens off;
+
+    location ~ ^/(?<t>tenant1|tenant2) {
+        # Extract tenant
+        proxy_set_header Tenant $t;
+        # Set headers for original request host
+        proxy_set_header   Host              $http_host;
+        proxy_set_header   X-Real-IP         $remote_addr;
+        proxy_set_header   X-Forwarded-For   $proxy_add_x_forwarded_for;
+        proxy_set_header   X-Forwarded-Proto $scheme;
+
+        location ~ ^/[^/]+/auth {
+            rewrite ^/[^/]+(.+) $1 break;
+            proxy_pass http://qwc-auth-service:9090;
+        }
+
+        location ~ ^/[^/]+/ows {
+            rewrite ^/[^/]+(.+) $1 break;
+            proxy_pass http://qwc-ogc-service:9090;
+        }
+
+        location ~ ^/[^/]+/api/v1/featureinfo {
+            rewrite ^/[^/]+(.+) $1 break;
+            proxy_pass http://qwc-feature-info-service:9090;
+        }
+
+        # etc...
+
+        location ~ ^/[^/]+/qwc_admin {
+            rewrite ^/[^/]+(.+) $1 break;
+            proxy_pass http://qwc-admin-gui:9090;
+        }
+
+        # Place these last to give precedence to the other rules:
+
+        # Redirect request without trailing slash
+        location ~ ^(/[^/]+)$ {
+            return 301 $scheme://$http_host$1/;
+        }
+        location ~ ^/[^/]+/ {
+            rewrite ^/[^/]+(.+) $1 break;
+            proxy_pass http://qwc-map-viewer:9090;
+        }
+    }
+}
+
+

Writing the tenantConfig.json

+

The tenant configuration file tenantConfig.json is located at qwc-docker/volumes/config-in/<tenant>/tenantConfig.json with <tenant> the name of the tenant. There are a number of configuration options which specifically affect the type of multi-tenancy setup, which is very flexible. Possible choices are:

+
    +
  • Shared vs. separate configuration database / admin backend
    • +
  • Shared vs. separate viewer build
    • +
  • Shared vs. separate qgs-resources tree
    • +
  • etc...
    • +
+

In general, you need to ensure that

+
    +
  • All the service URLs point to locations which are handled by the api-gateway configuration.
    • +
  • All the paths refers to locations which are mounted in qwc-docker/docker-compose.yml.
    • +
  • All database connection service names refer to connections which are defined qwc-docker/pg_service.conf.
    • +
+

A minimal configuration for tenant tenant_name may look as follows:

+
{
+  "$schema": "https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json",
+  "service": "config-generator",
+  "config": {
+    "tenant": "tenant_name",
+    "default_qgis_server_url": "http://qwc-qgis-server/ows/",
+    "config_db_url": "postgresql:///?service=qwc_configdb",
+    "qgis_projects_base_dir": "/data/tenant_name",
+    "qgis_projects_scan_base_dir": "/data/tenant_name/scan",
+    "qwc2_base_dir": "/qwc2",
+    "ows_prefix": "/tenant_name/ows",
+    ...
+  },
+  "themesConfig": "./themesConfig.json",
+  "services": [
+    {
+      "name": "adminGui",
+      "config": {
+        "db_url": "postgresql:///?service=qwc_configdb",
+        "qgs_resources_path": "/qgs-resources/tenant_name/",
+        "ows_prefix": "/tenant_name/ows",
+        ...
+      }
+    },
+    {
+      "name": "dbAuth",
+      "config": {
+        "db_url": "postgresql:///?service=qwc_configdb",
+        "config_generator_service_url": "http://qwc-config-service:9090"
+      }
+    },
+    {
+      "name": "mapViewer",
+      "generator_config": {
+        "qwc2_config": {
+          "qwc2_config_file": "/srv/qwc_service/config-in/tenant_name/config.json",
+          "qwc2_index_file": "/srv/qwc_service/config-in/tenant_name/index.html"
+        }
+      },
+      "config": {
+        "qwc2_path": "/qwc2/",
+        "auth_service_url": "/tenant_name/auth/",
+        "ogc_service_url": "/tenant_name/ows/",
+        "info_service_url": "/tenant_name/api/v1/featureinfo/",
+        ...
+      }
+    }
+  ]
+}
+
+

Notes:

+
    +
  • The database URL (postgresql:///?service=qwc_configdb) will determine whether a shared or sperate configuration database is used for each tenant.
    • +
  • The qwc2_config_file, qwc2_index_file, qwc2_base_dir and qwc2_path paths will determine whether the viewer build/configuration is shared or separate for each tenant.
    • +
  • To use a separate assets folder for each tenant, you can set an appropriate assetsPath in the qwc2_config_file of each tenant.
    • +
  • The various service URLs in the mapViewer configuration and in other service configurations need to match what is expected in the api-gateway configuration.
    • +
+

tenantConfig template

+

In particular when managing a large number of tenants, it can be tedious and error-prone to manage separate tenantConfig.json files for each tenant which might be nearly identical aside from the tenant name. To alleviate this, you can create a tenantConfig template, using the $tenant$ placeholder where appropriate, and point to this file in the respective tenantConfig.json files. The contents of the template will then be merged with the contents of tenantConfig.json, and occurence of $tenant$ in the template will be replaced with the current tenant name.

+

For example, a minimal tenantConfig.json in qwc-docker/volumes/config-in/tenant_name/ could look as follows:

+
{
+  "template": "../tenantConfig.template.json",
+  "config": {
+    "tenant": "tenant_name"
+  },
+  "themesConfig": "./themesConfig.json"
+}
+
+

And the tenantConfig.template.json in qwc-docker/volumes/config-in/ as follows:

+
{
+  "$schema": "https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json",
+  "service": "config-generator",
+  "config": {
+    "default_qgis_server_url": "http://qwc-qgis-server/ows/",
+    "config_db_url": "postgresql:///?service=qwc_configdb",
+    "qgis_projects_base_dir": "/data",
+    "qgis_projects_scan_base_dir": "/data/$tenant$/scan",
+    "qwc2_base_dir": "/qwc2",
+    "ows_prefix": "/ows",
+    ...
+  },
+  "themesConfig": "./themesConfig.json",
+  "services": [
+    {
+      "name": "adminGui",
+      "config": {
+        "db_url": "postgresql:///?service=qwc_configdb",
+        "qgs_resources_path": "/qgs-resources/",
+        "ows_prefix": "/ows",
+        ...
+      }
+    },
+    {
+      "name": "dbAuth",
+      "config": {
+        "db_url": "postgresql:///?service=qwc_configdb",
+        "config_generator_service_url": "http://qwc-config-service:9090"
+      }
+    },
+    {
+      "name": "mapViewer",
+      "generator_config": {
+        "qwc2_config": {
+          "qwc2_config_file": "/srv/qwc_service/config-in/$tenant$/config.json",
+          "qwc2_index_file": "/srv/qwc_service/config-in/$tenant$/index.html"
+        }
+      },
+      "config": {
+        "qwc2_path": "/qwc2/",
+        "auth_service_url": "/$tenant$/auth/",
+        "ogc_service_url": "/$tenant$/ows/",
+        "info_service_url": "/$tenant$/api/v1/featureinfo/",
+        ...
+      }
+    }
+  ]
+}
+
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/Printing/index.html b/topics/Printing/index.html new file mode 100644 index 00000000..7bad4139 --- /dev/null +++ b/topics/Printing/index.html @@ -0,0 +1,244 @@ + + + + + + + + Printing - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Printing
    • +
  • +
    • +
+
+
+
+
+ +

Printing

+

QWC2 supports printing to PDF via the QGIS Server GetPrint request.

+

The basic steps are:

+
    +
  • Ensure the Print plugin is enabled in the QWC2 viewer.
    • +
  • Create print layouts in the QGIS project as desired. The layouts must contain one Map element.
    • +
  • Generate the themes configuration.
    • +
+

The available print layouts will then appear in the QWC2 print plugin.

+

You can limit the available print scales by setting printScales (or defaultPrintScales) in the theme configuration to a list of scale denominators. If the list is empty, the print scale can be freely chosen.

+

Similarly, you can limit the available print resolutions by setting printResolutions (or defaultPrintResolutions) in the theme configuration to a list of resolutions. If the list is empty, the print resolution can be freely chosen.

+

External WMS layers are automatically printed if the Print plugin config option printExternalLayers is true (default). Note that printing external WMTS layers is currently not supported by the QGIS Server.

+

You can enable the option to generate a GeoPDF by setting the the Print plugin config option allowGeoPdfExport to true. Note: This is only supported on QGIS Server 3.32 and newer.

+

Some additional tasks include:

+ +

Configuring print background layers

+

Background layers are handled purely client-side in QWC2. There are two options for printing the background layer:

+

The first option is to mark a QGIS project layer as print layer by adding a printLayer to the background layer entry when writing the themes configuration, i.e.:

+
{
+  ...
+  "backgroundLayers": [
+      {"name": "<background layer name>", "printLayer": "<qgis layer name>"}
+  ]
+}
+
+

A QGIS layer marked as printLayer will be filtered out from the QWC2 layer tree. This approach allows i.e. using a WMTS background layer in the web client for higher performance, and using a WMS background layer when printing for higher quality/resolution.

+

The second option is to use WMS background layers, which are automatically printed a external layers.

+

User labels

+

User labels appear as free-text input fields in the QWC2 print dialog. To configure user labels, it is sufficient to add item ids to layout label items in the print layout. The specified id will appear as input field label in the QWC2 print dialog.

+

Note: Label ids beginning with __ (two underscore characters) are ignored as user labels by QWC2.

+

You can can customize the input field (max length, number of rows) by setting the printLabelConfig in the theme configuration.

+

Also, in the theme configuration, you can also set:

+
    +
  • printLabelForSearchResult: The id of the label to which to write the current search result label, if any.
    • +
  • printLabelForAttribution: The id of the label to which to write the current map attribution text, if any.
    • +
+

If you set the Print plugin config option hideAutopopulatedFields to true, these labels will not be shown in the print dialog, otherwise they will be displayed as read-only fields.

+ +

In alternative to configuring a grid directly in the print layout, one can also define a printGrid configuration in the theme configuration. For example

+
"printGrid": {
+  "s": 1000, "x": 500, "y": 500,
+  "s": 2000, "y": 1000, "y": 1000,
+  "s": 10000, "y": 5000, "y": 5000,
+}
+
+

will print a 500x500 (map units) grid for scales up to 1:1000, a 1000x1000 grid for scales up to 1:2000, etc.

+

Layouts with legend

+

The QWC2 print dialog will expose a toggle switch to enable the legend in the print output for layout <layout_name> if the QGIS project contains a second layout named <layout_name>_legend. The layout with the _legend suffix is expected to contain a legend item.

+

Atlas printing

+

To enable atlas printing in QWC2, configure the QGIS project as follows:

+
    +
  • Check the Generate an atlas checkbox in the desired layout in QGIS layout designer &rarr; Atlas &rarr; Atlas settings, selecting the coverage layer as desired.
    • +
  • In the layout map item properties, check Controlled by Atlas.
    • +
  • In the Project properties &rarr; QGIS Server, set Maximum features for Atlas print requests to the desired value.
    • +
+

QWC2 will then display a feature picked in the print dialog which will allow picking the desired atlas features, and QGIS Server will generate a multi-page PDF accordingly.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/Search/index.html b/topics/Search/index.html new file mode 100644 index 00000000..07b9e2e4 --- /dev/null +++ b/topics/Search/index.html @@ -0,0 +1,293 @@ + + + + + + + + Search - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ +

Search

+

QWC2 can be configured to use arbitrary custom search providers. In addition, the qwc-fulltext-search-service provided by the qwc-services ecosystem can be used.

+

Adding search providers

+

Search providers can be defined as follows:

+
    +
  • Built-in, defined in js/SearchProviders.js. This file is structured as follows:
    • +
+
export const SearchProviders = {
+    <providerkey1>: <ProviderDefinition1>,
+    <providerkey2>: <ProviderDefinition2>,
+    ...
+};
+
+

Built-in search providers are compiled into the application bundle and avoid the need for an extra resource to be loaded on application startup. The downside is that you need to rebuild QWC2 to add/modify search providers.

+
    +
  • As resource, defined in static/assets/searchProviders.js. This file is structured as follows:
    • +
+
window.QWC2SearchProviders = {
+    <providerkey1>: <ProviderDefinition1>,
+    <providerkey2>: <ProviderDefinition2>,
+    ...
+};
+
+

This script file needs to be loaded explicitly by index.html via

+
<script type="text/javascript" src="assets/searchProviders.js" ></script>
+
+

The format of ProviderDefinition is

+
{
+  label: "<human readable provider name>", // OR
+  labelmsgid: "<translation message ID for human readable provider name>",
+  onSearch: function(searchText, searchParams, callback, axios) => {
+    const results = []; // See below
+    /* Populate results... */
+    callback({results: results});
+  },
+  getResultGeometry: function(resultItem, callback, axios) => {
+    /* Retreive geometry... */
+    // resultItem is a search result entry as returned by onSearch, which provides the context for retreiving the geometry
+    const geometry = "<wktString>";
+    const crs = "EPSG:XXXX";
+    const hidemarker = <boolean>; // Whether to suppress displaying a search marker on top of the search geometry
+    callback({geometry: wktString, crs: crs, hidemarker: hidemarker});
+  }
+}
+
+

Notes:

+
    +
  • The format of searchParams is
    • +
+
{
+  displaycrs: "EPSG:XXXX", // Currently selected mouse coordinate display CRS
+  mapcrs: "EPSG:XXXX", // The current map CRS
+  lang: "<code>", // The current application language, i.e. en-US or en
+  cfgParams: <params> // Additional parameters passed in the theme search provider configuration, see below
+}
+
+
    +
  • +

    axios is passed for convenience so that providers can use the compiled-in axios library for network requests.

    +
    • +
  • +

    The format of the results list returned by onSearch is as follows:

    +
    • +
+
results = [
+  {
+    id: "<categoryid>",                   // Unique category ID
+    title: "<display_title>",             // Text to display as group title in the search results
+    priority: priority_nr,                // Optional: search result group priority. Groups with higher priority are displayed first in the list.
+    items: [
+      {                                   // Location search result:
+        type: SearchResultType.PLACE,     // Specifies that this is a location search result
+        id: "<itemId">,                   // Unique item ID
+        text: "<display text>",           // Text to display as search result
+        label: "<map marker text>",       // Optional, text to show next to the position marker on the map instead of `text`
+        x: x,                             // X coordinate of result
+        y: y,                             // Y coordinate of result
+        crs: crs,                         // CRS of result coordinates and bbox
+        bbox: [xmin, ymin, xmax, ymax]    // Bounding box of result (if non-empty, map will zoom to this extent when selecting result)
+      },
+      {                                    // Theme layer search result (advanced):
+        type: SearchResultType.THEMELAYER, // Specifies that this is a theme layer search result
+        id: "<itemId">,                    // Unique item ID
+        text: "<display text>",            // Text to display as search result
+        layer: {<Layer definition>}        // Layer definition, in the same format as a "sublayers" entry in themes.json.
+      }
+    ]
+  },
+  {
+    ...
+  }
+]
+
+

Consult js/SearchProviders.js and static/assets/searchProviders.js for full examples.

+

Configuring theme search providers

+

For each theme item in themesConfig.json, you can define a list of search providers to enable for the theme as follows:

+
...
+searchProviders: [
+  "<providerkey1>",             // Simple form
+  {                             // Provider with custom params
+    key: "<providerkey2>",
+    params: {
+      ...                       // Arbitrary params passed to the provider `onSearch` function as `searchParams.cfgParams`
+    }
+  },
+  {                             // Fulltext search configuration using qwc-fulltext-search-service
+    "provider":"solr",          // Identifier for solr search provider
+    "default":[<default terms>] // Default search terms, concatenated with additional search terms from visible theme layers
+  }
+],
+...
+
+

Note: The qwc2-demo-app (also used by the qwc-map-viewer-demo docker image) includes two providers by default: coordinates and nominatim (OpenStreetMap location search).

+

Configuring the fulltext search service

+

For more information on the full-text search provider, see qwc-fulltext-search-service.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/Snapping/index.html b/topics/Snapping/index.html new file mode 100644 index 00000000..a8b5d0a9 --- /dev/null +++ b/topics/Snapping/index.html @@ -0,0 +1,211 @@ + + + + + + + + Snapping - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Snapping
    • +
  • +
    • +
+
+
+
+
+ +

Snapping

+

QWC2 ships a plugin for snapping support while drawing (redlining / measuring / editing). To enable it, make sure the SnappingSupport plugin is enabled in appConfig.js (see the sample sample js/appConfig.js). Then, for each theme for which you want snapping to be available, you can add a snapping block to your theme item in themesConfig.json as follows:

+
...
+"snapping": {
+  "snaplayers": [
+    {
+      "name": "<layername>",
+      "min": <min_scale>,
+      "max": <max_scale>
+    }
+  ],
+  "featureCount": <feature_count>
+}
+...
+
+

where:

+
    +
  • layername is the name of the theme sublayer from which to retreive the snapping geometries
    • +
  • min is the minimum scale denominator (inclusive) from which this layer should be used for snapping
    • +
  • max is the maximum scale denominator (exclusive) up to which this layer should be used for snapping
    • +
  • feature_count is the maximum number of snapping geometries to retreive for the current map extent (default: 500).
    • +
+

Note: Snapping works by querying the geometries of all snapping layers inside the scale range via WMS GetFeatureInfo and refreshing the geometries every time the map extent changes. Therefore, it is recommended to ensure the geometry complexity of the snap layers is appropriate for the specified scale ranges to avoid overloading the server with the GetFeatureInfo requests. Also, the QGIS project will need to be configured so that snap layers are queryable and that feature info responses contain geometries.

+

For the Redlining, Measure and Editing plugins, the availability of snapping can be independently configured:

+
{
+  "name":"<Redlining|Measure|Editing>",
+  "cfg": {
+    "snapping": <true|false>,
+    "snappingActive": <true|false>,
+    ...
+  }
+}
+
+

where:

+
    +
  • snapping determines whether snapping is available for the specified plugin
    • +
  • snappingActive determines whether snapping is active by default for the specified plugin
    • +
+

When snapping is available, a small toolbar appears on the bottom border of the map with the possibility to toggle snapping.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/topics/TimeManager/index.html b/topics/TimeManager/index.html new file mode 100644 index 00000000..fa83466e --- /dev/null +++ b/topics/TimeManager/index.html @@ -0,0 +1,178 @@ + + + + + + + + Temporal layers - QWC2 - latest + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • QWC2 »
    • +
  • Selected topics »
    • +
  • Temporal layers
    • +
  • +
    • +
+
+
+
+
+ +

Temporal layers (Time Manager)

+

QWC2 supports WMS layers with time dimension (WMS-T) through the TimeManager plugin.

+

Time Manager

+

To view and manage temporal layers in QWC2, add a new time dimension, selecting appropriate temporal fields as start- and end-attributes in the QGIS Layer Properties → QGIS Server → Dimensions.

+

For the time markers functionality in the Time Manager plugin to work correctly, you also need to enable the qwc-feature-info-service.

+

Note: The QGIS Layer Properties → Temporal settings are ignored by QGIS Server and hence have no effect in QWC2.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + +