Konfigurationsreferenz

Dieser Abschnitt beschreibt formal die GBD WebSuite Konfiguration, bei der es sich um eine geschachtelte Key-Value-Struktur handelt. Die keys sind immer Zeichenketten, die values sollten zu einem der unten aufgeführten Typen gehören.

Die Top-Level-Konfiguration ist vom Typ ApplicationConfig.

Basis Typen

Grundlegende Datentypen, wie sie in der Sprache Python verwendet werden.

str String, muss in der UTF-8 Kodierung sein
bool Boolean true or false
int Integer Nummer
float Gleitkommerzahl
dict Generisches Schlüssel-Wert-Objekt
[T…] Liste (Array) von Elementen vom Typ T

Spezial Typen

Die Werte dieser Typen sind Zeichenketten und Zahlen, die mit einer speziellen Semantik versehen sind.

gws.common.application.Config

Hauptkonfiguration der GBD WebSuite

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
api gws.common.api.Config system-wide server actions nein  
auth gws.common.auth.types.Config Autorisierungsmethoden und -optionen nein  
client gws.common.client.Config GBD WebSuite Client Konfiguration nein  
db gws.common.application.DbConfig Datenbankkonfiguration nein  
fonts gws.common.application.FontConfig fonts configuration nein  
helpers [gws.types.ext.helper.Config…]   nein  
locales [str…] default locales for all projects nein  
projectDirs [gws.types.DirPath…] Verzeichnisse mit zusaetzlichen Projekten nein  
projectPaths [gws.types.FilePath…] zusaetzliche Projektpfade nein  
projects [gws.common.project.Config…] Projektkonfigurationen nein  
seeding gws.common.application.SeedingConfig Konfiguration für Seeding-Jobs nein  
server gws.server.types.Config Server Engine-Optionen nein  
timeZone str Zeitzone für diesen Server nein “UTC”
uid str Eindeutige Layer-ID nein  
web gws.common.application.WebConfig Webserver-Konfiguration nein  

gws.common.api.Config

Server actions

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
actions [gws.types.ext.action.Config…] available actions nein  
uid str Eindeutige Layer-ID nein  

gws.common.application.DbConfig

Datenbankkonfiguration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
providers [gws.types.ext.db.provider.Config…]   ja  
uid str Eindeutige Layer-ID nein  

gws.common.application.FontConfig

Fonts configuration.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dir gws.types.DirPath directory with custom fonts ja  
uid str Eindeutige Layer-ID nein  

gws.common.application.SSLConfig

SSL configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
crt gws.types.FilePath crt file location ja  
key gws.types.FilePath key file location ja  
uid str Eindeutige Layer-ID nein  

gws.common.application.SeedingConfig

Seeding-Optionen

Eigenschaften:

Name Typ   Erforderlich Defaultwert
concurrency int Anzahl gleichzeitiger Seeding-Jobs nein 1
maxTime gws.types.Duration max. Zeit für einen Seeding Job nein 600
uid str Eindeutige Layer-ID nein  

gws.common.application.WebConfig

Web server configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
sites [gws.web.site.Config…] configured sites nein  
ssl gws.common.application.SSLConfig ssl configuration nein  
uid str Eindeutige Layer-ID nein  

gws.common.auth.types.Config

Authentication and authorization options

Eigenschaften:

Name Typ   Erforderlich Defaultwert
cookie gws.common.auth.types.CookieConfig session cookie parameters nein  
httpEnabled bool http authorization enabled nein true
httpsOnly bool http authorization via ssl only nein false
providers [gws.types.ext.auth.provider.Config…] authorization providers ja  
session gws.common.auth.types.SessionConfig session configuration nein  
uid str Eindeutige Layer-ID nein  

gws.common.auth.types.CookieConfig

Session cookie parameters

Eigenschaften:

Name Typ   Erforderlich Defaultwert
name str name for the cookie nein “auth”
path str cookie path nein “/”
uid str Eindeutige Layer-ID nein  

gws.common.auth.types.SessionConfig

Session configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
heartBeat bool refresh sessions automatically nein false
lifeTime gws.types.Duration session life time nein 1200
storage str session storage engine nein “sqlite”
uid str Eindeutige Layer-ID nein  

gws.common.client.Config

Element der Client-Benutzeroberflaeche

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
addElements [gws.common.client.ElementConfig…] add elements to the parent element list nein  
elements [gws.common.client.ElementConfig…] Kindelemente dieses Elements nein  
options dict Optionen für dieses Element nein  
removeElements [gws.common.client.ElementConfig…] remove elements from the parent element list nein  
uid str Eindeutige Layer-ID nein  

gws.common.client.ElementConfig

GWS client UI element configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
after str insert after this tag nein  
before str insert before this tag nein  
tag str element tag ja  
uid str Eindeutige Layer-ID nein  

gws.common.db.SqlTableConfig

SQL database table

