Konfigurationsreferenz

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

Der Typ gws.common.application.Config präsentiert die Applikation Konfiguration.

Basis Typen

Grundlegende Datentypen sing wie folgt:

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

gws.common.api.Config

Server actions

Eigenschaften:

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

gws.common.application.Config

Hauptkonfiguration der GBD WebSuite

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Standardzugriffsmodus nein  
api gws.common.api.Config system-wide server actions nein  
auth gws.common.auth.Config Autorisierungsmethoden und -optionen nein  
client gws.common.client.Config GBD WebSuite Client Konfiguration nein  
db gws.common.application.DbConfig Datenbankkonfiguration nein  
developer dict developer options nein  
fonts gws.common.application.FontConfig fonts configuration nein  
helpers [ gws.types.ext.helper.Config ] helpers configurations nein  
locales [ str ] default locales for all projects nein  
meta gws.common.metadata.Config application metadata 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  
uid str Eindeutige Layer-ID nein  
web gws.common.application.WebConfig Webserver-Konfiguration 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 bundle 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.Config

Authentication and authorization options

Eigenschaften:

Name Typ   Erforderlich Defaultwert
methods [ gws.types.ext.auth.method.Config ] authorization methods nein  
providers [ gws.types.ext.auth.provider.Config ] authorization providers ja  
sessionLifeTime gws.types.Duration session life time nein 1200
sessionStorage 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.Access ] 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.Access ] Standardzugriffsmodus nein  
after str insert after this tag nein  
before str insert before this tag nein  
options dict options 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.CustomConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Standardzugriffsmodus nein  
applyTo gws.gis.source.LayerFilter source layers this configuration applies to nein  
cache gws.common.layer.types.CacheConfig cache configuration nein  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client nein  
dataModel gws.common.model.Config layer data model nein  
display gws.common.layer.types.DisplayMode layer display mode nein  
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent layer extent nein  
legend gws.common.layer.types.LegendConfig legend configuration nein  
meta gws.common.metadata.Config layer meta data nein  
opacity float layer opacity nein  
order int layer order nein  
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config layer search configuration nein  
templates [ gws.types.ext.template.Config ] client templates nein  
title str layer title nein  
uid str Eindeutige Layer-ID nein  
zoom gws.gis.zoom.Config layer resolutions and scales 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.DisplayMode

Layer display mode

Einer von:

  • "box"
  • "client"
  • "tile"

gws.common.layer.types.EditConfig

Edit access for a layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Standardzugriffsmodus nein  
filter str sql filter for features nein  
uid str Eindeutige Layer-ID nein  

gws.common.layer.types.FlattenConfig

Layer hierarchy flattening

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.ImageFormat

Image format

Einer von:

  • "png24"
  • "png8"

gws.common.layer.types.LegendConfig

Layer legend confuguration.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool the legend is enabled nein true
options dict provider-dependent legend options nein  
path gws.types.FilePath path of the legend image nein  
template gws.types.ext.template.Config template for an HTML legend nein  
uid str Eindeutige Layer-ID nein  
url gws.types.Url url of the legend image nein  

gws.common.layer.types.OwsConfig

OWS services confuguration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabledServices gws.common.layer.types.OwsEnabledServicesConfig enabled OWS services nein  
enabled bool enable this layer for ows services nein true
featureName str feature name for ows services nein  
name str layer name for ows services nein  
uid str Eindeutige Layer-ID nein  

gws.common.layer.types.OwsEnabledServicesConfig

Configuration for enabled OWS services

Eigenschaften:

