Services¶
QGIS Server is in staat gegevens te verstrekken overeenkomstog standaard protovollen zoals beschreven door het Open Geospatial Consortium (OGC):
WMS 1.1.0 en 1.3.0
WFS 1.0.0 en 1.1.0
WCS 1.1.1
WMTS 1.0.0
Extra parameters van de leverancier en verzoeken worden ondersteund in aanvulling op de originele standaard wat de mogelijkheden voor het aanpassen van het gedrag aanzienlijk verbeterd dankzij het programma voor renderen van QGIS.
Web Map Service (WMS)¶
De WMS standaarden 1.1.0 en 1.3.0, geïmplementeerd in QGIS Server, verschaffen een interface voor HTTP voor het verzoeken van kaart- of legendaafbeeldingen gegenereerd uit een project van QGIS. Een typisch WMS-verzoek definieert het te gebruiken project van QGIS, de te renderen lagen als ook de te genereren indeling van de afbeelding. Basisondersteuning is ook beschikbaar voor de standaard Styled Layer Descriptor (SLD).
Specificatiedocument overeenkomstig het versienummer van de service:
Standaard verzoeken verschaft door QGIS Server:
Verzoek |
Beschrijving |
---|---|
GetCapabilities |
Geef XML-metadata terug met informatie over de server |
GetMap |
Geef een kaart terug |
GetFeatureInfo |
Haal gegevens op (geometrie en waarden) voor de locatie van een pixel |
GetLegendGraphics |
Geeft symbolen voor legenda terug |
Leverancier-verzoeken verschaft door QGIS Server:
Verzoek |
Beschrijving |
---|---|
GetPrint |
Geeft een lay-out van QGIS terug |
GetProjectSettings |
Geeft specifieke informatie terug over QGIS Server |
GetMap¶
Standaard parameters voor het verzoek GetMap overeenkomstig de specificaties van OGC WMS 1.1.0 en 1.3.0:
Parameter |
Vereist |
Beschrijving |
---|---|---|
SERVICE |
Ja |
Naam van de service (WMS) |
VERSION |
Nee |
Versie van de service |
REQUEST |
Ja |
Naam van het verzoek (GetMap) |
LAYERS |
Nee |
Weer te geven lagen |
STYLES |
Nee |
Stijl van de laag |
SRS / CRS |
Ja |
Coördinaten referentiesysteem |
BBOX |
Nee |
Kaartbereik |
WIDTH |
Ja |
Breedte van de afbeelding in pixels |
HEIGHT |
Ja |
Hoogte van de afbeelding in pixels |
FORMAT |
Nee |
Indeling afbeelding |
TRANSPARENT |
Nee |
Transparante achtergrond |
In aanvulling op de standaard ondersteunt QGIS Server de volgende extra parameters:
Parameter |
Vereist |
Beschrijving |
---|---|---|
MAP |
Ja |
Specificeer het QGIS-projectbestand |
BGCOLOR |
Nee |
Specificeer de achtergrondkleur |
DPI |
Nee |
Specificeer de uitvoerresolutie |
IMAGE_QUALITY |
Nee |
JPEG-compressie |
OPACITIES |
Nee |
Doorzichtbaarheid van laag of groep |
FILTER |
Nee |
Subset van objecten |
SELECTION |
Nee |
Objecten accentueren |
FILE_NAME |
Nee |
Alleen voor Bestandsnaam van het gedownloade bestand |
FORMAT_OPTIONS |
Nee |
Alleen voor sleutel:waarde-paren, gescheiden door puntkomma.
|
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetMap
&MAP=/home/user/project.qgs
&LAYERS=mylayer1,mylayer2,mylayer3
&STYLES=style1,default,style3
&OPACITIES=125,200,125
&CRS=EPSG:4326
&WIDTH=400
&HEIGHT=400
&FORMAT=image/png
&TRANSPARENT=TRUE
&DPI=300
SERVICE¶
Deze parameter moet WMS
zijn in het geval van het verzoek GetMap.
VERSION¶
Deze parameter maakt het mogelijk de versie van de te gebruiken service te specificeren. Beschikbare waarden voor de parameter VERSION
zijn:
1.1.0
1.3.0
Indien geen versie wordt aangegeven in het verzoek , dan wordt 1.3.0
standaard gebruikt.
Overeenkomstig het versienummer kunnen kleine verschillen worden verwacht, zoals later uitgelegd, voor de volgende parameters:
CRS
/SRS
BBOX
REQUEST¶
Deze parameter is GetMap
in het geval van het verzoek GetMap.
LAYERS¶
Deze parameter maakt het mogelijk de weer te geven lagen op de kaart te specificeren. Namen moeten zijn gescheiden door een komma.
In aanvulling daarop introduceert QGIS Server enkele opties om op lagen te selecteren:
een verkorte naam
de laag-ID
De verkorte naam van een laag kan worden geconfigureerd via
in het menu Laag. Als de verkorte naam is gedefinieerd, dan wordt die standaard gebruikt in plaats van de naam van de laag:http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mynickname1,mynickname2
&...
Meer nog, er is een projectoptie die het mogelijk maakt lagen te selecteren op hun ID in het menu Laag-ID’s als namen gebruiken moet zijn geselecteerd om deze optie te activeren.
van het dialoogvenster . Het keuzevakhttp://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mylayerid1,mylayerid2
&...
STYLES¶
Deze parameter kan worden gebruikt om de stijl van een laag voor de stap renderen te specificeren. Stijlen moeten worden gescheiden door een komma. De naam van de standaard stijl is default
.
SRS / CRS¶
Deze parameter maakt het mogelijk de uitvoer Spatial Reference System van de kaart aan te geven in WMS 1.1.0 en moet zijn weergegeven als EPSG:XXXX
. Onthoud dat CRS
ook wordt ondersteund als de huidige versie 1.1.0 is.
Voor WMS 1.3.0 heeft de parameter CRS
de voorkeur maar SRS
wordt ook ondersteund.
Onthoud dat indien beide parameters CRS
en SRS
in het verzoek worden aangegeven, dan is het de huidige versie die wordt aangegeven de parameter VERSION
die beslissend is.
In het volgende geval wordt de parameter SRS
behouden, ongeacht de parameter VERSION
, omdat CRS
niet wordt aangegeven:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&SRS=EPSG:2854
&...
In het volgende geval wordt de parameter SRS
behouden in plaats van CRS
vanwege de parameter VERSION
:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.1.0
&CRS=EPSG:4326
&SRS=EPSG:2854
&...
In het volgende geval wordt de parameter CRS
behouden in plaats van SRS
vanwege de parameter VERSION
:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&CRS=EPSG:4326
&SRS=EPSG:2854
&...
BBOX¶
Deze parameter maakt het mogelijk het kaartbereik te specificeren in kaarteenheden overeenkomstig het huidige CRS. Coördinaten moeten worden gescheiden door een komma.
Echter een klein verschil dient te worden opgemerkt overenekomstig de huidige parameter VERSION
. Actueel, in WMS 1.1.0, worden coördinaten gevormd als minx,miny,maxx,maxy
of minlong,minlat,maxlong,maxlat
. Bijvoorbeeld:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.1.0
&SRS=epsg:4326
&BBOX=-180,-90,180,90
&...
Maar de as wordt omgekeerd in WMS 1.3.0, dus worden coördinaten gevormd als: miny,minx,maxy,maxx
of minlat,minlong,maxlat,maxlong
. Bijvoorbeeld:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&CRS=epsg:4326
&BBOX=-90,-180,90,180
&...
WIDTH¶
Deze parameter maakt het mogelijk de breedte van de uit te voeren afbeelding in pixels te specificeren.
HEIGHT¶
Deze parameter maakt het mogelijk de hoogte van de uit te voeren afbeelding in pixels te specificeren.
FORMAT¶
Deze parameter kan worden gebruikt om de indeling van de kaartafbeelding te specificeren. Beschikbare waarden zijn:
jpg
jpeg
image/jpeg
image/png
image/png; mode=1bit
image/png; mode=8bit
image/png; mode=16bit
application/dxf
Alleen lagen die leestoegang hebben in de WFS-service wordne geëxporteerd in de indeling DXF.Voorbeeld URL:
http://localhost/qgis_server? SERVICE=WMS&VERSION=1.3.0 &REQUEST=GetMap &FORMAT=application/dxf &LAYERS=Haltungen,Normschacht,Spezialbauwerke &STYLES= &CRS=EPSG%3A21781&BBOX=696136.28844801,245797.12108743,696318.91114315,245939.25832905 &WIDTH=1042 &HEIGHT=811 &FORMAT_OPTIONS=MODE:SYMBOLLAYERSYMBOLOGY;SCALE:250&FILE_NAME=plan.dxf
TRANSPARENT¶
Deze Booleaanse parameter kan worden gebruikt om de transparantie van de achtergrond te specificeren. Beschikbare waarden zijn (niet hoofdlettergevoelig):
TRUE
FALSE
Deze parameter wordt echter genegeerd indien de indeling van de kaart, aangegeven met FORMAT
, anders is dan PNG.
MAP¶
Deze parameter maakt het mogelijk het te gebruiken projectbestand van QGIS te definiëren.
Zoals vermeld in tabel parameters GetMap, is MAP
verplicht omdat een verzoek een project van QGIS nodig heeft om feitelijk te kunnen werken. Echter, de omgevingsvariabele QGIS_PROJECT_FILE``mag worden gebruikt om een standaard project voor QGIS te definiëren. In dit specifieke geval is ``MAP
niet langer een vereiste parameter. Voor meer informatie kunt u kijken naar Gevorderde configuratie.
BGCOLOR¶
Deze parameter maakt het mogelijk een kleur voor de achtergrond aan te geven voor de kaartafbeelding. Het kan echter niet worden gecombineerd met de parameter TRANSPARENT
in geval van afbeeldingen PNG (transparantie heeft prioriteit). De kleur mag letterlijk zijn of in hexadecimale notatie.
Voorbeeld URL met de letterlijke notatie:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&BGCOLOR=green
&...
Voorbeeld URL met de hexadecimale notatie:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&BGCOLOR=0x00FF00
&...
DPI¶
Deze parameter kan worden gebruikt om de resolutie voor de verzochte uitvoer te specificeren.
IMAGE_QUALITY¶
Deze parameter wordt alleen gebruikt voor afbeeldingen JPEG. Standaard is de compressie voor JPEG -1
.
U kunt de standaard per project van QGIS wijzigen in het menu GetMap
kunt u dat doen met behulp van de parameter IMAGE_QUALITY
.
OPACITIES¶
Doorzichtigheid kan worden ingesteld op niveau van de laag of van een groep. Toegestane waarden reiken van 0 (volledig transparant) tot en met 255 (ondoorzichtig).
FILTER¶
Subsets van lagen kunnen worden geselecteerd met de parameter FILTER. Syntaxis is in de basis hetzelfde als voor de subset tekenreeks voor QGIS . Er zijn echter enige beperkingen om SQL-injecties in de databases via QGIS Server te voorkomen. Als een gevaarlijke tekenreeks wordt gevonden in de parameter zal QGIS de volgende fout teruggeven
Indeed, text strings need to be enclosed with quotes (single quotes for strings, double quotes for attributes). A space between each word / special character is mandatory. Allowed Keywords and special characters are 'AND','OR','IN','=','<','>=','>','>=','!=*,'(',')'. Semicolons in string expressions are not allowed
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mylayer1,mylayer2
&FILTER=mylayer1:"OBJECTID" = 3;mylayer2:'text' = 'blabla'
&...
Notitie
Het is mogelijk zoekacties op attributen uit te voeren via GetFeatureInfo en de parameter X/Y weg te laten als een FILTER is ingesteld. QGIS Server geeft dan info terug over de overeenkomende objecten en genereert een gecombineerd begrenzingsvak in de uitvoer XML.
SELECTION¶
De parameter SELECTION
kan objecten accentueren van één of meer lagen. Vectorobjecten kunnen worden geselecteerd door middel van kommagescheiden lijsten met object-ID’s.
http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mylayer1,mylayer2
&SELECTION=mylayer1:3,6,9;mylayer2:1,5,6
&...
De volgende afbeelding laat het antwoord zien van een verzoek GetMap met behulp van de optie SELECTION
, bijv. http://myserver.com/...&SELECTION=countries:171,65
.
Omdat deze object-ID’s in de gegevensset van de bron corresponderen met Frankrijk en Roemenië zijn zij in geel geaccentueerd.
GetFeatureInfo¶
Standaard parameters voor het verzoek GetFeatureInfo overeenkomstig de specificaties van OGC WMS 1.1.0 en 1.3.0:
Parameter |
Vereist |
Beschrijving |
---|---|---|
SERVICE |
Ja |
Naam van de service (WMS) |
VERSION |
Nee |
|
REQUEST |
Ja |
|
LAYERS |
Nee |
|
STYLES |
Nee |
|
SRS / CRS |
Ja |
|
BBOX |
Nee |
|
WIDTH |
Ja |
|
HEIGHT |
Ja |
|
TRANSPARENT |
Nee |
|
INFO_FORMAT |
Nee |
Indeling uitvoer |
QUERY_LAYERS |
Ja |
Te bevragen lagen |
FEATURE_COUNT |
Nee |
Maximale aantal terug te geven objecten |
I |
Nee |
Pixelkolom van het te bevragen punt |
X |
Nee |
Hetzelfde als parameter I, maar in WMS 1.1.0 |
J |
Nee |
Pixelrij van het te bevragen punt |
Y |
Nee |
Hetzelfde als parameter J, maar in WMS 1.1.0 |
In aanvulling op de standaard ondersteunt QGIS Server de volgende extra parameters:
Parameter |
Vereist |
Beschrijving |
---|---|---|
MAP |
Ja |
|
FILTER |
Nee |
|
FI_POINT_TOLERANCE |
Nee |
Tolerantie in pixels voor puntlagen |
FI_LINE_TOLERANCE |
Nee |
Tolerantie in pixels voor lijnlagen |
FI_POLYGON_TOLERANCE |
Nee |
Tolerantie in pixels voor polygoonlagen |
FILTER_GEOM |
Nee |
Filteren van geometrie |
WITH_MAPTIP |
Nee |
Kaarttips toevoegen aan de uitvoer |
WITH_GEOMETRY |
Nee |
Geometrie toevoegen aan de uitvoer |
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetMap
&MAP=/home/user/project.qgs
&LAYERS=mylayer1,mylayer2,mylayer3
&CRS=EPSG:4326
&WIDTH=400
&HEIGHT=400
&INFO_FORMAT=text/xml
&TRANSPARENT=TRUE
&QUERY_LAYERS=mylayer1
&FEATURE_COUNT=3
&I=250
&J=250
INFO_FORMAT¶
Deze parameter kan worden gebruikt om de indeling van het resultaat te specificeren. Beschikbare waarden zijn:
text/xml
text/html
text/plain
application/vnd.ogc.gml
application/json
QUERY_LAYERS¶
Deze parameter specificeert de weer te geven lagen op de kaart. Namen moeten zijn gescheiden door een komma.
In aanvulling daarop introduceert QGIS Server enkele opties om op lagen te selecteren:
verkorte naam
laag-ID
Bekijk de paramater LAYERS
gedefinieerd in Bekijk GetMap voor meer informatie.
FEATURE_COUNT¶
Deze parameter specificeert het maximale aantal terug te geven objecten per laag. Als bijvoorbeeld QUERY_LAYERS
is ingesteld op laag1,laag2
en FEATURE_COUNT
is ingesteld op 3
dan zal een maximum van 3 objecten uit laag1 worden teruggegeven. Op dezelfde wijze zal een maximum van 3 objecten van laag2 worden teruggegeven.
Standaard wordt slechts 1 object per laag teruggegeven.
I¶
Deze parameter, gedefinieerd in WMS 1.3.0, stelt u in staat de pixelkolom van het te bevragen punt te specificeren.
X¶
Dezelfde parameter als I
, maar gedefinieerd in WMS 1.1.0
J¶
Deze parameter, gedefinieerd in WMS 1.3.0, stelt u in staat de pixelrij van het te bevragen punt te specificeren.
Y¶
Dezelfde parameter als J
, maar gedefinieerd in WMS 1.1.0
FI_POINT_TOLERANCE¶
Deze parameter specificeert de tolerantie in pixels voor puntlagen.
FI_LINE_TOLERANCE¶
Deze parameter specificeert de tolerantie in pixels voor lijnlagen.
FI_POLYGON_TOLERANCE¶
Deze parameter specificeert de tolerantie in pixels voor polygoonlagen.
FILTER_GEOM¶
Deze parameter specificeert een geometrie WKT waarmee objecten moeten kruisen.
WITH_MAPTIP¶
Deze parameter specificeert of kaarttips aan de uitvoer moeten worden toegevoegd.
Beschikbare waarden zijn (niet hoofdlettergevoelig):
TRUE
FALSE
WITH_GEOMETRY¶
Deze parameter specificeert of geometrieën aan de uitvoer moeten worden toegevoegd.
Beschikbare waarden zijn (niet hoofdlettergevoelig):
TRUE
FALSE
GetPrint¶
QGIS Server heeft de mogelijkheid om uitvoer van afdruklay-outs te maken in PDF- of pixelindeling. Vensters van afdruklay-outs in het gepubliceerde project worden als sjablonen gebruikt. In het verzoek GetPrint heeft de cliënt de mogelijkheid om parameters te specificeren van de opgenomen kaarten en labels.
Parameters voor het verzoek **GetPrint**zijn:
Parameter |
Vereist |
Beschrijving |
---|---|---|
MAP |
Ja |
Specificeer het QGIS-projectbestand |
SERVICE |
Ja |
Naam van de service (WMS) |
VERSION |
Nee |
|
REQUEST |
Ja |
Naam van het verzoek (GetPrint) |
LAYERS |
Nee |
|
TEMPLATE |
Ja |
Te gebruiken lay-outsjabloon |
SRS / CRS |
Ja |
|
FORMAT |
Ja |
Indeling uitvoer |
STYLES |
Nee |
|
TRANSPARENT |
Nee |
|
OPACITIES |
Nee |
|
SELECTION |
Nee |
|
mapX:EXTENT |
Nee |
Bereik van de kaart ‘X’ |
mapX:LAYERS |
Nee |
Lagen van de kaart ‘X’ |
mapX:STYLES |
Nee |
Stijl van de lagen van de kaart ‘X’ |
mapX:SCALE |
Nee |
Schaal van de lagen van de kaart ‘X’ |
mapX:ROTATION |
Nee |
Rotatie van de kaart ‘X’ |
mapX:GRID_INTERVAL_X |
Nee |
Raster-interval op de X-as van de kaart ‘X’ |
mapX:GRID_INTERVAL_Y |
Nee |
Raster-interval op de Y-as van de kaart ‘X’ |
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetPrint
&MAP=/home/user/project.qgs
&CRS=EPSG:4326
&FORMAT=png
&map0:EXTENT=-180,-90,180,90
&map0:LAYERS=mylayer1,mylayer2,mylayer3
&map0:OPACITIES=125,200,125
&map0:ROTATION=45
Onthoud dat de sjabloon van de lay-out meer kan bevatten dan één kaart. Op deze manier dient u, als u een specifieke kaart wilt configureren, parameters mapX:
te gebruiken, waar X
een positief getal is dat u kunt ophalen met het verzoek GetProjectSettings.
Bijvoorbeeld:
<WMS_Capabilities>
...
<ComposerTemplates xsi:type="wms:_ExtendedCapabilities">
<ComposerTemplate width="297" height="210" name="Druckzusammenstellung 1">
<ComposerMap width="171" height="133" name="map0"/>
<ComposerMap width="49" height="46" name="map1"/></ComposerTemplate>
</ComposerTemplates>
...
</WMS_Capabilities>
SERVICE¶
Deze parameter moet WMS
zijn.
REQUEST¶
Deze parameter moet GetPrint
zijn in het geval van het verzoek GetPrint.
TEMPLATE¶
Deze parameter kan worden gebruikt om de naam van een sjabloon van lay-out te specificeren voor het afdrukken.
FORMAT¶
Deze parameter specificeert de indeling van de kaartafbeelding. Beschikbare waarden zijn:
jpg
jpeg
image/jpeg
png
image/png
svg
image/svg
image/svg+xml
pdf
application/pdf
Als de parameter FORMAT
anders is dan een van deze waarden dan zal een uitzondering worden teruggegeven.
mapX:EXTENT¶
Deze parameter specificeert het bereik van een kaartitem van een lay-out als xmin,ymin,xmax,ymax.
mapX:ROTATION¶
Deze parameter specificeert de kaartrotatie in graden.
mapX:GRID_INTERVAL_X¶
Deze parameter specificeert de dichtheid van de rasterlijn in de richting X.
mapX:GRID_INTERVAL_Y¶
Deze parameter specificeert de dichtheid van de rasterlijn in de richting Y.
mapX:SCALE¶
Deze parameter specificeert de schaal voor de kaart voor een kaartitem van afdruklay-out. Dit is nuttig om te zorgen voor op schaal gebaseerde zichtbaarheid van de lagen en labels, zelfs als cliënt en server verschillende algoritmen hebben om de noemer voor de schaal te berekenen.
mapX:LAYERS¶
Deze parameter specificeert de lagen voor een kaartitem van lay-out. Bekijk Bekijk GetMap voor meer informatie over deze parameter.
mapX:STYLES¶
Deze parameter specificeert de stijlen voor de lagen voor een specifiek kaartitem van lay-out. Bekijk Bekijk GetMap voor meer informatie over deze parameter.
GetLegendGraphics¶
Verscheidene aanvullende parameters zijn beschikbaar om de grootte van de elementen van de Legenda te wijzigen:
BOXSPACE ruimte tussen frame van Legenda en inhoud (mm)
LAYERSPACE verticale ruimte tussen lagen (mm)
LAYERTITLESPACE verticale ruimte tussen titel van de laag en de daarop volgende items (mm)
SYMBOLSPACE verticale ruimte tussen symbool en daarop volgende item (mm)
ICONLABELSPACE horizontale ruimte tussen symbool en tekst voor label (mm)
SYMBOLWIDTH breedte van voorbeeld van het symbool (mm)
SYMBOLHEIGHT hoogte van het voorbeeld van het symbool (mm)
Deze parameters wijzigen de eigenschappen van het lettertype voor titels van lagen en labels van items:
LAYERFONTFAMILY / ITEMFONTFAMILY familie lettertype voor titel van laag / tekst van item
LAYERFONTBOLD / ITEMFONTBOLD
TRUE
om een vet lettertype te gebruikenLAYERFONTSIZE / ITEMFONTSIZE Grootte lettertype in punten
LAYERFONTITALIC / ITEMFONTITALIC
TRUE
om cursief lettertype te gebruikenLAYERFONTCOLOR / ITEMFONTCOLOR Hexadecimale kleurcode (bijv.
#FF0000
voor rood)LAYERTITLE / RULELABEL stel ze in op
FALSE
om alleen de afbeeldingen van de Legenda te verkrijgen, zonder labels
Op inhoud gebaseerde Legenda. Deze parameters laten de cliënt een legenda verzoeken die alleen de symbolen voor de objecten laat zien die binnen het verzochte gebied vallen:
BBOX het geografische gebied waarvoor de legenda zou moeten worden opgebouwd
CRS / SRS het gebruikte coördinaten referentiesysteem om de coördinaten voor de BBOX te definiëren
WIDTH / HEIGHT indien ingesteld zouden deze overeen moeten komen met die welke zijn gedefinieerd voor het verzoek GetMap, om QGIS Server symbolen te laten schalen overeenkomstig de afbeeldingsgrootte van de kaartweergave.
Op inhoud gebaseerde objecten voor Legenda zijn gebaseerd op de implementatie UMN MapServer:
SHOWFEATURECOUNT indien ingesteld op
TRUE
voegt het in de legenda het aantal objecten toe, zoals in de volgende afbeelding:
GetProjectSettings¶
Dit type verzoek werkt soortgelijk aan GetCapabilities, maar is meer specifiek voor QGIS Server en stelt een cliënt in staat om aanvullende informatie te lezen die niet beschikbaar is in de uitvoer van de GetCapabilities:
initiële zichtbaarheid van lagen
informatie over vectorattributen en hun typen bewerking
informatie over laagvolgorde en volgorde van tekenen
lijst van in WFS gepubliceerde lagen
Web Feature Service (WFS)¶
De WFS standaarden 1.0.0 en 1.1.0, geïmplementeerd in QGIS Server, verschaffen een interface voor HTTP voor het verzoeken van geografische objecten uit een project van QGIS. Een typisch WFS-verzoek definieert het te gebruiken project van QGIS, en de te bevragen laag.
Specificatiedocument overeenkomstig het versienummer van de service:
Standaard verzoeken verschaft door QGIS Server:
Verzoek |
Beschrijving |
---|---|
GetCapabilities |
Geeft XML-metadata terug met informatie over de server |
GetFeature |
Geeft een selectie van objecten terug |
DescribeFeatureType |
Geeft een beschrijving van typen objecten en eigenschappen terug |
Transaction |
Staat toe dat objecten worden ingevoegd, bijgewerkt of verwijderd |
GetFeature¶
Standaard parameters voor het verzoek GetFeature overeenkomstig de specificaties van OGC WFS 1.0.0 en 1.1.0:
Parameter |
Vereist |
Beschrijving |
---|---|---|
SERVICE |
Ja |
Naam van de service |
VERSION |
Nee |
Versie van de service |
REQUEST |
Ja |
Naam van het verzoek |
TYPENAME |
Nee |
Naam van de lagen |
OUTPUTFORMAT |
Nee |
Indeling uitvoer |
RESULTTYPE |
Nee |
Type resultaat |
PROPERTYNAME |
Nee |
Naam van de eigenschappen die moeten worden teruggegeven |
MAXFEATURES |
Nee |
Maximale aantal terug te geven objecten |
SRSNAME |
Nee |
Coördinaten referentiesysteem |
FEATUREID |
Nee |
Objecten filteren op ID |
FILTER |
Nee |
OGC codering filter |
BBOX |
Nee |
Kaartbereik |
SORTBY |
Nee |
Sorteer de resultaten |
In aanvulling op de standaard ondersteunt QGIS Server de volgende extra parameters:
Parameter |
Vereist |
Beschrijving |
---|---|---|
MAP |
Ja |
Specificeer het QGIS-projectbestand |
STARTINDEX |
Nee |
Paginanummer |
GEOMETRYNAME |
Nee |
Type terug te geven geometrie |
EXP_FILTER |
Nee |
Expressie filteren |
SERVICE¶
Deze parameter moet WFS
zijn in het geval van het verzoek GetFeature.
Bijvoorbeeld:
http://localhost/qgis_server?
SERVICE=WFS
&...
VERSION¶
Deze parameter maakt het mogelijk de versie van de te gebruiken service te specificeren. Beschikbare waarden voor de parameter VERSION
zijn:
1.0.0
1.1.0
Indien geen versie wordt aangegeven in het verzoek , dan wordt standaard 1.1.0
gebruikt.
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&...
REQUEST¶
Deze parameter is GetFeature
in het geval van het verzoek GetFeature.
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&...
RESULTTYPE¶
Deze parameter kan worden gebruikt om het terug te geven resultaat te specificeren. Beschikbare waarden zijn:
results
: het standaard gedraghits
: geeft alleen het aantal objecten terug
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&RESULTTYPE=hits
&...
GEOMETRYNAME¶
Deze parameter kan worden gebruikt om het terug te geven soort geometrie te specificeren. Beschikbare waarden zijn:
extent
centroid
none
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&GEOMETRYNAME=centroid
&...
STARTINDEX¶
Deze parameter is standaard in WFS 2.0, maar het is een uitbreiding voor WFS 1.0.0. In feite kan het gebruikt worden om enkele objecten in de resultaatset over te slaan en in combinatie met MAXFEATURES
, het verschaft de mogelijkheid door de resultaten te bladeren.
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&STARTINDEX=2
&...
Web Map Tile Service (WMTS)¶
De WMTS standaard 1.0.0, geïmplementeerd in QGIS Server, verschaft een interface voor HTTP voor het verzoeken van getegelde kaartafbeeldingen uit een project van QGIS. Een typisch WMTS-verzoek definieert het te gebruiken project van QGIS, enkele parameters voor WMS zoals te renderen lagen en ook parameters voor de tegels.
Specificatiedocument van de service:
Standaard verzoeken verschaft door QGIS Server:
Verzoek |
Beschrijving |
---|---|
GetCapabilities |
Geeft XML-metadata terug met informatie over de server |
GetTile |
Geeft een tegel terug |
GetFeatureInfo |
Haal gegevens op (geometrie en waarden) voor de locatie van een pixel |
GetCapabilities¶
Standaard parameters voor het verzoek GetCapabilities overeenkomstig de specificaties van OGC WMTS 1.0.0:
Parameter |
Vereist |
Beschrijving |
---|---|---|
SERVICE |
Ja |
Naam van de service (WMTS) |
REQUEST |
Ja |
Naam van het verzoek (GetCapabilities) |
In aanvulling op de standaard ondersteunt QGIS Server de volgende extra parameters:
Parameter |
Vereist |
Beschrijving |
---|---|---|
MAP |
Ja |
Specificeer het QGIS-projectbestand |
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetCapabilities
&MAP=/home/user/project.qgs
SERVICE¶
Deze parameter moet WMTS
zijn in het geval van het verzoek GetCapabilities.
REQUEST¶
Deze parameter is GetCapabilities
in het geval van het verzoek GetCapabilities.
MAP¶
Deze parameter maakt het mogelijk het te gebruiken projectbestand van QGIS te definiëren.
GetTile¶
Standaard parameters voor het verzoek GetTile overeenkomstig de specificaties van OGC WMTS 1.0.0:
Parameter |
Vereist |
Beschrijving |
---|---|---|
SERVICE |
Ja |
Naam van de service (WMTS) |
REQUEST |
Ja |
Naam van het verzoek (GetTile) |
LAYER |
Ja |
Identificatie laag |
FORMAT |
Ja |
Indeling uitvoer van de tegel |
TILEMATRIXSET |
Ja |
Naam van de piramide |
TILEMATRIX |
Ja |
Mazen |
TILEROW |
Ja |
Rijcoördinaat in de mazen |
TILECOL |
Ja |
Kolomcoördinaat in de mazen |
In aanvulling op de standaard ondersteunt QGIS Server de volgende extra parameters:
Parameter |
Vereist |
Beschrijving |
---|---|---|
MAP |
Ja |
Specificeer het QGIS-projectbestand |
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetTile
&MAP=/home/user/project.qgs
&LAYER=mylayer
&FORMAT=image/png
&TILEMATRIXSET=EPSG:4326
&TILEROW=0
&TILECOL=0
SERVICE¶
Deze parameter moet WMTS
zijn in het geval van het verzoek GetTile.
REQUEST¶
Deze parameter is GetTile
in het geval van het verzoek GetTile.
LAYER¶
Deze parameter maakt het mogelijk de op de tegel weer te geven laag te specificeren.
In aanvulling daarop introduceert QGIS Server enkele opties om lagen te selecteren op:
een verkorte naam
de laag-ID
De verkorte naam van een laag kan worden geconfigureerd via
in het menu Laag. Als de verkorte naam is gedefinieerd, dan wordt die standaard gebruikt in plaats van de naam van de laag:http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetTile
&LAYER=mynickname
&...
Meer nog, er is een projectoptie die het mogelijk maakt lagen te selecteren op hun ID in het menu Laag-ID’s als namen gebruiken moet zijn geselecteerd om deze optie te activeren.
van het dialoogvenster . Het keuzevakhttp://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetTile
&LAYER=mylayerid1
&...
FORMAT¶
Deze parameter kan worden gebruikt om de indeling van de tegelafbeelding te specificeren. Beschikbare waarden zijn:
jpg
jpeg
image/jpeg
image/png
Als de parameter FORMAT
anders is dan een van deze waarden dan zal in plaats daarvan de standaard indeling PNG worden gebruikt.
TILEMATRIXSET¶
Deze parameter maakt het mogelijk het te gebruiken CRS te definiëren om de onderliggende piramide te berekenen en moet worden gevormd als EPSG:XXXX
.
TILEMATRIX¶
Deze parameter maakt het mogelijk de te gebruiken matrix voor het uitvoerbestand te specificeren.
TILEROW¶
Deze parameter maakt het mogelijk de rij van de op te halen tegel in de matrix te selecteren.
TILECOL¶
Deze parameter maakt het mogelijk de kolom van de op te halen tegel in de matrix te selecteren.
MAP¶
Deze parameter maakt het mogelijk het te gebruiken projectbestand van QGIS te definiëren.
Zoals vermeld in tabel parameters GetMap, is MAP
verplicht omdat een verzoek een project van QGIS nodig heeft om feitelijk te kunnen werken. Echter, de omgevingsvariabele QGIS_PROJECT_FILE``mag worden gebruikt om een standaard project voor QGIS te definiëren. In dit specifieke geval is ``MAP
niet langer een vereiste parameter. Voor meer informatie kunt u kijken naar Gevorderde configuratie.
GetFeatureInfo¶
Standaard parameters voor het verzoek GetFeatureInfo overeenkomstig de specificaties van OGC WMTS 1.0.0:
Parameter |
Vereist |
Beschrijving |
---|---|---|
SERVICE |
Ja |
Naam van de service (WMTS) |
REQUEST |
Ja |
Naam van het verzoek (GetFeatureInfo) |
LAYER |
Ja |
Identificatie laag |
INFOFORMAT |
Nee |
Indeling uitvoer |
I |
Nee |
X-coördinaat van een pixel |
J |
Nee |
Y-coördinaat van een pixel |
TILEMATRIXSET |
Ja |
|
TILEMATRIX |
Ja |
|
TILEROW |
Ja |
|
TILECOL |
Ja |
In aanvulling op de standaard ondersteunt QGIS Server de volgende extra parameters:
Parameter |
Vereist |
Beschrijving |
---|---|---|
MAP |
Ja |
Specificeer het QGIS-projectbestand |
Voorbeeld URL:
http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetFeatureInfo
&MAP=/home/user/project.qgs
&LAYER=mylayer
&INFOFORMAT=image/html
&I=10
&J=5
SERVICE¶
Deze parameter moet WMTS
zijn in het geval van het verzoek GetFeatureInfo.
REQUEST¶
Deze parameter is GetFeatureInfo
in het geval van het verzoek GetFeatureInfo.
MAP¶
Deze parameter maakt het mogelijk het te gebruiken projectbestand van QGIS te definiëren.
Zoals vermeld in tabel parameters GetMap, is MAP
verplicht omdat een verzoek een project van QGIS nodig heeft om feitelijk te kunnen werken. Echter, de omgevingsvariabele QGIS_PROJECT_FILE``mag worden gebruikt om een standaard project voor QGIS te definiëren. In dit specifieke geval is ``MAP
niet langer een vereiste parameter. Voor meer informatie kunt u kijken naar Gevorderde configuratie.
LAYER¶
Deze parameter maakt het mogelijk de op de tegel weer te geven laag te specificeren.
In aanvulling daarop introduceert QGIS Server enkele opties om lagen te selecteren op:
een verkorte naam
de laag-ID
De verkorte naam van een laag kan worden geconfigureerd via
in het menu Laag. Als de verkorte naam is gedefinieerd, dan wordt die standaard gebruikt in plaats van de naam van de laag:http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetFeatureInfo
&LAYER=mynickname
&...
Meer nog, er is een projectoptie die het mogelijk maakt lagen te selecteren op hun ID in het menu Laag-ID’s als namen gebruiken moet zijn geselecteerd om deze optie te activeren.
van het dialoogvenster . Het keuzevakhttp://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetFeatureInfo
&LAYER=mylayerid1
&...
INFOFORMAT¶
Deze parameter kan worden gebruikt om de indeling van de uitvoer van het resultaat te definiëren. Beschikbare waarden zijn:
text/xml
text/html
text/plain
application/vnd.ogc.gml
De standaard waarde is text/plain
.
I¶
Deze parameter maakt het mogelijk de X-coördinaat van de pixel te definiëren waarvoor we de onderliggende informatie willen ophalen.
J¶
Deze parameter maakt het mogelijk de Y-coördinaat van de pixel te definiëren waarvoor we de onderliggende informatie willen ophalen.
Extra parameters ondersteund door alle typen verzoeken¶
parameter FILE_NAME : indien ingesteld zal het antwoord van de server direct naar de cliënt worden verzonden als bestandsbijlage met de gespecificeerde bestandsnaam.
parameter MAP: Soortgelijk aan MapServer kan de parameter
MAP
worden gebruikt om het pad naar het projectbestand van QGIS te specificeren. U kunt een absoluut pad specificeren of een pad relatief aan de locatie van het uitvoerbare bestand van de server (qgis_mapserv.fcgi
). Indien niet gespecificeerd zoekt QGIS Server naar .qgs-bestanden in de map waar het uit te voeren bestand voor de server is opgeslagen.Voorbeeld:
http://localhost/cgi-bin/qgis_mapserv.fcgi?\ REQUEST=GetMap&MAP=/home/qgis/mymap.qgs&...
Notitie
U kunt een QGIS_PROJECT_FILE definiëren als een omgevingsvariabele om het uitvoerende programma van de server te vertellen waar het projectbestand van QGIS kan worden gevonden. Deze variabele zal de locatie zijn waar QGIS zal zoeken naar het projectbestand. Indien niet gedefinieerd zal het de parameter MAP in het verzoek gebruiken en tenslotte zoeken in de map van het uitvoerende programma van de server.
REDLINING¶
Deze mogelijkheid is beschikbaar en kan worden gebruikt met verzoeken GetMap
, GetPrint
.
De mogelijkheid Redlining kan worden gebruikt om geometrieën en labels door te geven in het verzoek die door de server worden overlapt over de standaard teruggegeven afbeelding (kaart). Dit geeft de gebruiker de mogelijkheid om nadruk te leggen of misschien enkele opmerkingen (labels) toe te voegen aan sommige gebieden, locaties etc. die niet op de standaard kaart staan.
Het verzoek is in de indeling:
http://qgisplatform.demo/cgi-bin/qgis_mapserv.fcgi?map=/world.qgs&SERVICE=WMS&VERSION=1.3.0&
REQUEST=GetMap
...
&HIGHLIGHT_GEOM=POLYGON((590000 5647000, 590000 6110620, 2500000 6110620, 2500000 5647000, 590000 5647000))
&HIGHLIGHT_SYMBOL=<StyledLayerDescriptor><UserStyle><Name>Highlight</Name><FeatureTypeStyle><Rule><Name>Symbol</Name><LineSymbolizer><Stroke><SvgParameter name="stroke">%23ea1173</SvgParameter><SvgParameter name="stroke-opacity">1</SvgParameter><SvgParameter name="stroke-width">1.6</SvgParameter></Stroke></LineSymbolizer></Rule></FeatureTypeStyle></UserStyle></StyledLayerDescriptor>
&HIGHLIGHT_LABELSTRING=Write label here
&HIGHLIGHT_LABELSIZE=16
&HIGHLIGHT_LABELCOLOR=%23000000
&HIGHLIGHT_LABELBUFFERCOLOR=%23FFFFFF
&HIGHLIGHT_LABELBUFFERSIZE=1.5
Hier is de afbeelding die is uitgevoerd door het bovenstaande verzoek waarin een polygoon en een label zijn getekend bovenop de normale kaart:
U kunt zien dat er verscheidene parameters in dit verzoek staan:
HIGHLIGHT_GEOM: U kunt toevoegen POINT, MULTILINESTRING, POLYGON etc. Het ondersteunt meerdelige geometrieën. Hier is een voorbeeld:
HIGHLIGHT_GEOM=MULTILINESTRING((0 0, 0 1, 1 1))
. De coördinaten zouden in het CRS van het verzoek GetMap/GetPrint moeten zijn.HIGHLIGHT_SYMBOL: Dit beheert hoe de omtrek van de geometrie zal zijn en u kunt de breedte van de lijn, kleur en doorzichtbaarheid wijzigen.
HIGHLIGHT_LABELSTRING: U kunt de tekst voor uw labels doorgeven met deze parameter.
HIGHLIGHT_LABELSIZE: Deze parameter beheert de grootte van het label.
HIGHLIGHT_LABELCOLOR: Deze parameter beheert de kleur van het label.
HIGHLIGHT_LABELBUFFERCOLOR: Deze parameter beheert de kleur van de buffer van het label.
HIGHLIGHT_LABELBUFFERSIZE: Deze parameter beheert de grootte van de buffer van het label.
Externe WMS-lagen¶
QGIS Server staat het toe om lagen uit externe WMS-servers op te nemen in verzoeken WMS GetMap en WMS GetPrint. Dit is in het bijzonder nuttig als een webclient een externe achtergrondlaag in de webkaart gebruikt. Om redenen van uitvoering zouden dergelijke lagen direct moeten worden verzocht bij de webclient (niet gestapeld via QGIS server). Voor afdrukken echter zouden deze lagen moeten worden gestapeld via QGIS server om te kunnen verschijnen op de afgedrukte kaart.
Externe lagen kunnen worden toegevoegd aan de parameter LAYERS als EXTERNAL_WMS:<layername>. De parameters voor de externe WMS-lagen (bijv: URL, indeling, dpiMode, crs, lagen, stijlen) kunnen later worden opgegeven als parameters voor de service <layername>:<parameter>. In een verzoek GetMap zou dit er uit kunnen zien als:
http://localhost/qgis_server?
SERVICE=WMS&REQUEST=GetMap
...
&LAYERS=EXTERNAL_WMS:basemap,layer1,layer2
&STYLES=,,
&basemap:url=http://externalserver.com/wms.fcgi
&basemap:format=image/jpeg
&basemap:dpiMode=7
&basemap:crs=EPSG:2056
&basemap:layers=orthofoto
&basemap:styles=default
Soortgelijk kunnen externe lagen worden gebruikt in verzoeken GetPrint:
http://localhost/qgis_server?
SERVICE=WMS
...
&REQUEST=GetPrint&TEMPLATE=A4
&map0:layers=EXTERNAL_WMS:basemap,layer1,layer2
&map0:EXTENT=<minx,miny,maxx,maxy>
&basemap:url=http://externalserver.com/wms.fcgi
&basemap:format=image/jpeg
&basemap:dpiMode=7
&basemap:crs=EPSG:2056
&basemap:layers=orthofoto
&basemap:styles=default