Eigenschaften:

Name Typ   Erforderlich Defaultwert
geometryColumn str geometry column name nein  
keyColumn str primary key column name nein  
name str table name ja  
searchColumn str column to be searched for nein  
uid str Eindeutige Layer-ID nein  

gws.common.layer.types.CacheConfig

Cache configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool cache is enabled nein false
maxAge gws.types.Duration cache max. age nein “7d”
maxLevel int max. zoom level to cache nein 1
uid str Eindeutige Layer-ID nein  

gws.common.layer.types.ClientOptions

Client options for a layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
exclusive bool only one of this layer’s children is visible at a time nein false
expanded bool the layer is expanded in the list view nein false
listed bool the layer is displayed in this list view nein true
selected bool the layer is intially selected nein false
unfolded bool the layer is not listed, but its children are nein false
visible bool the layer is intially visible nein true

gws.common.layer.types.EditConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
uid str Eindeutige Layer-ID nein  

gws.common.layer.types.FlattenConfig

Flatten the layer hierarchy.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
level int flatten level ja  
uid str Eindeutige Layer-ID nein  
useGroups bool use group names (true) or image layer names (false) nein false

gws.common.layer.types.GridConfig

Grid configuration for caches and tiled data

Eigenschaften:

Name Typ   Erforderlich Defaultwert
metaBuffer int pixel buffer nein 0
metaSize int number of meta-tiles to fetch nein 0
origin str position of the first tile (nw or sw) nein “nw”
tileSize int tile size nein 256
uid str Eindeutige Layer-ID nein  

gws.common.layer.types.LegendConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool   nein true
uid str Eindeutige Layer-ID nein  
url gws.types.Url   nein  

gws.common.layer.types.OwsConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
name str layer name for ows services nein  
servicesDisabled [str…] services disabled for this layer nein  
servicesEnabled [str…] services enabled for this layer nein  
uid str Eindeutige Layer-ID nein  

gws.common.map.Config

Kartenkonfiguration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
center gws.types.Point Kartenmitte nein  
coordinatePrecision int precision for coordinates nein  
crs gws.types.Crs KBS fuer diese Karte nein “EPSG:3857”
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
layers [gws.types.ext.layer.Config…] Sammlung von Layern fuer diese Karte ja  
skipInvalidLayers bool remove invalid layers from the map nein false
title str Kartentitel nein  
uid str Eindeutige ID nein  
zoom gws.gis.zoom.Config Kartenmassstaebe und Aufloesungen nein  

gws.common.metadata.Config

Object metadata configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
abstract str object abstract description nein  
accessConstraints str   nein  
attribution str attribution (copyright) string nein  
contact gws.common.metadata.ContactConfig contact information nein  
fees str   nein  
image gws.types.Url image (logo) url nein  
images dict further images nein  
inspire dict INSPIRE properties nein  
iso dict ISO-19115 properties nein  
keywords [str…] keywords nein []
language str object language nein  
links [gws.common.metadata.LinkConfig…] additional links nein []
modDate gws.types.Date modification date nein  
name str object internal name nein  
pubDate gws.types.Date publication date nein  
serviceUrl gws.types.Url service url nein  
title str object title nein  
uid str Eindeutige Layer-ID nein  
url gws.types.Url metadata url nein  

gws.common.metadata.ContactConfig

Contact metadata configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
address str   nein  
area str   nein  
city str   nein  
country str   nein  
email str   nein  
fax str   nein  
organization str   nein  
person str   nein  
phone str   nein  
position str   nein  
uid str Eindeutige Layer-ID nein  
url gws.types.Url   nein  
zip str   nein  

gws.common.metadata.LinkConfig

Object link configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
function str ISO-19115 function, see https://geo-ide.noaa.gov/wiki/index.php?title=ISO_19115_and_19115-2_CodeList_Dictionaries#CI_OnLineFunctionCode nein  
scheme str link scheme nein  
uid str Eindeutige Layer-ID nein  
url gws.types.Url link url ja  

gws.common.model.Config

Data model.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
crs gws.types.Crs   nein  
geometryType gws.types.GeometryType   nein  
rules [gws.common.model.ModelRule…]   ja  
uid str Eindeutige Layer-ID nein  

gws.common.model.ModelRule

Attribute conversion rule

Eigenschaften:

Name Typ   Erforderlich Defaultwert
editable bool attribute is editable nein true
expression str attribute conversion expression nein  
format gws.types.FormatStr attribute formatter nein  
name str target attribute name nein  
source str source attribute nein  
title str target attribute title nein  
type gws.types.AttributeType target attribute type nein “str”
value str constant value nein  

gws.common.ows.service.UseInspireConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
data bool enable INSPIRE data models for this service nein false
meta bool enable INSPIRE metadata for this service nein false
uid str Eindeutige Layer-ID nein  

gws.common.printer.Config