Name Typ   Erforderlich Defaultwert
pattern gws.types.Regex pattern for enabled service uids nein  
uid str Eindeutige Layer-ID nein  
uids [ str ] enabled services uids 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"
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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  
authorityIdentifier str   nein  
authorityName str   nein  
authorityUrl gws.types.Url   nein  
catalogCitationUid str catalog citation identifier nein  
catalogUid str catalog identifier nein  
contact gws.common.metadata.ContactConfig contact information nein  
dateBegin gws.types.Date temporal extent begin nein  
dateCreated gws.types.Date publication date nein  
dateEnd gws.types.Date temporal extent end nein  
dateUpdated gws.types.Date modification date nein  
fees str   nein  
image gws.types.Url image (logo) url nein  
insipreKeywords [ gws.common.metadata.MetaInspireMandatoryKeyword ]   nein  
insipreMandatoryKeyword gws.common.metadata.MetaInspireMandatoryKeyword   nein  
inspireDegreeOfConformity gws.common.metadata.MetaInspireDegreeOfConformity   nein  
inspireResourceType gws.common.metadata.MetaInspireResourceType   nein  
inspireSpatialDataServiceType gws.common.metadata.MetaInspireSpatialDataServiceType   nein  
inspireSpatialScope gws.common.metadata.MetaInspireSpatialScope   nein  
inspireTheme gws.common.metadata.MetaInspireTheme   nein  
isoMaintenanceFrequencyCode gws.common.metadata.MetaIsoMaintenanceFrequencyCode   nein  
isoQualityConformance [ gws.common.metadata.MetaIsoQualityConformance ]   nein  
isoQualityLineage gws.common.metadata.MetaIsoQualityLineage   nein  
isoRestrictionCode gws.common.metadata.MetaIsoRestrictionCode   nein  
isoScopeName str ISO-19139 scope name nein  
isoScope gws.common.metadata.MetaIsoScope ISO-19139 scope code nein  
isoSpatialRepresentationType gws.common.metadata.MetaIsoSpatialRepresentationType ISO-19139 spatial type nein  
isoTopicCategory gws.common.metadata.MetaIsoTopicCategory ISO-19139 topic category nein  
keywords [ str ] keywords nein []
language str object language nein  
license str   nein  
links [ gws.common.metadata.LinkConfig ] additional links nein []
name str object internal name nein  
serviceUrl gws.types.Url service url nein  
title str object title nein  
uid str Eindeutige Layer-ID nein  
urlFormat str metadata url mime type nein  
urlType str metadata url type like “TC211” 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
formatName str link format nein  
formatVersion str link format version nein  
function gws.common.metadata.MetaIsoOnLineFunction ISO-19115 function nein  
scheme str link scheme nein  
uid str Eindeutige Layer-ID nein  
url gws.types.Url link url ja  

gws.common.metadata.MetaInspireDegreeOfConformity

Inspire degreeOfConformity, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

Einer von:

  • "conformant"
  • "notConformant"
  • "notEvaluated"

gws.common.metadata.MetaInspireMandatoryKeyword

Inspire keyword, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

Einer von:

  • "chainDefinitionService"
  • "comEncodingService"
  • "comGeographicCompressionService"
  • "comGeographicFormatConversionService"
  • "comMessagingService"
  • "comRemoteFileAndExecutableManagement"
  • "comService"
  • "comTransferService"
  • "humanCatalogueViewer"
  • "humanChainDefinitionEditor"
  • "humanFeatureGeneralizationEditor"
  • "humanGeographicDataStructureViewer"
  • "humanGeographicFeatureEditor"
  • "humanGeographicSpreadsheetViewer"
  • "humanGeographicSymbolEditor"
  • "humanGeographicViewer"
  • "humanInteractionService"
  • "humanServiceEditor"
  • "humanWorkflowEnactmentManager"
  • "infoCatalogueService"
  • "infoCoverageAccessService"
  • "infoFeatureAccessService"
  • "infoFeatureTypeService"
  • "infoGazetteerService"
  • "infoManagementService"
  • "infoMapAccessService"
  • "infoOrderHandlingService"
  • "infoProductAccessService"
  • "infoRegistryService"
  • "infoSensorDescriptionService"
  • "infoStandingOrderService"
  • "metadataGeographicAnnotationService"
  • "metadataProcessingService"
  • "metadataStatisticalCalculationService"
  • "spatialCoordinateConversionService"
  • "spatialCoordinateTransformationService"
  • "spatialCoverageVectorConversionService"
  • "spatialDimensionMeasurementService"
  • "spatialFeatureGeneralizationService"
  • "spatialFeatureManipulationService"
  • "spatialFeatureMatchingService"
  • "spatialImageCoordinateConversionService"
  • "spatialImageGeometryModelConversionService"
  • "spatialOrthorectificationService"
  • "spatialPositioningService"
  • "spatialProcessingService"
  • "spatialProximityAnalysisService"
  • "spatialRectificationService"
  • "spatialRouteDeterminationService"
  • "spatialSamplingService"
  • "spatialSensorGeometryModelAdjustmentService"
  • "spatialSubsettingService"
  • "spatialTilingChangeService"
  • "subscriptionService"
  • "taskManagementService"
  • "temporalProcessingService"
  • "temporalProximityAnalysisService"
  • "temporalReferenceSystemTransformationService"
  • "temporalSamplingService"
  • "temporalSubsettingService"
  • "thematicChangeDetectionService"
  • "thematicClassificationService"
  • "thematicFeatureGeneralizationService"
  • "thematicGeocodingService"
  • "thematicGeographicInformationExtractionService"
  • "thematicGeoparsingService"
  • "thematicGoparameterCalculationService"
  • "thematicImageManipulationService"
  • "thematicImageProcessingService"
  • "thematicImageSynthesisService"
  • "thematicImageUnderstandingService"
  • "thematicMultibandImageManipulationService"
  • "thematicObjectDetectionService"
  • "thematicProcessingService"
  • "thematicReducedResolutionGenerationService"
  • "thematicSpatialCountingService"
  • "thematicSubsettingService"
  • "workflowEnactmentService"

gws.common.metadata.MetaInspireResourceType

Inspire resourceType, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

Einer von:

  • "dataset"
  • "series"
  • "service"

gws.common.metadata.MetaInspireSpatialDataServiceType

Inspire spatialDataServiceType, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

Einer von:

  • "discovery"
  • "download"
  • "invoke"
  • "other"
  • "transformation"
  • "view"

gws.common.metadata.MetaInspireSpatialScope

Inspire spatialScope, see https://inspire.ec.europa.eu/metadata-codelist/SpatialScope

Einer von:

  • "european"
  • "global_"
  • "local"
  • "national"
  • "regional"

gws.common.metadata.MetaInspireTheme

Inspire theme, see http://inspire.ec.europa.eu/theme/

Einer von:

  • "ac"
  • "ad"
  • "af"
  • "am"
  • "au"
  • "br"
  • "bu"
  • "cp"
  • "ef"
  • "el"
  • "er"
  • "ge"
  • "gg"
  • "gn"
  • "hb"
  • "hh"
  • "hy"
  • "lc"
  • "lu"
  • "mf"
  • "mr"
  • "nz"
  • "of"
  • "oi"
  • "pd"
  • "pf"
  • "ps"
  • "rs"
  • "sd"
  • "so"
  • "sr"
  • "su"
  • "tn"
  • "us"

gws.common.metadata.MetaIsoMaintenanceFrequencyCode

ISO-19139 MD_MaintenanceFrequencyCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

Einer von:

  • "annually"
  • "asNeeded"
  • "biannually"
  • "continual"
  • "daily"
  • "fortnightly"
  • "irregular"
  • "monthly"
  • "notPlanned"
  • "quarterly"
  • "unknown"
  • "weekly"

gws.common.metadata.MetaIsoOnLineFunction

ISO-19139 CI_OnLineFunctionCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

Einer von:

  • "download"
  • "information"
  • "offlineAccess"
  • "order"
  • "search"

gws.common.metadata.MetaIsoQualityConformance

Eigenschaften:

Name Typ   Erforderlich Defaultwert
explanation str   nein  
qualityPass bool   ja  
specificationDate str   ja  
specificationTitle str   ja  

gws.common.metadata.MetaIsoQualityLineage

Eigenschaften:

Name Typ   Erforderlich Defaultwert
sourceScale int   ja  
source str   ja  
statement str   ja  

gws.common.metadata.MetaIsoRestrictionCode

ISO-19139 MD_RestrictionCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

Einer von:

  • "copyright"
  • "intellectualPropertyRights"
  • "license"
  • "otherRestrictions"
  • "patent"
  • "patentPending"
  • "restricted"
  • "trademark"

gws.common.metadata.MetaIsoScope

ISO-19139 MD/MX_ScopeCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

Einer von:

  • "attribute"
  • "attributeType"
  • "collectionHardware"
  • "collectionSession"
  • "dataset"
  • "dimensionGroup"
  • "feature"
  • "featureType"
  • "fieldSession"
  • "initiative"
  • "model"
  • "nonGeographicDataset"
  • "otherAggregate"
  • "platformSeries"
  • "productionSeries"
  • "propertyType"
  • "sensor"
  • "sensorSeries"
  • "series"
  • "service"
  • "software"
  • "stereomate"
  • "tile"
  • "transferAggregate"

gws.common.metadata.MetaIsoSpatialRepresentationType

ISO-19139 MD_SpatialRepresentationTypeCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

Einer von:

  • "grid"
  • "stereoModel"
  • "textTable"
  • "tin"
  • "vector"
  • "video"

gws.common.metadata.MetaIsoTopicCategory

ISO-19139 MD_TopicCategoryCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

Einer von:

  • "biota"
  • "boundaries"
  • "climatologyMeteorologyAtmosphere"
  • "economy"
  • "elevation"
  • "environment"
  • "farming"
  • "geoscientificInformation"
  • "health"
  • "imageryBaseMapsEarthCover"
  • "inlandWaters"
  • "intelligenceMilitary"
  • "location"
  • "oceans"
  • "planningCadastre"
  • "society"
  • "structure"
  • "transportation"
  • "utilitiesCommunication"

gws.common.model.AttributeEditor

Eigenschaften:

Name Typ   Erforderlich Defaultwert
accept str   nein  
items de_configref_gws_types_Any   nein  
max float   nein  
min float   nein  
multiple bool   nein  
pattern gws.types.Regex   nein  
type str   ja  