Eigenschaften:

Name Typ   Erforderlich Defaultwert
templates [gws.types.ext.template.Config…]   ja  
uid str Eindeutige Layer-ID nein  

gws.common.project.Config

Projektkonfiguration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
api gws.common.api.Config project-specific actions nein  
assets gws.web.site.DocumentRootConfig projektspezifische Anlagemoeglichkeiten nein  
client gws.common.client.Config Projektspezifische GBD WebSuite Client Konfiguration nein  
description gws.types.ext.template.Config Vorlage fuer die Projektbeschreibung nein  
locales [str…] project locales nein  
map gws.common.map.Config Kartenkonfiguration nein  
meta gws.common.metadata.Config project metadata nein  
multi gws.types.Regex true, wenn dies eine Multiprojektvorlage ist nein  
overviewMap gws.common.map.Config Uebersicht Kartenkonfiguration nein  
printer gws.common.printer.Config Druckkonfiguration nein  
search gws.common.search.Config Projektweite Suchkonfiguration nein  
title str Projekttitel nein  
uid str Eindeutige ID nein  

gws.common.search.Config

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool search is enabled nein true
providers [gws.types.ext.search.provider.Config…]   nein  

gws.common.style.Config

Feature style

Eigenschaften:

Name Typ   Erforderlich Defaultwert
text str raw style content / selector ja  
type gws.types.StyleType style type ja  
uid str Eindeutige Layer-ID nein  

gws.common.template.FeatureFormatConfig

Feature format

Eigenschaften:

Name Typ   Erforderlich Defaultwert
category gws.types.ext.template.Config feature category nein  
description gws.types.ext.template.Config template for feature descriptions nein  
label gws.types.ext.template.Config feature label on the map nein  
teaser gws.types.ext.template.Config template for feature teasers (short descriptions) nein  
title gws.types.ext.template.Config feature title nein  
uid str Eindeutige Layer-ID nein  

gws.ext.action.alkisgeocoder.Config

ALKIS Geocoder action.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.alkissearch.BuchungConfig

Access to the Grundbuch (register) information

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
uid str Eindeutige Layer-ID nein  

gws.ext.action.alkissearch.Config

Flurstückssuche (cadaster parlcels search) action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
buchung gws.ext.action.alkissearch.BuchungConfig access to the Grundbuch (register) information nein  
eigentuemer gws.ext.action.alkissearch.EigentuemerConfig access to the Eigentümer (owner) information nein  
export gws.ext.helper.alkis.util.export.Config csv export configuration nein  
featureFormat gws.common.template.FeatureFormatConfig template for on-screen Flurstueck details nein  
limit int search results limit nein 100
printTemplate gws.types.ext.template.Config template for printed Flurstueck details nein  
type str Objekttyp ja  
ui gws.ext.action.alkissearch.UiConfig ui options nein  
uid str Eindeutige Layer-ID nein  

gws.ext.action.alkissearch.EigentuemerConfig

Access to the Eigentümer (owner) information

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
controlMode bool restricted mode enabled nein false
controlRules [str…] list of regular expression for the restricted input control nein  
logTable str data access protocol table name nein  
uid str Eindeutige Layer-ID nein  

gws.ext.action.alkissearch.UiConfig

Flurstückssuche UI configuration.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
autoSpatialSearch bool activate spatial search after submit nein false
gemarkungListMode str plain = only “gemarkung”, combined = “gemarkung(gemeinde)”, tree = “gemeinde”, then “gemarkung” nein “combined”
searchSelection bool search in selection enabled nein false
searchSpatial bool spatial search enabled nein false
uid str unique ID nein  
useExport bool export function enabled nein false
usePick bool pick mode enabled nein false
useSelect bool select mode enabled nein false

gws.ext.action.asset.Config

Asset (dynamische HTML) Aktion)

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.auth.Config

Autorisierungsaktion

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.cloud.Config

Cloud admin action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.dimension.Config

Dimension action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
layers [str…] target layer uids nein  
pixelTolerance int pixel tolerance nein 10
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.dprocon.Config

D-Procon action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
cacheTime gws.types.Duration   nein “24h”
dataTableName str table to store consolidated results ja  
dataTablePattern str pattern for result tables to consolidate ja  
infoTitle str   nein  
requestTableName str table to store outgoing requests ja  
requestUrl gws.types.Url   ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.edit.Config

feature edit action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.gekos.Config

GekoS action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
crs gws.types.Crs CRS for gekos data nein  
db str database provider uid nein  
featureFormat gws.common.template.FeatureFormatConfig template for the Flurstueck details popup nein  
instances [str…] gek-online instances nein  
params dict additional parameters for gek-online calls ja  
position gws.ext.action.gekos.PositionConfig position correction for points nein  
table gws.common.db.SqlTableConfig sql table configuration ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url gek-online base url ja  