gws.common.model.AttributeValidator

Eigenschaften:

Name Typ   Erforderlich Defaultwert
attribute str   nein  
max float   nein  
message str   ja  
min float   nein  
pattern gws.types.Regex   nein  
type str   ja  

gws.common.model.Config

Data model

Eigenschaften:

Name Typ   Erforderlich Defaultwert
crs gws.types.Crs CRS for this model nein  
geometryType gws.types.GeometryType specific geometry type nein  
rules [ gws.common.model.ModelRule ] attribute conversion rules 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
editor gws.common.model.AttributeEditor   nein  
expression str attribute conversion expression nein  
format gws.types.FormatStr attribute formatter nein  
name str target attribute name nein  
source str source attribute name nein  
title str target attribute title nein  
type gws.types.AttributeType target attribute type nein "str"
validators [ gws.common.model.AttributeValidator ]   nein  
value str constant value 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.Access ] 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  
locales [ str ] project locales nein  
map gws.common.map.Config Kartenkonfiguration nein  
meta gws.common.metadata.Config project metadata nein  
overviewMap gws.common.map.Config Uebersicht Kartenkonfiguration nein  
printer gws.common.printer.Config Druckkonfiguration nein  
search gws.common.search.Config Projektweite Suchkonfiguration nein  
templates [ gws.types.ext.template.Config ] project info templates 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.search.provider.SearchSpatialContext

Einer von:

  • "map"
  • "view"

gws.common.style.Config

Feature style

Eigenschaften:

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

gws.ext.action.alkisgeocoder.Config

ALKIS Geocoder action.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
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.Access ] Standardzugriffsmodus nein  
uid str Eindeutige Layer-ID nein  

gws.ext.action.alkissearch.Config

Flurstücksuche (cadaster parlcels search) action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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  
helper str ALKIS helper uid nein  
limit int search results limit nein 100
printTemplate gws.types.ext.template.Config template for printed Flurstueck details nein  
templates [ gws.types.ext.template.Config ] templates for on-screen 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.Access ] Standardzugriffsmodus nein  
controlMode bool restricted mode enabled nein false
controlRules [ str ] 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.UiBblattSearchMode

Einer von:

  • "any"
  • "end"
  • "exact"
  • "start"

gws.ext.action.alkissearch.UiConfig

Flurstücksuche UI configuration.

Eigenschaften:

Name Typ   Erforderlich Defaultwert
autoSpatialSearch bool activate spatial search after submit nein false
bblattSearchMode gws.ext.action.alkissearch.UiBblattSearchMode buchungsblatt search mode nein "any"
gemarkungListMode gws.ext.action.alkissearch.UiGemarkungListMode gemarkung list mode nein "combined"
searchSelection bool search in selection enabled nein false
searchSpatial bool spatial search enabled nein false
strasseListMode gws.ext.action.alkissearch.UiStrasseListMode strasse list entry format nein "plain"
strasseSearchMode gws.ext.action.alkissearch.UiStrasseSearchMode strasse search mode nein "start"
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.alkissearch.UiGemarkungListMode

Einer von:

  • "combined"
  • "none"
  • "plain"
  • "tree"

gws.ext.action.alkissearch.UiStrasseListMode

Einer von:

  • "plain"
  • "withGemarkung"
  • "withGemarkungIfRepeated"
  • "withGemeinde"
  • "withGemeindeIfRepeated"

gws.ext.action.alkissearch.UiStrasseSearchMode

Einer von:

  • "any"
  • "start"

gws.ext.action.asset.Config

Asset (dynamische HTML) Aktion)

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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.Access ] Zugriffsrechte nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.bplan.AdministrativeUnitConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Standardzugriffsmodus nein  
name str   ja  
uid str   ja  

gws.ext.action.bplan.Config

Construction plans management action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
adminMode bool   nein false
administrativeUnits [ gws.ext.action.bplan.AdministrativeUnitConfig ] Administrative Units ja  
crs gws.types.Crs CRS for the bplan data ja  
dataDir gws.types.DirPath data directory ja  
db str database provider ID nein  
emailFrom str   nein  
emailServerHost str   nein  
emailSubject str   nein  
emailTo str   nein  
exportDataModel gws.common.model.Config data model for csv export nein  
groupLayerUid str uid of the B-Plan group layer ja  
imageQuality int palette size for optimized images nein 24
metaTable gws.common.db.SqlTableConfig meta table configuration ja  
planTable gws.common.db.SqlTableConfig plan table configuration ja  
planTypes [ gws.ext.action.bplan.PlanTypeConfig ] Plan Types ja  
templates [ gws.types.ext.template.Config ] templates ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
uploadChunkSize int upload chunk size in mb nein 10

gws.ext.action.bplan.PlanTypeConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
color str   ja  
name str   ja  
srcName str   ja  
uid str   ja  

gws.ext.action.collector.CollectionPrototypeConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
collectionTable gws.common.db.SqlTableConfig sql table configuration ja  
dataModel gws.common.model.Config   nein  
db str database provider uid nein  
documentTable gws.common.db.SqlTableConfig sql table configuration ja  
itemTable gws.common.db.SqlTableConfig sql table configuration ja  
items [ gws.ext.action.collector.ItemPrototypeConfig ]   ja  
linkColumn str   nein "collection_id"
name str   ja  
showWhere str extra condition to show collections nein  
style gws.common.style.Config style for collection center point nein  
type str   ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.collector.Config

Collection editor action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
collections [ gws.ext.action.collector.CollectionPrototypeConfig ]   ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.collector.ItemPrototypeConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dataModel gws.common.model.Config   ja  
icon str   nein  
name str   ja  
style gws.common.style.Config style for features nein  
type str   ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.dimension.Config

Dimension action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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 connector action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
cacheTime gws.types.Duration request cache life time nein "24h"
dataTableName str table to store consolidated results ja  
dataTablePattern str pattern for result tables to consolidate ja  
extraColumns [ gws.ext.action.dprocon.ExtraColumnConfig ]   nein  
gemeindeFilter [ str ] gemeinde (AU) ids to keep in the index nein  
infoTitle str information box title nein  
requestTableName str table to store outgoing requests ja  
requestUrl gws.types.Url main program url, with the placholder {REQUEST_ID} ja  
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.dprocon.ExtraColumnConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
name str   ja  
sql str   ja  
type str   ja  

gws.ext.action.edit.Config

feature edit action

Eigenschaften:

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

gws.ext.action.fs.Config

File system action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
root gws.types.DirPath file system root ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.fsinfo.Config

FSInfo action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
dataTable gws.common.db.SqlTableConfig   ja  
db str database provider uid nein  
documentTable gws.common.db.SqlTableConfig   ja  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] Zugriffsrechte nein  
crs gws.types.Crs CRS for gekos data nein  
db str database provider uid nein  
position gws.ext.action.gekos.PositionConfig position correction for points nein  
sources [ gws.ext.action.gekos.SourceConfig ] gek-online instances nein  
table gws.common.db.SqlTableConfig sql table configuration ja  
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

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.gekos.SourceConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
instance str instance name for this source ja  
params dict additional parameters for gek-online calls ja  
uid str Eindeutige Layer-ID nein  
url gws.types.Url gek-online base url ja  

gws.ext.action.georisks.Config

Georisks action

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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.Access ] 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.Access ] 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.Access ] 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.Access ] 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.Access ] 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.Access ] 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.Access ] Zugriffsrechte nein  
db str database provider uid nein  
tables [ gws.ext.action.tabedit.TableConfig ]   ja  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.action.tabedit.TableConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dataModel gws.common.model.Config table data model nein  
sort str sort expression nein  
table gws.common.db.SqlTableConfig sql table configuration ja  
title str   nein  
uid str Eindeutige Layer-ID nein  
widths [ int ] column widths, 0 to exclude nein  
withAdd bool use the ‘add’ button nein  
withFilter bool use filter boxes nein  

gws.ext.auth.method.basic.Config

HTTP-basic authorization options

Eigenschaften:

Name Typ   Erforderlich Defaultwert
secure bool use only with SSL nein true
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.auth.method.web.Config

Web-based authorization options

Eigenschaften:

Name Typ   Erforderlich Defaultwert
cookieName str name for the cookie nein "auth"
cookiePath str cookie path nein "/"
secure bool use only with SSL nein true
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.auth.provider.file.Config

dateibasierter Autorisierungsanbieter

Eigenschaften:

Name Typ   Erforderlich Defaultwert
allowedMethods [ str ] allowed authorization methods nein  
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
allowedMethods [ str ] allowed authorization methods nein  
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 ] role names ja  

gws.ext.auth.provider.postgres.Config

Postgres authorization provider

Eigenschaften:

Name Typ   Erforderlich Defaultwert
allowedMethods [ str ] allowed authorization methods nein  
authSql str sql statement for login check ja  
db str database provider ID nein  
type str Objekttyp ja  
uidSql str sql statement for fetching user data ja  
uid str Eindeutige Layer-ID nein  

gws.ext.db.provider.postgres.Config

Postgres/Postgis database provider

Eigenschaften:

Name Typ   Erforderlich Defaultwert
connectTimeout gws.types.Duration connect 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 nein "public"
db str database provider ID nein  
excludeGemarkung [ str ] Gemarkung (Administrative Unit) IDs to exclude from search nein  
indexSchema str schema to store GWS internal indexes 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.Access ] Standardzugriffsmodus nein  
groups [ gws.ext.helper.alkis.util.export.GroupConfig ] export groups nein  
uid str Eindeutige Layer-ID nein  

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