gws.ext.action.gekos.PositionConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
angle int angle for points repelling nein 0
distance int radius for points repelling nein 0
offsetX int x-offset for points ja  
offsetY int y-offset for points ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.georisks.AarteLinkConfig

AarteLink system configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
serviceLogin str service login ja  
servicePassword str service password ja  
serviceUrl str service url ja  
systemKey str systemKey for the aarteLink connector ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.georisks.Config

Georisks action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
aarteLink gws.ext.action.georisks.AarteLinkConfig AarteLink system configuration ja  
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
db str database provider uid nein  
report gws.ext.action.georisks.ReportConfig report function config ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.georisks.ReportConfig

Configuration for the report function

Eigenschaften:

Name Typ   Erforderlich Defaultwert
imageQuality int jpeg quality level nein 75
maxImageLength int max image size in megabytes nein 5
maxImageSize int max image size in pixels nein 1000
privacyPolicyLink dict url of the privacy policy document nein  
uid str Eindeutige Layer-ID nein  

gws.ext.action.map.Config

map rendering action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.ows.Config

OWS server action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
services [gws.types.ext.ows.service.Config…] services configuration nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.printer.Config

Druckaktion

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.project.Config

Projektaktion

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.search.Config

Suchaktion

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
limit int search results limit nein 1000
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.storage.Config

Storage action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.tabedit.Config

Table Editor action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
dataModel gws.common.model.Config user-editable template attributes nein  
db str database provider uid nein  
project gws.ext.action.tabedit.ProjectConfig qgis project template nein  
sort str sort expression nein  
table gws.common.db.SqlTableConfig sql table configuration ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.tabedit.ProjectConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
datePattern str   ja  
path str   ja  
template gws.types.FilePath   ja  
uid str Eindeutige Layer-ID nein  

gws.ext.auth.provider.file.Config

dateibasierter Autorisierungsanbieter

Eigenschaften:

Name Typ   Erforderlich Defaultwert
path gws.types.FilePath Pfad zur JSON-Datei des Benutzers ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.auth.provider.ldap.Config

LDAP-Autorisierungsanbieter

Eigenschaften:

Name Typ   Erforderlich Defaultwert
activeDirectory bool wahr, wenn der LDAP-Server Active Directory ist nein true
bindDN str BIND DN ja  
bindPassword str BIND Passwort ja  
displayNameFormat gws.types.FormatStr Format für den Anzeigenamen des Benutzers nein “{dn}”
timeout gws.types.Duration LDAP-Server-Timeout nein 30
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url str LDAP-Server-URL “ldap://host:port/baseDN?searchAttribute” ja  
users [gws.ext.auth.provider.ldap.UserSpec…] map LDAP filters to gws roles ja  

gws.ext.auth.provider.ldap.UserSpec

Map LDAP filters to authorization roles

Eigenschaften:

Name Typ   Erforderlich Defaultwert
matches str LDAP filter the account has to match nein  
memberOf str LDAP group the account has to be a member of nein  
roles [str…] gws role names ja  

gws.ext.db.provider.postgres.Config

Postgres/Postgis database provider

Eigenschaften:

Name Typ   Erforderlich Defaultwert
connectTimeout gws.types.Duration connection timeout nein 0
database str database name nein  
host str database host nein “localhost”
password str password ja  
port int database port nein 5432
timeout gws.types.Duration query timeout nein 0
type str Objekttyp ja  
uid str unique id ja  
user str username ja  

gws.ext.helper.alkis.Config

ALKIS helper.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
crs gws.types.Crs CRS for the alkis data ja  
dataSchema str schema where ALKIS tables are stored, must be readable nein “public”
db str database provider ID nein  
excludeGemarkung [str…] Gemarkung (AU) IDs to exclude from search nein  
indexSchema str schema to store gws internal indexes, must be writable nein “gws”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.helper.alkis.util.export.Config

CSV Export configuration.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
groups [gws.ext.helper.alkis.util.export.GroupConfig…]   nein  
uid str Eindeutige Layer-ID nein  

gws.ext.helper.alkis.util.export.GroupConfig

Export group configuration.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
buchung bool   nein false
dataModel gws.common.model.Config   nein  
eigentuemer bool   nein false
title str   ja  
uid str Eindeutige Layer-ID nein  

gws.ext.helper.csv.Config

CSV format settings

Eigenschaften:

Name Typ   Erforderlich Defaultwert
decimal str decimal sign nein “.”
delimiter str field delimiter nein “,”
encoding str encoding for CSV files nein “utf8”
formulaHack bool prepend numeric strings with an equal sign nein true
precision int precision for floats nein 2
quote str quote sign nein “”“
rowDelimiter str row delimiter nein “n”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.helper.storage.Config

Storage

Eigenschaften:

Name Typ   Erforderlich Defaultwert
backend gws.ext.helper.storage.Backend   ja  
path str   nein  
permissions [gws.ext.helper.storage.PermissionRule…]   nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.helper.storage.PermissionRule

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Standardzugriffsmodus nein  
category str storage category name ja  
mode gws.ext.helper.storage.Mode allowed mode (read/write) ja  
uid str Eindeutige Layer-ID nein  

gws.ext.layer.geojson.Config

GeoJson layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “client”
edit gws.common.layer.types.EditConfig editing permissions nein  
editDataModel gws.common.model.Config data model for input data nein  
editStyle gws.common.style.Config style for features being edited nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
keyProp str property name for unique ids nein “id”
legend gws.common.layer.types.LegendConfig legend configuration nein  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) nein “all”
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
path gws.types.FilePath geojson file ja  
search gws.common.search.Config Layer-Suchkonfiguration nein  
style gws.common.style.Config style for features nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.group.Config

Gruppenlayer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “box”
edit gws.common.layer.types.EditConfig editing permissions nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
layers [gws.types.ext.layer.Config…] Layer in dieser Gruppe ja  
legend gws.common.layer.types.LegendConfig legend configuration nein  
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.osm.Config

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “box”
edit gws.common.layer.types.EditConfig editing permissions nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
legend gws.common.layer.types.LegendConfig legend configuration nein  
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.postgres.Config

Postgres layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
db str database provider uid nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “client”
edit gws.common.layer.types.EditConfig editing permissions nein  
editDataModel gws.common.model.Config data model for input data nein  
editStyle gws.common.style.Config style for features being edited nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
legend gws.common.layer.types.LegendConfig legend configuration nein  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) nein “all”
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
style gws.common.style.Config style for features nein  
table gws.common.db.SqlTableConfig sql table configuration ja  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.qgis.Config

automatische QGIS-Layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
cache gws.common.layer.types.CacheConfig Cache-Konfiguration nein  
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
directRender [str…] QGIS providers that should be rendered directly nein  
directSearch [str…] QGIS providers that should be searched directly nein  
display gws.common.layer.types.DisplayMode layer display mode nein “box”
edit gws.common.layer.types.EditConfig editing permissions nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
flatten gws.common.layer.types.FlattenConfig flatten the layer hierarchy nein  
grid gws.common.layer.types.GridConfig Rasterkonfiguration nein  
imageFormat gws.common.layer.types.ImageFormat image format nein “png8”
legend gws.common.layer.types.LegendConfig legend configuration nein  
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
path gws.types.FilePath path to a qgs project file ja  
search gws.common.search.Config Layer-Suchkonfiguration nein  
sourceLayers gws.gis.source.LayerFilterConfig Zu verwendende Quelllayer nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.qgisflat.Config

QGIS direct layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
cache gws.common.layer.types.CacheConfig Cache-Konfiguration nein  
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “box”
edit gws.common.layer.types.EditConfig editing permissions nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
grid gws.common.layer.types.GridConfig Rasterkonfiguration nein  
imageFormat gws.common.layer.types.ImageFormat image format nein “png8”
legend gws.common.layer.types.LegendConfig legend configuration nein  
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
path gws.types.FilePath qgis project path ja  
search gws.common.search.Config Layer-Suchkonfiguration nein  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.tile.Config

Titel-Layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
cache gws.common.layer.types.CacheConfig Cache-Konfiguration nein  
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “tile”
edit gws.common.layer.types.EditConfig editing permissions nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
grid gws.common.layer.types.GridConfig Rasterkonfiguration nein  
imageFormat gws.common.layer.types.ImageFormat image format nein “png8”
legend gws.common.layer.types.LegendConfig legend configuration nein  
maxRequests int max concurrent requests to this source nein 0
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
service gws.ext.layer.tile.ServiceConfig service configuration nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url rest url with placeholders {x}, {y} and {z} ja  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.tile.ServiceConfig

Tile service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
crs gws.types.Crs service CRS nein “EPSG:3857”
extent gws.types.Extent service extent nein  
origin str position of the first tile (nw or sw) nein “nw”
tileSize int tile size nein 256

gws.ext.layer.wfs.Config

WFS layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents nein “1d”
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “client”
edit gws.common.layer.types.EditConfig editing permissions nein  
editDataModel gws.common.model.Config data model for input data nein  
editStyle gws.common.style.Config style for features being edited nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) nein  
legend gws.common.layer.types.LegendConfig legend configuration nein  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) nein “all”
maxRequests int max concurrent requests to this source nein 0
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
params dict extra query params nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use nein  
style gws.common.style.Config style for features nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url service url ja  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.wms.Config

WMS layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
cache gws.common.layer.types.CacheConfig Cache-Konfiguration nein  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents nein “1d”
capsLayersBottomUp bool layers are listed from bottom to top in the GetCapabilities document nein false
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “box”
edit gws.common.layer.types.EditConfig editing permissions nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
getMapParams dict additional parameters for GetMap requests nein  
grid gws.common.layer.types.GridConfig Rasterkonfiguration nein  
imageFormat gws.common.layer.types.ImageFormat image format nein “png8”
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) nein  
legend gws.common.layer.types.LegendConfig legend configuration nein  
maxRequests int max concurrent requests to this source nein 0
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url service url ja  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.layer.wmts.Config