Export group configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
buchung bool include Grundbuch (register) data nein false
dataModel gws.common.model.Config data model for this group nein  
eigentuemer bool include Eigentuemer (owner) data nein false
title str title for this group 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
quoteAll bool quote all fields nein false
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.Backend

Einer von:

  • "sqlite"

gws.ext.helper.storage.Config

Storage helper

Eigenschaften:

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

gws.ext.helper.storage.Mode

Einer von:

  • "all"
  • "read"
  • "write"

gws.ext.helper.storage.PermissionRule

Permission rule for a storage category

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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.helper.xml.Config

XML settings

Eigenschaften:

Name Typ   Erforderlich Defaultwert
namespaces [ gws.ext.helper.xml.NamespaceConfig ] custom namespaces nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.ext.helper.xml.NamespaceConfig

XML namespace configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
name str namespace name ja  
schemaLocation gws.types.Url namespace schema location nein  
uri gws.types.Url namespace uri ja  

gws.ext.layer.geojson.Config

GeoJson layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "client"
editDataModel gws.common.model.Config data model for input data nein  
editStyle gws.common.style.Config style for features being edited nein  
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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
order int layer order nein  
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  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "box"
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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
order int layer order nein  
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "client"
editDataModel gws.common.model.Config data model for input data nein  
editStyle gws.common.style.Config style for features being edited nein  
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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
order int layer order nein  
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  
templates [ gws.types.ext.template.Config ] client templates 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.qgis.Config

automatische QGIS-Layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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  
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  
excludeLayers gws.gis.source.LayerFilter source layers to exclude nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse nein  
flattenLayers 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"
layerConfig [ gws.common.layer.CustomConfig ] custom configurations for specific layers nein  
legend gws.common.layer.types.LegendConfig legend configuration nein  
meta gws.common.metadata.Config Layermetadaten nein  
opacity float Layertransparenz nein 1
order int layer order nein  
ows gws.common.layer.types.OwsConfig OWS services options nein  
path gws.types.FilePath path to a qgs project file ja  
rootLayers gws.gis.source.LayerFilter source layers to use as roots nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "box"
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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
order int layer order nein  
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.LayerFilter source layers to use nein  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "tile"
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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
order int layer order nein  
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  
templates [ gws.types.ext.template.Config ] client templates 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  
tileSize int tile size nein 256

gws.ext.layer.wfs.Config

WFS layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "client"
editDataModel gws.common.model.Config data model for input data nein  
editStyle gws.common.style.Config style for features being edited nein  
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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
order int layer order nein  
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.LayerFilter source layers to use nein  
style gws.common.style.Config style for features nein  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "box"
edit gws.common.layer.types.EditConfig editing permissions nein  
excludeLayers gws.gis.source.LayerFilter source layers to exclude nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse nein  
flattenLayers gws.common.layer.types.FlattenConfig flatten the layer hierarchy nein  
getCapabilitiesParams dict additional parameters for GetCapabilities requests 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  
layerConfig [ gws.common.layer.CustomConfig ] custom configurations for specific layers 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
order int layer order nein  
ows gws.common.layer.types.OwsConfig OWS services options nein  
rootLayers gws.gis.source.LayerFilter source layers to use as roots nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
templates [ gws.types.ext.template.Config ] client templates 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.wmsflat.Config

WMS Flat layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "box"
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse nein  
getCapabilitiesParams dict additional parameters for GetCapabilities requests 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
order int layer order nein  
ows gws.common.layer.types.OwsConfig OWS services options nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
sourceLayers gws.gis.source.LayerFilter source layers to use nein  
templates [ gws.types.ext.template.Config ] client templates 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.wmstree.Config

WMS layer

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "box"
edit gws.common.layer.types.EditConfig editing permissions nein  
excludeLayers gws.gis.source.LayerFilter source layers to exclude nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse nein  
flattenLayers gws.common.layer.types.FlattenConfig flatten the layer hierarchy nein  
getCapabilitiesParams dict additional parameters for GetCapabilities requests 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  
layerConfig [ gws.common.layer.CustomConfig ] custom configurations for specific layers 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
order int layer order nein  
ows gws.common.layer.types.OwsConfig OWS services options nein  
rootLayers gws.gis.source.LayerFilter source layers to use as roots nein  
search gws.common.search.Config Layer-Suchkonfiguration nein  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] 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  
display gws.common.layer.types.DisplayMode layer display mode nein "tile"
edit gws.common.layer.types.EditConfig editing permissions nein  
extentBuffer int extent buffer nein  
extent gws.types.Extent Layerausmasse 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
order int layer order nein  
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  
templates [ gws.types.ext.template.Config ] client templates 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.Access ] Zugriffsrechte nein  
forceFeatureName str   nein  
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
profile gws.ext.ows.service.csw.Profile metadata profile nein "ISO"
root str root layer uid nein  
strictParams bool strict parameter parsing nein false
supportedCrs [ gws.types.Crs ] supported CRS for this service nein  
templates [ gws.types.ext.template.Config ] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
updateSequence str service update sequence nein  
withInspireMeta bool use INSPIRE Metadata nein false