WMTS layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
cache gws.common.layer.types.CacheConfig Cache-Konfiguration nein  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents nein “1d”
clientOptions gws.common.layer.types.ClientOptions Optionen für die Layeranzeige im Client nein  
dataModel gws.common.model.Config layer data model nein  
description gws.types.ext.template.Config Vorlage für die Layerbeschreibung nein  
display gws.common.layer.types.DisplayMode layer display mode nein “tile”
edit gws.common.layer.types.EditConfig editing permissions nein  
extent gws.types.Extent Layerausmasse nein  
extentBuffer int extent buffer nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
grid gws.common.layer.types.GridConfig Rasterkonfiguration nein  
imageFormat gws.common.layer.types.ImageFormat image format nein “png8”
legend gws.common.layer.types.LegendConfig legend configuration nein  
maxRequests int max concurrent requests to this source nein 0
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
ows gws.common.layer.types.OwsConfig OWS services options nein  
params dict query string parameters nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
sourceLayer str WMTS layer name nein  
sourceStyle str WMTS style name nein  
title str Layertitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url service url ja  
zoom gws.gis.zoom.Config Layeraufloesungen und Massstaebe nein  

gws.ext.ows.service.csw.Config

CSW Service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
enabled bool   nein true
featureNamespace str feature namespace name nein “gws”
featureNamespaceUri str feature namespace uri nein “http://gws.gbd-consult.de”
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
profile str ISO or DCMI profile nein “ISO”
templates [gws.types.ext.template.Config…] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
useInspire gws.common.ows.service.UseInspireConfig INSPIRE configuration nein  

gws.ext.ows.service.wfs.Config

WFS Service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
enabled bool   nein true
featureNamespace str feature namespace name nein “gws”
featureNamespaceUri str feature namespace uri nein “http://gws.gbd-consult.de”
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
templates [gws.types.ext.template.Config…] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
useInspire gws.common.ows.service.UseInspireConfig INSPIRE configuration nein  

gws.ext.ows.service.wms.Config

WMS Service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
enabled bool   nein true
featureNamespace str feature namespace name nein “gws”
featureNamespaceUri str feature namespace uri nein “http://gws.gbd-consult.de”
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
templates [gws.types.ext.template.Config…] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
useInspire gws.common.ows.service.UseInspireConfig INSPIRE configuration nein  

gws.ext.search.provider.nominatim.Config

nominatim (OSM) Suchanbieter

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
country str Land, um die Suche einzuschraenken nein  
dataModel gws.common.model.Config feature data model nein  
defaultContext str Standardmaeßiger raeumlicher Kontext nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
language str Sprache der Ergebnisseausgabe nein  
tolerance str tolerance, in pixels or map units nein “10px”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search nein “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search nein “allowed”

gws.ext.search.provider.postgres.Config

Postgres search

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
dataModel gws.common.model.Config feature data model nein  
db str database provider uid nein  
defaultContext str Standardmaeßiger raeumlicher Kontext nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
sort str sort expression nein  
table gws.common.db.SqlTableConfig sql table configuration ja  
tolerance str tolerance, in pixels or map units nein “10px”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search nein “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search nein “allowed”

gws.ext.search.provider.qgispostgres.Config

Qgis/Postgres automatic search provider

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
dataModel gws.common.model.Config feature data model nein  
dataSource dict qgis data source ja  
defaultContext str Standardmaeßiger raeumlicher Kontext nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
tolerance str tolerance, in pixels or map units nein “10px”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search nein “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search nein “allowed”

gws.ext.search.provider.qgiswms.Config

Qgis/Postgres automatic search provider

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
dataModel gws.common.model.Config feature data model nein  
defaultContext str Standardmaeßiger raeumlicher Kontext nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
path gws.types.FilePath project path ja  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use nein  
tolerance str tolerance, in pixels or map units nein “10px”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search nein “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search nein “allowed”

gws.ext.search.provider.wfs.Config

WFS search

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents nein “1d”
dataModel gws.common.model.Config feature data model nein  
defaultContext str Standardmaeßiger raeumlicher Kontext nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) nein  
maxRequests int max concurrent requests to this source nein 0
params dict extra query params nein  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use nein  
tolerance str tolerance, in pixels or map units nein “10px”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url service url ja  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search nein “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search nein “allowed”

gws.ext.search.provider.wms.Config

WMS-basierte Suche

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [gws.types.AccessRuleConfig…] Zugriffsrechte nein  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents nein “1d”
capsLayersBottomUp bool layers are listed from bottom to top in the GetCapabilities document nein false
dataModel gws.common.model.Config feature data model nein  
defaultContext str Standardmaeßiger raeumlicher Kontext nein  
featureFormat gws.common.template.FeatureFormatConfig Objekt-Formatierungsoptionen nein  
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) nein  
maxRequests int max concurrent requests to this source nein 0
sourceLayers gws.gis.source.LayerFilterConfig source layers to use nein  
tolerance str tolerance, in pixels or map units nein “10px”
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url service url ja  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search nein “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search nein “allowed”

gws.ext.template.html.Config

HTML Vorlage

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dataModel gws.common.model.Config Vom Benutzer editierbare Vorlagenattribute nein  
path gws.types.FilePath Pfad zu einer Vorlagendatei nein  
qualityLevels [gws.types.TemplateQualityLevel…] Liste der von der Vorlage unterstützten Qualitätsstufen nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Vorlagentyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.template.qgis.Config

QGIS Drucktemplate

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dataModel gws.common.model.Config Vom Benutzer editierbare Vorlagenattribute nein  
path gws.types.FilePath   ja  
qualityLevels [gws.types.TemplateQualityLevel…] Liste der von der Vorlage unterstützten Qualitätsstufen nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Vorlagentyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.template.text.Config

text-only template

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dataModel gws.common.model.Config Vom Benutzer editierbare Vorlagenattribute nein  
path gws.types.FilePath Pfad zu einer Vorlagendatei nein  
qualityLevels [gws.types.TemplateQualityLevel…] Liste der von der Vorlage unterstützten Qualitätsstufen nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Vorlagentyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.template.xml.Config

XML template

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dataModel gws.common.model.Config Vom Benutzer editierbare Vorlagenattribute nein  
path gws.types.FilePath Pfad zu einer Vorlagendatei nein  
qualityLevels [gws.types.TemplateQualityLevel…] Liste der von der Vorlage unterstützten Qualitätsstufen nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Vorlagentyp ja  
uid str Eindeutige Layer-ID nein  

gws.gis.source.LayerFilterConfig

Layerfilter

Eigenschaften:

Name Typ   Erforderlich Defaultwert
excludePattern gws.types.Regex match a pattern against the layer full path nein  
level int   nein 0
names [str…]   nein  
pattern gws.types.Regex   nein  
uid str Eindeutige Layer-ID nein  

gws.gis.zoom.Config

Zoom- und Aufloesungskonfiguration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
initResolution float Ausgangsaufloesung nein  
initScale float Ausgangsmassstab nein  
maxResolution float maximale Aufloesung nein  
maxScale float maximaler Massstab nein  
minResolution float Minimale Aufloesung nein  
minScale float Minimaler Massstab nein  
resolutions [float…] Erlaubte Aufloesungen nein  
scales [float…] Erlaubte Massstaebe nein  
uid str Eindeutige Layer-ID nein  

gws.server.types.Config

Servermodul-Konfiguration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
autoRun str shell command to run before server start nein  
log str log path nein  
logLevel gws.log.Level Protokollierungsstufe nein “INFO”
mapproxy gws.server.types.MapproxyConfig gebuendeltes Mapproxy-Modul nein  
qgis gws.server.types.QgisConfig gebuendeltes QGIS-Modul nein  
spool gws.server.types.SpoolConfig Spool-Server-Modul nein  
timeout gws.types.Duration Server-Timeout nein 60
uid str Eindeutige Layer-ID nein  
web gws.server.types.WebConfig Webserver-Modul nein  

gws.server.types.MapproxyConfig

Mapproxy-Server-Modul

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool Das Modul ist aktiviert nein true
host str   nein “localhost”
port int   nein 5000
threads int Anzahl der Threads fuer dieses Modul nein 0
uid str Eindeutige Layer-ID nein  
workers int Anzahl der Worker fuer dieses Modul nein 4

gws.server.types.QgisConfig

Enthaltenes QGIS-Servermodul

Eigenschaften:

Name Typ   Erforderlich Defaultwert
debug int QGIS_DEBUG (Umgebungsvariable) nein 0
enabled bool Das Modul ist aktiviert nein true
host str   nein “localhost”
legend dict default legend settings nein  
maxCacheLayers int MAX_CACHE_LAYERS (Umgebungsvariable) nein 4000
maxRequests int max gleichzeitige Requests an diesen Server nein 6
port int   nein 4000
searchPathsForSVG [gws.types.DirPath…] searchPathsForSVG (Ini-Einstellung) nein  
serverCacheSize int QGIS_SERVER_CACHE_SIZE (Umgebungsvariable) nein 10000000
serverLogLevel int QGIS_SERVER_LOG_LEVEL (Umgebungsvariable) nein 2
threads int Anzahl der Threads fuer dieses Modul nein 0
uid str Eindeutige Layer-ID nein  
workers int Anzahl der Worker fuer dieses Modul nein 4