gws.ext.ows.service.csw.Profile

Einer von:

  • "DCMI"
  • "ISO"

gws.ext.ows.service.wcs.Config

WCS Service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
forceFeatureName str   nein  
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
root str root layer uid nein  
strictParams bool strict parameter parsing nein false
supportedCrs [ gws.types.Crs ] supported CRS for this service nein  
templates [ gws.types.ext.template.Config ] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
updateSequence str service update sequence nein  
withInspireMeta bool use INSPIRE Metadata nein false

gws.ext.ows.service.wfs.Config

WFS Service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
forceFeatureName str   nein  
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
root str root layer uid nein  
strictParams bool strict parameter parsing nein false
supportedCrs [ gws.types.Crs ] supported CRS for this service nein  
templates [ gws.types.ext.template.Config ] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
updateSequence str service update sequence nein  
withInspireMeta bool use INSPIRE Metadata nein false

gws.ext.ows.service.wms.Config

WMS Service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
forceFeatureName str   nein  
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
root str root layer uid nein  
strictParams bool strict parameter parsing nein false
supportedCrs [ gws.types.Crs ] supported CRS for this service nein  
templates [ gws.types.ext.template.Config ] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
updateSequence str service update sequence nein  
withInspireMeta bool use INSPIRE Metadata nein false

gws.ext.ows.service.wmts.Config

WMTS Service configuration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
forceFeatureName str   nein  
meta gws.common.metadata.Config service metadata nein  
name str service name nein  
root str root layer uid nein  
strictParams bool strict parameter parsing nein false
supportedCrs [ gws.types.Crs ] supported CRS for this service nein  
templates [ gws.types.ext.template.Config ] service XML templates nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
updateSequence str service update sequence nein  
withInspireMeta bool use INSPIRE Metadata nein false

gws.ext.search.provider.nominatim.Config

nominatim (OSM) Suchanbieter

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
country str Land, um die Suche einzuschraenken nein  
dataModel gws.common.model.Config feature data model nein  
defaultContext gws.common.search.provider.SearchSpatialContext Standardmaeßiger raeumlicher Kontext nein "map"
language str Sprache der Ergebnisseausgabe nein  
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
title str Titel der Suchergebnisse nein  
tolerance str tolerance, in pixels or map units nein "10px"
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry bool enable geometry search nein true
withKeyword bool enable keyword search nein true

gws.ext.search.provider.postgres.Config

Postgres search

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
dataModel gws.common.model.Config feature data model nein  
db str database provider uid nein  
defaultContext gws.common.search.provider.SearchSpatialContext Standardmaeßiger raeumlicher Kontext nein "map"
sort str sort expression nein  
table gws.common.db.SqlTableConfig sql table configuration ja  
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
title str Titel der Suchergebnisse nein  
tolerance str tolerance, in pixels or map units nein "10px"
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry bool enable geometry search nein true
withKeyword bool enable keyword search nein true

gws.ext.search.provider.qgispostgres.Config

Qgis/Postgres automatic search provider

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
dataModel gws.common.model.Config feature data model nein  
dataSource dict qgis data source ja  
defaultContext gws.common.search.provider.SearchSpatialContext Standardmaeßiger raeumlicher Kontext nein "map"
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
title str Titel der Suchergebnisse nein  
tolerance str tolerance, in pixels or map units nein "10px"
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry bool enable geometry search nein true
withKeyword bool enable keyword search nein true

gws.ext.search.provider.qgiswms.Config

Qgis/Postgres automatic search provider

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
dataModel gws.common.model.Config feature data model nein  
defaultContext gws.common.search.provider.SearchSpatialContext Standardmaeßiger raeumlicher Kontext nein "map"
path gws.types.FilePath project path ja  
sourceLayers gws.gis.source.LayerFilter source layers to use nein  
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
title str Titel der Suchergebnisse nein  
tolerance str tolerance, in pixels or map units nein "10px"
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  
withGeometry bool enable geometry search nein true
withKeyword bool enable keyword search nein true

gws.ext.search.provider.wfs.Config