gws.server.types.SpoolConfig

Spool-Server-Modul

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool Das Modul ist aktiviert nein true
jobFrequency gws.types.Duration Haeufigkeit von Hintergrundjobs nein 3
monitorFrequency gws.types.Duration Dateisystemaenderungen ueberpruefen die Haeufigkeit nein 30
threads int Anzahl der Threads fuer dieses Modul nein 0
uid str Eindeutige Layer-ID nein  
workers int Anzahl der Worker fuer dieses Modul nein 4

gws.server.types.WebConfig

Webserver-Modul

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool Das Modul ist aktiviert nein true
maxRequestLength int max request length in megabytes nein 10
threads int Anzahl der Threads fuer dieses Modul nein 0
uid str Eindeutige Layer-ID nein  
workers int Anzahl der Worker fuer dieses Modul nein 4

gws.types.AccessRuleConfig

Zugriffsrechte definition for authorization roles

Eigenschaften:

Name Typ   Erforderlich Defaultwert
role str Liste der Rollen, fuer die diese Regel gilt ja  
type gws.types.AccessType Zugriffstyp (deny oder allow) ja  
uid str Eindeutige Layer-ID nein  

gws.types.Crs

CRS code like “EPSG:3857

gws.types.Date

ISO date like “2019-01-30”

gws.types.DirPath

Valid readable directory path on the server

gws.types.Duration

String like “1w 2d 3h 4m 5s” or a number of seconds

gws.types.Extent

An array of 4 elements representing extent coordinates [minx, miny, maxx, maxy]

gws.types.FilePath

Valid readable file path on the server

gws.types.FormatStr

String with {attribute} placeholders

gws.types.Point

Point coordinates [x, y]

gws.types.Regex

Regular expression, as used in Python

gws.types.TemplateQualityLevel

benannte Qualitaetsstufe fuer Vorlagen

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dpi int DPI-Wert ja  
name str Levelname ja  

gws.types.Url

Http or https URL

gws.types.ext.auth.provider.Config

Einer von:

gws.types.ext.db.provider.Config

Einer von:

gws.web.site.Config

Site (virtual host) configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
assets gws.web.site.DocumentRootConfig assets location and options nein  
cors gws.web.site.CorsConfig cors configuration nein  
errorPage gws.types.ext.template.Config error page template nein  
host str host name nein “*”
reversedHost str hostname for reversed rewriting nein  
reversedRewrite [gws.web.site.RewriteRule…] reversed rewrite rules nein  
rewrite [gws.web.site.RewriteRule…] rewrite rules nein  
root gws.web.site.DocumentRootConfig document root location and options ja  
uid str Eindeutige Layer-ID nein  

gws.web.site.CorsConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
allowCredentials bool   nein false
allowHeaders [str…]   nein  
allowOrigin str   nein “*”
uid str Eindeutige Layer-ID nein  

gws.web.site.DocumentRootConfig

Base directory for assets

Eigenschaften:

Name Typ   Erforderlich Defaultwert
allowMime [str…] allowed mime types nein  
denyMime [str…] disallowed mime types (from the standard list) nein  
dir gws.types.DirPath directory path ja  
uid str Eindeutige Layer-ID nein  

gws.web.site.RewriteRule

Eigenschaften:

Name Typ   Erforderlich Defaultwert
match gws.types.Regex expression to match the url against ja  
options dict additional options nein  
target str target url with placeholders ja  

gws.common.layer.types.DisplayMode

Layer display mode

Einer von:

  • “box”
  • “client”
  • “tile”

gws.common.layer.types.ImageFormat

Image format

Einer von:

  • “png24”
  • “png8”

gws.common.search.provider.ParameterUsage

Einer von:

  • “allowed”
  • “forbidden”
  • “ignored”
  • “required”

gws.ext.helper.storage.Backend

Einer von:

  • “sqlite”

gws.ext.helper.storage.Mode

Einer von:

  • “all”
  • “read”
  • “write”

gws.log.Level

Einer von:

  • “ALL”
  • “CRITICAL”
  • “DEBUG”
  • “ERROR”
  • “INFO”
  • “NOTSET”
  • “WARN”

gws.types.AccessType

Einer von:

  • “allow”
  • “deny”

gws.types.AttributeType

Einer von:

  • “bool”
  • “bytes”
  • “date”
  • “datetime”
  • “float”
  • “geometry”
  • “int”
  • “list”
  • “str”
  • “text”
  • “time”

gws.types.GeometryType

Einer von:

  • “curve”
  • “geomcollection”
  • “geometry”
  • “linestring”
  • “multicurve”
  • “multilinestring”
  • “multipoint”
  • “multipolygon”
  • “multisurface”
  • “point”
  • “polygon”
  • “polyhedralsurface”
  • “surface”

gws.types.StyleType

Einer von:

  • “css”
  • “cssSelector”