WFS search

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] Zugriffsrechte nein  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents nein "1d"
dataModel gws.common.model.Config feature data model nein  
defaultContext gws.common.search.provider.SearchSpatialContext Standardmaeßiger raeumlicher Kontext nein "map"
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.LayerFilter source layers to use nein  
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
title str Titel der Suchergebnisse 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 bool enable geometry search nein true
withKeyword bool enable keyword search nein true

gws.ext.search.provider.wms.Config

WMS-basierte Suche

Eigenschaften:

Name Typ   Erforderlich Defaultwert
access [ gws.types.Access ] 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 gws.common.search.provider.SearchSpatialContext Standardmaeßiger raeumlicher Kontext nein "map"
getCapabilitiesParams dict additional parameters for GetCapabilities requests nein  
getMapParams dict additional parameters for GetMap requests 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.LayerFilter source layers to use nein  
templates [ gws.types.ext.template.Config ] feature formatting templates nein  
title str Titel der Suchergebnisse 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 bool enable geometry search nein true
withKeyword bool enable keyword search nein true

gws.ext.template.html.Config

HTML Vorlage

Eigenschaften:

Name Typ   Erforderlich Defaultwert
dataModel gws.common.model.Config Vom Benutzer editierbare Vorlagenattribute nein  
mimeTypes [ str ] mime types this template can generate nein  
path gws.types.FilePath Pfad zu einer Vorlagendatei nein  
qualityLevels [ gws.types.TemplateQualityLevel ] Liste der von der Vorlage unterstuetzten Qualitaetsstufen nein  
subject str template purpose nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Objekttyp 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  
mimeTypes [ str ] mime types this template can generate nein  
path gws.types.FilePath   ja  
qualityLevels [ gws.types.TemplateQualityLevel ] Liste der von der Vorlage unterstuetzten Qualitaetsstufen nein  
subject str template purpose nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Objekttyp 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  
mimeTypes [ str ] mime types this template can generate nein  
path gws.types.FilePath Pfad zu einer Vorlagendatei nein  
qualityLevels [ gws.types.TemplateQualityLevel ] Liste der von der Vorlage unterstuetzten Qualitaetsstufen nein  
subject str template purpose nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Objekttyp 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  
mimeTypes [ str ] mime types this template can generate nein  
path gws.types.FilePath Pfad zu einer Vorlagendatei nein  
qualityLevels [ gws.types.TemplateQualityLevel ] Liste der von der Vorlage unterstuetzten Qualitaetsstufen nein  
subject str template purpose nein  
text str Vorlageninhalt nein  
title str Vorlagentitel nein  
type str Objekttyp ja  
uid str Eindeutige Layer-ID nein  

gws.gis.source.LayerFilter

Layerfilter

Eigenschaften:

Name Typ   Erforderlich Defaultwert
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.log.Level

Einer von:

  • "ALL"
  • "CRITICAL"
  • "DEBUG"
  • "ERROR"
  • "INFO"
  • "NOTSET"
  • "WARN"

gws.server.types.Config

Servermodul-Konfiguration

Eigenschaften:

Name Typ   Erforderlich Defaultwert
autoRun str shell command to run before server start nein  
logLevel gws.log.Level Protokollierungsstufe nein "INFO"
log str log path nein  
mapproxy gws.server.types.MapproxyConfig gebuendeltes Mapproxy-Modul nein  
monitor gws.server.types.MonitorConfig monitor configuation nein  
qgis gws.server.types.QgisConfig gebuendeltes QGIS-Modul nein  
spool gws.server.types.SpoolConfig Spool-Server-Modul nein  
timeZone str timezone for this server nein "UTC"
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.MonitorConfig

Eigenschaften:

Name Typ   Erforderlich Defaultwert
enabled bool the module is enabled nein true
frequency gws.types.Duration filesystem changes check frequency nein 30
ignore [ gws.types.Regex ] ignore paths that match these regexes nein  
uid str Eindeutige Layer-ID nein  

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
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.Access

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.AccessType

Einer von:

  • "allow"
  • "deny"

gws.types.AttributeType

Einer von:

  • "bool"
  • "bytes"
  • "date"
  • "datetime"
  • "float"
  • "floatlist"
  • "geometry"
  • "int"
  • "intlist"
  • "str"
  • "strlist"
  • "text"
  • "time"

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.GeometryType

Einer von:

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

gws.types.Point

Point coordinates [x, y]

gws.types.Regex

Regular expression, as used in Python

gws.types.StyleType

Einer von:

  • "css"
  • "cssSelector"

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.method.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 Access-Control-Allow-Credentials header nein false
allowHeaders [ str ] Access-Control-Allow-Headers header nein  
allowOrigin str Access-Control-Allow-Origin header 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