Svarbu

Vertimas yra bendruomenės pastangos, prie kurių jūs galite prisijungti. Šis puslapis šiuo metu išverstas 86.33%.

3.2. Žiniatinklio žemėlapio paslauga (WMS)

QGIS Serveris palaiko 1.1.1 ir 1.3.0 WMS standartus, kurie teikia HTTP sąsają užklausoms žemėlapiui ar legendos piešiniams, sukurtiems pagal QGIS projektą. Tipinė WMS užklausa nurodo, kokį reikia naudoti QGIS projektą, kokius braižyti sluoksnius bei kokiu formatu pateikti piešinį. Taipogi yra bazinis Stilizuoto sluoksnio aprašymo (SLD) palaikymas.

Specifikacijos

• WMS 1.1.1

• WMS 1.3.0

• SLD 1.1.0 WMS profile

Standartinės QGIS Serverio teikiamos užklausos:

Užklausa	Aprašymas
GetCapabilities	Grąžina XML metaduomenis su informacija apie serverį
GetMap	Grąžina žemėlapį
GetFeatureInfo	Grąžina duomenis (geometriją ir reikšmes) pikselio vietai
GetLegendGraphic	Grąžina legendos simbolius
GetStyle(s)	Grąžina XML dokumentą su SLD stiliaus aprašymu
DescribeLayer	Grąžina informaciją apie WFS ir WCS prieinamumą atitinkamai vektoriniam ir rastro sluoksniams

Tiekėjo užklausos, kurias teikia QGIS Serveris:

Užklausa	Aprašymas
GetPrint	Grąžina QGIS išdėstymą
GetProjectSettings	Grąžina specifinę informaciją apie QGIS Serverį
GetSchemaExtension	Grąžina XML metaduomenis apie neprivalomas išplėstines galimybes

3.2.1. GetCapabilities

Standartiniai GetCapabilities užklausos parametrai pagal OGC WMS 1.1.1 ir 1.3.0 specifikacijas:

Parametras	Privalomas	Aprašymas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Užklausos pavadinimas (GetCapabilities)
VERSION	Ne	Paslaugos versija

GetCapabilities užklausa taipogi palaiko šiuos specifinius tiekėjo parametrus:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetCapabilities

3.2.2. GetMap

Standartiniai GetMap užklausos parametrai pagal OGC WMS 1.1.1 ir 1.3.0 specifikacijas:

Parametras	Privalomas	Aprašymas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Užklausos pavadinimas (GetMap)
VERSION	Taip	Paslaugos versija
LAYERS	Ne	Rodomi sluoksniai
STYLES	Ne	Sluoksnių stilius
SRS / CRS	Taip	Koordinačių atskaitos sistema
BBOX	Taip	Žemėlapio apimtis
WIDTH	Taip	Piešinio plotis pikseliais
HEIGHT	Taip	Piešinio aukštis pikseliais
FORMAT	Ne	Piešinio formatas
TRANSPARENT	Ne	Permatomas fonas
SLD	Ne	URL iki SLD, kurį reikia naudoti stiliui
SLD_BODY	Ne	Vietoje nurodytas SLD (XML), kurį reikia naudoti stiliui

Be standartinių, QGIS Serveris palaiko ir paryškinimą, išorinius WMS sluoksnius kaip ir šiuos papildomus parametrus:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas
BGCOLOR	Ne	Nurodykite fono spalvą
DPI	Ne	Nurodykite išvesties raišką
IMAGE_QUALITY	Ne	JPEG suspaudimas
OPACITIES	Ne	Sluoksnio ar grupės nepermatomumas
FILTER	Ne	Geoobjektų poaibis
SELECTION	Ne	Paryškinti geoobjektus
FILE_NAME	Ne	Atsiųsto failo pavadinimas Skirta tik FORMAT=application/dxf
FORMAT_OPTIONS	Ne	Nurodyto failo formato parinktys Skirta tik FORMAT=application/dxf
TILED	Ne	Dirbama kaladėlių režime

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetMap
&MAP=/home/qgis/projects/world.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
&TILED=TRUE

VERSION

Šis parametras leidžia nurodyti jūsų naudojamų paslaugų versiją. Tinkamos VERSION parametro reikšmės yra:

• 1.1.1

• 1.3.0

Priklausomai nuo versijos numerio, galima tikėtis nedidelių šių parametrų skirtumų, kaip aprašyta toliau:

• CRS / SRS

• BBOX

LAYERS

Šis parametras leidžia nurodyti, kuriuos sluoksnius reikia rodyti žemėlapyje. Vardus reikia atskirti kableliais.

Be to, QGIS Serveris pridėjo kelias parinktis, leidžiančias parinkti sluoksnius pagal:

• sluoksnio id: projekto parinktis, leidžianti parinkti sluoksnius naudojant jų id kortelėje QGIS Serveris ► WMS dialoge Projektas ► Savybės…. Įjunkite Naudoti sluoksnio id kaip pavadinimus, kad įgalintumėte šią parinktį.

• trumpą pavadinimą

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mylayerid1,mylayerid2
&...

STYLES

Šį parametrą galima naudoti, jei norite nurodyti sluoksnio stilių braižymo žingsniui. Stilius reikia atskirti kableliais. Numatytojo stiliaus pavadinimas yra default.

SRS / CRS

Šis parametras leidžia nurodyti išvesties žemėlapio erdvinės atskaitos sistemą WMS 1.1.1 ir turi būti suformuotas kaip EPSG:XXXX. Pastebėtina, kad jei versija yra 1.1.1, tai palaikomas ir parametras CRS.

WMS 1.3.0 atveju geriau naudoti parametrą CRS, bet palaikomas ir SRS.

Pastebėtina, kad jei užklausoje nurodyti abu CRS ir SRS parametrai, tai panaudojimas sprendžiamas pagal versiją, nurodytą VERSION parametre.

Tokiu atveju naudojamas SRS parametras nepriklausomai nuo parametro VERSION, nes nenurodytas CRS:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&SRS=EPSG:2854
&...

Tokiu atveju naudojamas SRS parametras vietoje CRS dėl VERSION parametro:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.1.1
&CRS=EPSG:4326
&SRS=EPSG:2854
&...

Tokiu atveju naudojamas``CRS`` parametras vietoje SRS dėl VERSION parametro:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&CRS=EPSG:4326
&SRS=EPSG:2854
&...

BBOX

Šis parametras leidžia nurodyti žemėlapio apimtį vienetais pagal dabartinį CRS. Koordinates reikia atskirti kableliais.

BBOX parametras formuojamas taip: min_a,min_b,max_a,max_b bet a ir b ašių apibrėžimas skiriasi priklausomai nuo naudojamo VERSION parametro:

• WMS 1.1.1 atveju ašių rikiuotė visada rytai/šiaurė

• WMS 1.3.0 atveju ašių rikiuoti priklauso nuo CRS

Pavyzdžiui EPSG:4326 ir WMS 1.1.1 atveju a yra ilguma (rytai), o b - platuma (šiaurė), taigi gauname tokią užklausą:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.1.1
&SRS=epsg:4326
&BBOX=-180,-90,180,90
&...

Bet WMS 1.3.0 atveju ašių rikiavimas apibrėžiamas EPSG duomenų bazėje yra šiaurė/rytai, taigi a yra platuma, o b ilguma:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&CRS=epsg:4326
&BBOX=-90,-180,90,180
&...

WIDTH

Šis parametras leidžia nurodyti išvesties piešinio plotį pikseliais.

HEIGHT

Šis parametras leidžia nurodyti išvesties piešinio aukštį pikseliais.

FORMAT

Šį parametrą galima naudoti žemėlapio piešinio formato nurodymui. Galimos reikšmės yra:

• jpg

• jpeg

• image/jpeg

• image/png

• image/png; mode=1bit

• image/png; mode=8bit

• image/png; mode=16bit

• image/webp

• application/dxf: tik sluoksniai, kurie turi skaitymo prieigą WFS paslaugoje eksportuojami į DXF formatą

• application/pdf

  URL pavyzdys:

  http://localhost/qgisserver?
  SERVICE=WMS&VERSION=1.3.0
  &REQUEST=GetMap
  &FORMAT=application/dxf
  &LAYERS=Haltungen,Normschacht,Spezialbauwerke
  &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

Šį loginį parametrą galima naudoti, kad nurodytumėte fono permatomumą. Galimos reikšmės yra (raidžių dydis nesvarbus):

• TRUE

• FALSE

Bet šis parametras ignoruojamas, jei formatas, kuris nurodytas FORMAT yra bet kas kitas nei PNG.

BGCOLOR

Šis parametras leidžia nurodyti žemėlapio piešinio fono spalvą. Bet jo negalima naudoti kartu su parametru TRANSPARENT, kai kuriami PNG piešiniai (permatomumas ima viršų). Spalva gali būti tekstas arba šešioliktainė notacija.

URL pavyzdys su tekstine notacija:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&BGCOLOR=green
&...

URL pavyzdys su šešioliktaine notacija:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&BGCOLOR=0x00FF00
&...

DPI

Šį parametrą galima naudoti nurodant užklausos išvesties raišką.

IMAGE_QUALITY

Šis parametras naudojamas tik JPEG piešiniams. Pagal nutylėjimą JPEG suspaudimo reikšmė yra -1.

Jūs galite pakeisti numatytąją reikšmę QGIS projekte per meniu OWS Serveris ► WMS galimybės, kurį rasite dialoge Projektas ► Savybės…. Jei norite permušti jį GetMap užklausoje, galite tai padaryti naudodami parametrą IMAGE_QUALITY.

OPACITIES

Kableliais atskirtos nepermatomumo reikšmės. Nepermatomumą galima nurodyti sluoksnio ar grupės lygmenyje. Galimos reikšmės yra nuo 0 (pilnai permatomas) iki 255 (pilnai nepermatomas).

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&WIDTH=400
&HEIGHT=200
&CRS=EPSG:4326
&LAYERS=countries,places
&BBOX=42,-6,52,15
&OPACITIES=255,0

Fig. 3.3 Kairėje OPACITIES=255,0 ir dešinėje OPACITIES=255,255

FILTER

Su parametru FILTER galima parinkti sluoksnių poaibį. Sintaksė yra iš principo tokia pati, kaip ir QGIS poaibio eilutė. Bet yra keli apribojimai, kad būtų išvengta SQL įterpimo į duomenų bazes per QGIS Serverį. Jei pavojinga eilutė bus aptikta parametre, QGIS Serveris grąžins tokią klaidą:

<ServiceExceptionReport>
  <ServiceException code="Security">The filter string XXXXXXXXX has been rejected because of security reasons.
  Note: Text strings have to be enclosed in single or double quotes. A space between each word / special character is mandatory.
  Allowed Keywords and special characters are IS,NOT,NULL,AND,OR,IN,=,<,=<,>,>=,!=,',',(,),DMETAPHONE,SOUNDEX.
  Not allowed are semicolons in the filter expression.</ServiceException>
</ServiceExceptionReport>

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&VERSION=1.3.0
&WIDTH=400
&HEIGHT=300
&CRS=EPSG:4326
&BBOX=41,-6,52,10
&LAYERS=countries_shapeburst,countries,places
&FILTER=countries_shapeburst,countries:"name" = 'France';places: "name" = 'Paris'

Fig. 3.4 Serverio atsakas į GetMap užklausą su FILTER parametru

Šiame pavyzdyje tas pats filtras "name" = 'France' taikomas sluoksniams countries ir countries_shapeburst, o filtras "name" = 'Paris' taikomas tik places.

Pastaba

Galima vykdyti atributų paiešką per GetFeatureInfo ir praleisti X/Y parametrą, jei yra FILTER. QGIS Serveris tada grąžina informaciją apie atitinkančius geoobjektus ir sukuria XML išvestyje apibendrintą apimties stačiakampį.

SELECTION

Parametras SELECTION gali paryškinti vieno ar kelių sluoksnių geoobjektus. Vektorinius geoobjektus galima parinkti perduodant kableliais atskirtus geoobjektų id.

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mylayer1,mylayer2
&SELECTION=mylayer1:3,6,9;mylayer2:1,5,6
&...

Šioje nuotraukoje vaizduojamas atsakas į GetMap užklausą su SELECTION parinktimi, pavyzdžiui http://myserver.com/...&SELECTION=countries:171,65.

Kadangi šie geoobjektų id priklauso Prancūzijai ir Rumunijai, jos ir paryškintos geltonai.

Fig. 3.5 Serverio atsakas į GetMap užklausą su SELECTION parametru

FORMAT_OPTIONS

Šį parametrą galima naudoti nurodant parinkto formato parinktis. Skirta tik GetMap užklausoms su FORMAT=application/dxf. Ima sąrašą raktas:reikšmė porų, atskirtų kableliais:

• SCALE: naudojamas simbologijos taisyklėms, filtrams ir stiliams (netaikomas patiems duomenims - duomenys lieka pradiniame mastelyje).

• MODE: atitinka eksporto parinkti, kurios siūlomos QGIS Darbastalio DXF eksporto dialoge. Galimos reikšmės yra NOSYMBOLOGY, FEATURESYMBOLOGY ir SYMBOLLAYERSYMBOLOGY.

• LAYERATTRIBUTES: nurodykite lauką ar kelių sluoksnių atveju kableliais atskirtą sąrašą laukų, kuriuose yra DXF sluoksnių pavadinimai - nenurodžius bus naudojami originalūs QGIS sluoksnių pavadinimai.

• USE_TITLE_AS_LAYERNAME: įjungus šią parinktį, sluoksnio antraštė bus naudojama kaip sluoksnio pavadinimas.

• CODEC: nurodykite naudojamą koduotę. Numatytoji yra ISO-8859-1, QGIS Darbastalio DXF eksporto dialoge galite sužinoti tinkamas reikšmes.

• NO_MTEXT: Užrašams naudoti TEXT vietoje MTEXT.

• FORCE_2D: Priverstinė 2D išvestis. Tai privaloma polilinijų pločiui.

TILED

Greitaveikos tikslais QGIS Serverį galima naudoti kaladėlių režime. Šiame režime klientas prašo kelių mažų fiksuoto dydžio kaladėlių ir susirenka jas į pilną žemėlapį. Tokiu atveju simboliai, kurie yra ant ribos ar netoli jos, gali atrodyti nukirpti, nes jie yra tik vienoje kaladėlėje.

Nustatykite parametro TILED reikšmę TRUE, kad nurodytumėte QGIS Serveriui dirbti kaladėlių režime ir taikyti Kaladėlių buferį, kuris sukonfigūruotas QGIS projekte (žr. Jūsų projekto konfigūravimas).

Kai TILED yra TRUE ir QGIS projekte sukonfigūruotas nenulinis kaladėlių buferis, geoobjektai už kaladėlės ribų yra braižomi, kad būtų išvengta nukirptų simbolių ties kaladėlių riba.

Numatytoji TILED reikšmė yra FALSE.

3.2.3. GetFeatureInfo

Standartiniai GetFeatureInfo užklausos parametrai pagal OGC WMS 1.1.1 ir 1.3.0 specifikacijas:

Parametras	Privalomas	Aprašymas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Užklausos pavadinimas (GetFeatureInfo)
VERSION	Ne	Paslaugos versija
QUERY_LAYERS	Taip	Užklausos sluoksniai
LAYERS	Taip	Rodomi sluoksniai (identiškai QUERY_LAYERS)
STYLES	Ne	Sluoksnių stilius
SRS / CRS	Taip	Koordinačių atskaitos sistema
BBOX	Ne	Žemėlapio apimtis
WIDTH	Taip	Piešinio plotis pikseliais
HEIGHT	Taip	Piešinio aukštis pikseliais
TRANSPARENT	Ne	Permatomas fonas
INFO_FORMAT	Ne	Išvesties formatas
FEATURE_COUNT	Ne	Maksimalus grąžinamų geoobjektų skaičius
I	Ne	Užklausiamo taško pikselių stulpelis
X	Ne	Tas pats, kas I parametras, bet WMS 1.1.1
J	Ne	Užklausiamo taško pikselių eilutė
Y	Ne	Tas pats, kas J parametras, bet WMS 1.1.1
WMS_PRECISION	Ne	Precizika (skaitmenų skaičius), kurią reikia naudoti grąžinant geometriją (žr. kaip pridėti geometriją į geoobjekto atsaką). Numatytoji reikšmė yra -1, tai reiškia, kad precizika yra nustatyta projekte.

Be standartinių, QGIS Serveris palaiko ir šiuos papildomus parametrus:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas
FILTER	Ne	Geoobjektų poaibis
FI_POINT_TOLERANCE	Ne	Taškų sluoksnių tolerancija pikseliais
FI_LINE_TOLERANCE	Ne	Linijų sluoksnių tolerancija pikseliais
FI_POLYGON_TOLERANCE	Ne	Poligonų sluoksnių tolerancija pikseliais
FILTER_GEOM	Ne	Geometrijos filtravimas
WITH_DISPLAY_NAME	Ne	Pridėti į išvestį geometrijos rodomą pavadinimą
WITH_MAPTIP	Ne	Pridėti į išvestį žemėlapio patarimus
WITH_GEOMETRY	Ne	Pridėti į išvestį geometriją

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetMap
&MAP=/home/qgis/projects/world.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

Šį parametrą galima naudoti, jei reikia nurodyti rezultato formatą. Galimos reikšmės yra:

• text/xml

• text/html

• text/plain

• application/vnd.ogc.gml

• application/json

QUERY_LAYERS

Šis parametras nurodo žemėlapyje rodomus sluoksnius. Pavadinimai atskiriami kableliais.

Papildomai QGIS Serveris prideda parinktis parinkti sluoksnius pagal:

• trumpą pavadinimą

• sluoksnio id

Daugiau informacijos rasite prie parametro LAYERS, kuris apibrėžtas GetMap.

FEATURE_COUNT

Šis parametras nurodo maksimalų grąžinama sluoksnio geoobjektų skaičių. Pavyzdžiui jei QUERY_LAYERS nurodyta sluoksnis1,sluoksnis2 ir FEATURE_COUNT nurodyta 3, tai iš sluoksnis1 bus grąžinti daugiausiai 3 geoobjektai. Atitinkamai ir iš sluoksnis2 bus grąžinta ne daugiau 3 geoobjektų.

Pagal nutylėjimą grąžinamas tik vienas sluoksnio geoobjektas.

I

Šis WMS 1.3.0 apibrėžtas parametras leidžia nurodyti užklausos taško pikselio stulpelį.

X

Toks pat parametras kaip I, tik apibrėžtas WMS 1.1.1.

J

Šis WMS 1.3.0 apibrėžtas parametras leidžia nurodyti užklausos taško pikselio eilutę.

Y

Toks pat parametras kaip J, tik apibrėžtas WMS 1.1.1.

FI_POINT_TOLERANCE

Šis parametras nurodo taškų sluoksnio pikselių toleranciją.

FI_LINE_TOLERANCE

Šis parametras nurodo linijų sluoksnio pikselių toleranciją.

FI_POLYGON_TOLERANCE

Šis parametras nurodo poligonų sluoksnio pikselių toleranciją.

FILTER_GEOM

Šis parametras nurodo WKT geometriją, su kuria geoobjektai turi kirstis.

WITH_DISPLAY_NAME

Šis parametras nurodo, ar reikia pridėti į išvestį geoobjekto rodomą pavadinimą.

Galimos reikšmės yra (raidžių dydis nėra svarbus):

• TRUE

• FALSE

WITH_MAPTIP

Šis parametras nurodo, ar reikia į išvestį pridėti žemėlapio patarimus.

Galimos reikšmės yra (raidžių dydis nėra svarbus):

• TRUE

• FALSE

• HTML_FI_ONLY_MAPTIP: kaip TRUE, su tokiu skirtumu, kad geoobjekto informacijos užklauso HTML atsake yra žemėlapio patarimas. Tai leidžia pilnai valdyti HTML atsaką naudojant pavyzdžiui įstatytą sluoksnių žemėlapio patarimo redaktorių.

WITH_GEOMETRY

Šis parametras nurodo, ar reikia į išvestį pridėti geometrijas. Norint naudoti šią savybę, jūs turite visų pirma įjungti QGIS projekte parinktį Pridėti geometriją į geoobjekto atsaką. Žr. Konfigūruoti jūsų projektą.

Galimos reikšmės yra (raidžių dydis nėra svarbus):

• TRUE

• FALSE

3.2.4. GetLegendGraphic

Standartiniai GetLegendGraphic užklausos parametrai pagal OGC WMS 1.1.1 ir 1.3.0 specifikacijas:

Parametras	Privalomas	Aprašymas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Užklausos pavadinimas (GetLegendGraphic)
VERSION	Ne	Paslaugos versija
LAYERS	Taip	Rodomi sluoksniai
STYLES	Ne	Sluoksnių stilius
SRS / CRS	Ne	Koordinačių atskaitos sistema
BBOX	Ne	Žemėlapio apimtis
WIDTH	Ne	Piešinio plotis pikseliais
HEIGHT	Ne	Piešinio aukštis pikseliais
FORMAT	Ne	Legendos formatas
TRANSPARENT	Ne	Permatomas fonas

Be standartinių, QGIS Serveris palaiko papildomus parametrus, leidžiančius keisti legendos elementų dydžius ar sluoksnio antraštės ir elementų užrašų šrifto savybes:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas
SRCWIDTH	Ne	Žemėlapio plotis
SRCHEIGHT	Ne	Žemėlapio aukštis
SHOWFEATURECOUNT	Ne	Pridėti geoobjektų skaičių
RULE	Ne	Braižomas taisyklės simbolis
RULELABEL	Ne	Elementų užrašų braižymas
BOXSPACE	Ne	Tarpas tarp legendos rėmo ir turinio (mm)
LAYERSPACE	Ne	Vertikalus tarpas tarp sluoksnių (mm)
LAYERTITLESPACE	Ne	Vertikalus tarpas tarp sluoksnio antraštės ir elementų (mm)
SYMBOLSPACE	Ne	Vertikalus tarpas tarp simbolio ir elementų (mm)
ICONLABELSPACE	Ne	Horizontalus tarpas tarp simbolio ir užrašo (mm)
SYMBOLWIDTH	Ne	Simbolio peržiūros plotis (mm)
SYMBOLHEIGHT	Ne	Simbolio peržiūros aukštis (mm)
LAYERTITLE	Ne	Braižymo sluoksnio antraštė
LAYERFONTFAMILY	Ne	Sluoksnio šriftų šeima
LAYERFONTBOLD	Ne	Sluoksnio antraštės riebus braižymas
LAYERFONTSIZE	Ne	Sluoksnio antraštės šrifto dydis (pt)
LAYERFONTITALIC	Ne	Sluoksnio antraštės pasviręs braižymas
LAYERFONTCOLOR	Ne	Sluoksnio antraštės spalva
ITEMFONTFAMILY	Ne	Elemento šrifto šeima
ITEMFONTBOLD	Ne	Elemento užrašo riebus braižymas
ITEMFONTSIZE	Ne	Elemento užrašo šrifto dydis (pt)
ITEMFONTITALIC	Ne	Elemento užrašo pasviręs braižymas
ITEMFONTCOLOR	Ne	Elemento užrašo spalva
SHOWRULEDETAILS	Ne	Prideda į JSON išvestį taisyklės tekstą
ADDLAYERGROUPS	Ne	Prideda į JSON išvestį sluoksnio grupes

BBOX

Šį parametrą galima naudoti, norint nurodyti geografinį plotą, kurio legendą reikia kurti (jo formatas aprašytas čia), bet jo negalima naudoti kartu su parametru RULE. Parametras SRS/CRS tampa privalomu, kai naudojamas BBOX parametras.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=countries,airports
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326

Pastaba

Kai nurodomas BBOX parametras, legenda laikoma nuo turinio priklausanti legenda.

WIDTH

Šis parametras pagal nutylėjimą nėra naudojamas, bet tampa privalomu, kai nurodytas parametras RULE. Tokiu atveju jis leidžia nurodyti išvesties piešinio plotį pikseliais.

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=getlegendgraphic
&LAYER=testlayer%20%C3%A8%C3%A9
&RULE=rule1
&WIDTH=30
&HEIGHT=30

HEIGHT

Šis parametras pagal nutylėjimą nėra naudojamas, bet tampa privalomu, kai nurodytas parametras RULE. Tokiu atveju jis leidžia nurodyti išvesties piešinio aukštį pikseliais.

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYER=testlayer%20%C3%A8%C3%A9
&RULE=rule1
&WIDTH=30
&HEIGHT=30

FORMAT

Šį parametrą galima naudoti, norint nurodyti legendos piešinio formatą. Galimos reikšmės yra:

• image/jpeg

• image/png

• application/json

JSON atveju simboliai koduojami naudojant Base64 ir į dauguma kitų parinkčių, susijusių su išdėstymu ar šriftais, neatsižvelgiama, nes legenda kuriama kliento pusėje. Parametro RULE negalima naudoti kartu su šiuo formatu.

URL pavyzdys su atitinkama JSON išvestimi:

http://localhost/qgisserver?
SERVICE=WMS&
REQUEST=GetLegendGraphic&
LAYERS=airports&
FORMAT=application/json

Ir atitinkanti JSON išvestis:

{
  "nodes":[
    {
      "icon":"<base64 icon>",
      "title":"airports",
      "type":"layer"
    }
  ],
  "title":""
}

SRCWIDTH

Šį parametrą galima naudoti, kai nustatytas parametras RULE. Tokiu atveju SRCWIDTH` reikšmė perduodama į atitinkamą GetMap užklausą kaip WIDTH parametras, o GetLegendGraphic WIDTH parametras naudojamas piešinio legendos dydžiui.

SRCHEIGHT

Šį parametrą galima naudoti, kai nustatytas parametras RULE. Tokiu atveju SRCHEIGHT` reikšmė perduodama į atitinkamą GetMap užklausą kaip HEIGHT parametras, o GetLegendGraphic HEIGHT parametras naudojamas piešinio legendos dydžiui.

SHOWFEATURECOUNT

Šį parametrą galima naudoti, norint aktyvuoti geoobjektų skaičių legendoje. Galimos reikšmės yra (raidžių dydis nesvarbus):

• TRUE

• FALSE

Pavyzdžiui:

RULE

Šis parametras tinka sluoksniams, kurie turi Nuo taisyklių priklausomą braižymą ir leidžia kurti legendą tik su nurodytos taisyklės simboliu. Jo negalima naudoti kartu su BBOX parametru. Turi būti nurodyti HEIGHT ir WIDTH.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=mylayer,
&RULE=myrulename,
&WIDTH=20,
&HEIGHT=20

RULELABEL

Šis parametras leidžia valgyti elementų užrašų braižymą. Galimos reikšmės yra (raidžių dydis nesvarbus):

• TRUE: rodyti elemento užrašą

• FALSE: slėpti elemento užrašą

• AUTO: slėpti elemento užrašą sluoksniams su Vieno simbolio braižymu

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=countries,airports
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&RULELABEL=AUTO

Fig. 3.6 Legendos braižymas be užrašo vieno simbolio sluoksniams

BOXSPACE

Šis parametras leidžia nurodyti tarpą milimetrais tarp legendos rėmo ir turinio. Pagal nutylėjimą šis tarpas lygus 2 mm.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&BOXSPACE=0

Fig. 3.7 Kairėje BOXSPACE=0, o dešinėje BOXSPACE=15

LAYERSPACE

Šis parametras leidžia nurodyti vertikalų atstumą milimetrais tarp sluoksnių. Pagal nutylėjimą šis atstumas yra 3 mm.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&LAYERSPACE=0

Fig. 3.8 Kairėje LAYERSPACE=0, o dešinėje LAYERSPACE=10

LAYERTITLESPACE

Šis parametras leidžia nurodyti vertikalų atstumą milimetrais tarp sluoksnio antraštės ir po jos einančių elementų. Pagal nutylėjimą šis atstumas yra 3 mm.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&LAYERTITLESPACE=0

Fig. 3.9 Kairėje LAYERTITLESPACE=0, o dešinėje LAYERTITLESPACE=10

SYMBOLSPACE

Šis parametras leidžia nurodyti vertikalų atstumą milimetrais tarp simbolio ir po jos einančio elemento. Pagal nutylėjimą šis atstumas yra 2 mm.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=countries
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&SYMBOLSPACE=0

Fig. 3.10 Kairėje SYMBOLSPACE=0, o dešinėje SYMBOLSPACE=5

ICONLABELSPACE

Šis parametras leidžia nurodyti vertikalų atstumą milimetrais tarp simbolio ir užrašo teksto. Pagal nutylėjimą šis atstumas yra 2 mm.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=getlegendgraphic
&LAYERS=countries,
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&ICONLABELSPACE=0

Fig. 3.11 Kairėje ICONLABELSPACE=0, o dešinėje ICONLABELSPACE=10

SYMBOLWIDTH

This parameter allows to specify the width of the symbol preview in millimeters. By default the width value is 7 mm.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=countries,
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&SYMBOLWIDTH=2

Fig. 3.12 To the left SYMBOLWIDTH=2 and to the right SYMBOLWIDTH=20

SYMBOLHEIGHT

This parameter allows to specify the height of the symbol preview in millimeters. By default the height value is 4 mm.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=countries,
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&SYMBOLHEIGHT=2

Fig. 3.13 To the left SYMBOLHEIGHT=2 and to the right SYMBOLHEIGHT=6

LAYERTITLE

This parameter specifies whether to render layer title.

Galimos reikšmės yra (raidžių dydis nėra svarbus):

• TRUE (default value)

• FALSE

LAYERFONTFAMILY

This parameter specifies the font family to use for rendering layer title.

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=countries
&LAYERFONTFAMILY=monospace

LAYERFONTBOLD

This parameter specifies whether the layer title is rendered in bold. Available values are (not case sensitive):

• TRUE

• FALSE

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&LAYERFONTBOLD=TRUE

Fig. 3.14 Legend with LAYERFONTBOLD=TRUE

LAYERFONTSIZE

This parameter specifies the font size for rendering layer title in point.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&LAYERFONTSIZE=20

Fig. 3.15 Legend with LAYERFONTSIZE=20

LAYERFONTITALIC

This parameter specifies whether the layer title is rendered in italic. Available values are (not case sensitive):

• TRUE

• FALSE

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&LAYERFONTITALIC=TRUE

Fig. 3.16 Legend with LAYERFONTITALIC=TRUE

LAYERFONTCOLOR

This parameter specifies the layer title color. The color may be literal (red, green, ..) or in hexadecimal notation (0xFF0000, 0x00FF00, …).

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&LAYERFONTCOLOR=0x5f9930

Fig. 3.17 Legend with LAYERFONTCOLOR=0x5f9930

ITEMFONTFAMILY

This parameter specifies the font family to use for rendering item label.

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=countries
&ITEMFONTFAMILY=monospace

ITEMFONTBOLD

This parameter specifies whether the item label is rendered in bold. Available values are (not case sensitive):

• TRUE

• FALSE

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&ITEMFONTBOLD=TRUE

Fig. 3.18 Legend with ITEMFONTBOLD=TRUE

ITEMFONTSIZE

This parameter specifies the font size for rendering layer title in point.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&ITEMFONTSIZE=20

Fig. 3.19 Legend with ITEMFONTSIZE=30

ITEMFONTITALIC

This parameter specifies whether the item label is rendered in italic. Available values are (not case sensitive):

• TRUE

• FALSE

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&ITEMFONTITALIC=TRUE

Fig. 3.20 Legend with ITEMFONTITALIC=TRUE

ITEMFONTCOLOR

This parameter specifies the item label color. The color may be literal (red, green, ..) or in hexadecimal notation (0xFF0000, 0x00FF00, …).

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetLegendGraphic
&LAYERS=airports,places
&BBOX=43.20,-2.93,49.35,8.32
&CRS=EPSG:4326
&TRANSPARENT=TRUE
&ITEMFONTCOLOR=0x5f9930

Fig. 3.21 Legend with ITEMFONTCOLOR=0x5f9930

SHOWRULEDETAILS

This parameter specifies if the JSON output will also contain the details about the rule that generated the legend entry. This parameter only has effect when the renderer is rule-based or categorized.

URL pavyzdys su atitinkama JSON išvestimi:

http://localhost/qgisserver?
SERVICE=WMS&
REQUEST=GetLegendGraphic&
LAYERS=airports&
FORMAT=application/json&
SHOWRULEDETAILS=TRUE

Ir atitinkanti JSON išvestis:

{
  "nodes":[
    {
      "icon":"<base64 icon>",
      "title":"airports",
      "type":"layer",
      "rule": "type = 'airport'"
    }
  ],
  "title":""
}

ADDLAYERGROUPS

This parameter specifies if the JSON output will also display the names of the layers groups (and subgroups) in the legend entry. Possible values are:

• TRUE: display the groups labels

• FALSE (default): hide the groups labels

Fig. 3.22 Legend without (left) and with (right) layer groups labels display

The corresponding JSON output showing groups name would look like:

{ "nodes":
  [{ "nodes":
     [{ "icon":"iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAUklEQVQ4jWNgGAXDHzASUqCsrPwfmX/37l28evBKKisr/0+a7IMiNi93C15DcUpgM4wYQ5nwuZAcMIQNvHv3LuO83C0kG0hysoFZRrJNo2AYAQC87BpkGQj1fwAAAABJRU5ErkJggg==",
        "title":"layer_a", "type":"layer"
     },
     { "nodes":
       [{ "icon":"iVBORw0KGgoAAAANSUhEUgAAABMAAAAUCAYAAABvVQZ0AAAACXBIWXMAABYlAAAWJQFJUiTwAAAAHUlEQVQ4jWNgGAWjYCQDxh887r8G2hGjYBQMGAAA1x0CR0FzIkYAAAAASUVORK5CYII=",
          "title":"layer_b", "type":"layer"
        },
        { "icon":"iVBORw0KGgoAAAANSUhEUgAAABMAAAAUCAYAAABvVQZ0AAAACXBIWXMAABYlAAAWJQFJUiTwAAAAHUlEQVQ4jWNgGAWjYCQDxtmzZ/8aaEeMglEwYAAAaIoCzTtn5XoAAAAASUVORK5CYII=",
          "title":"layer_c", "type":"layer"
       }],
       "title":"lines", "type":"group"
     },
     { "icon":"iVBORw0KGgoAAAANSUhEUgAAABMAAAATCAYAAAByUDbMAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAKklEQVQ4jWNUVlX/z0AlwMLAwMDAnXmQKoYxUcWUUcNGDRs1bNSwYWYYACXDAsvQaTuVAAAAAElFTkSuQmCC",
       "title":"layer_d", "type":"layer"
     }],
     "title":"top-level-group", "type":"group"
  }],
  "title":""
}

3.2.5. GetStyle(s)

Standard parameters for the GetStyle (or GetStyles) request according to the OGC WMS 1.1.1 specifications:

Parametras	Privalomas	Aprašymas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Name of the request (GetStyle or GetStyles)
LAYERS	Taip	Užklausos sluoksniai

The GetStyle request supports as well the following vendor parameters:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetStyles
&LAYERS=mylayer1,mylayer2

3.2.6. DescribeLayer

Standard parameters for the DescribeLayer request according to the OGC WMS 1.1.1 and 1.3.0 specifications:

Parametras	Privalomas	Aprašymas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Name of the request (DescribeLayer)
LAYERS	Taip	Layers to describe
SLD_VERSION	Taip	SLD version

The DescribeLayer request supports as well the following vendor parameters:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=DescribeLayer
&SLD_VERSION=1.1.0
&LAYERS=mylayer1

The XML document looks like:

<DescribeLayerResponse xmlns="http://www.opengis.net/sld" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ows="http://www.opengis.net/ows" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:se="http://www.opengis.net/se" xsi:schemaLocation="http://www.opengis.net/sld http://schemas.opengis.net/sld/1.1.0/DescribeLayer.xsd">
    <Version>1.1.0</Version>
    <LayerDescription>
        <owsType>wfs</owsType>
        <se:OnlineResource xlink:href="http://localhost/qgisserver" xlink:type="simple"/>
        <TypeName>
            <se:FeatureTypeName>my_vector_layer</se:FeatureTypeName>
        </TypeName>
    </LayerDescription>
    <LayerDescription>
        <owsType>wcs</owsType>
        <se:OnlineResource xlink:href="http://localhost/qgisserver" xlink:type="simple"/>
        <TypeName>
            <se:FeatureTypeName>my_raster_layer</se:FeatureTypeName>
        </TypeName>
    </LayerDescription>
</DescribeLayerResponse>

SLD_VERSION

This parameter allows to specify the version of SLD. Only the value 1.1.0 is available.

3.2.7. GetPrint

QGIS Server has the capability to create print layout output in pdf or pixel format. Print layout windows in the published project are used as templates. In the GetPrint request, the client has the possibility to specify parameters of the contained layout maps and labels.

GetPrint užklausos palaiko paryškinimą, išorinius WMS sluoksnius bei šiuos parametrus:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Name of the request (GetPrint)
VERSION	Ne	Paslaugos versija
LAYERS	Ne	Rodomi sluoksniai
TEMPLATE	Taip	Layout template to use
SRS / CRS	Taip	Koordinačių atskaitos sistema
FORMAT	Ne	Išvesties formatas
FORMAT_OPTIONS	Ne	Nurodyto failo formato parinktys Only for FORMAT=application/pdf
ATLAS_PK	Ne	Atlas features
STYLES	Ne	Sluoksnių stilius
TRANSPARENT	Ne	Permatomas fonas
OPACITIES	Ne	Sluoksnio ar grupės nepermatomumas
SELECTION	Ne	Paryškinti geoobjektus
mapX:EXTENT	Ne	Extent of the map ‚X‘
mapX:LAYERS	Ne	Layers of the map ‚X‘
mapX:STYLES	Ne	Layers‘ style of the map ‚X‘
mapX:SCALE	Ne	Layers‘ scale of the map ‚X‘
mapX:ROTATION	Ne	Rotation of the map ‚X‘
mapX:GRID_INTERVAL_X	Ne	Grid interval on x axis of the map ‚X‘
mapX:GRID_INTERVAL_Y	Ne	Grid interval on y axis of the map ‚X‘

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetPrint
&MAP=/home/qgis/projects/world.qgs
&CRS=EPSG:4326
&FORMAT=png
&TEMPLATE=Layout%201
&map0:EXTENT=-180,-90,180,90
&map0:LAYERS=mylayer1,mylayer2,mylayer3
&map0:OPACITIES=125,200,125
&map0:ROTATION=45

Note that the layout template may contain more than one map. In this way, if you want to configure a specific map, you have to use mapX: parameters where X is a positive number that you can retrieve thanks to the GetProjectSettings request.

Pavyzdžiui:

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

TEMPLATE

This parameter can be used to specify the name of a layout template to use for printing.

FORMAT

This parameter specifies the format of map image. Available values are:

• png (default value)

• image/png

• jpg

• jpeg

• image/jpeg

• svg

• image/svg

• image/svg+xml

• pdf

• application/pdf

If the FORMAT parameter is different from one of these values, then an exception is returned.

FORMAT_OPTIONS

This parameter can be used to specify options for the selected format. Only for FORMAT=application/pdf in GetPrint requests. Takes a list of key:value pairs separated by semicolon:

• RASTERIZE_WHOLE_IMAGE: whether the whole pdf should be exported as an image. Default: false.

• FORCE_VECTOR_OUTPUT: whether pdf should be exported as vector. Default: false.

• APPEND_GEOREFERENCE: whether georeference info shall be added to the pdf. Default: true.

• EXPORT_METADATA: whether metadata shall be added to the pdf. Default: true.

• TEXT_RENDER_FORMAT: sets the text render format for pdf export. It can be AlwaysOutlines (default) or AlwaysText.

• SIMPLIFY_GEOMETRY: whether features geometries shall be simplified. Default: true.

• WRITE_GEO_PDF: whether a Geospatial PDF shall be exported. Default: false.

• USE_ISO_32000_EXTENSION_FORMAT_GEOREFERENCING: whether Iso32000 georeferencing shall be used. Default: false.

• USE_OGC_BEST_PRACTICE_FORMAT_GEOREFERENCING: whether OGC best practice georeferencing shall be used. Default: false.

• EXPORT_THEMES: a comma separated list of map themes to use for a Geospatial PDF export

• PREDEFINED_MAP_SCALES: a comma separated list of map scales to render the map

• LOSSLESS_IMAGE_COMPRESSION: whether images embedded in pdf must be compressed using a lossless algorithm. Default: false.

• DISABLE_TILED_RASTER_RENDERING: whether rasters shall be untiled in the pdf. Default: false.

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetPrint
&MAP=/home/qgis/projects/world.qgs
&CRS=EPSG:4326
&FORMAT=pdf
&TEMPLATE=Layout%201
&FORMAT_OPTIONS=FORCE_VECTOR_OUTPUT:TRUE;TEXT_RENDER_FORMAT:AlwaysOutlines;PREDEFINED_MAP_SCALES:250

ATLAS_PK

This parameter allows activation of Atlas rendering by indicating which features we want to print. In order to retrieve an atlas with all features, the * symbol may be used (according to the maximum number of features allowed in the project configuration).

When FORMAT is pdf, a single PDF document combining the feature pages is returned. For all other formats, a single page is returned.

mapX:EXTENT

This parameter specifies the extent for a layout map item as xmin,ymin,xmax,ymax.

mapX:ROTATION

This parameter specifies the map rotation in degrees.

mapX:GRID_INTERVAL_X

This parameter specifies the grid line density in the X direction.

mapX:GRID_INTERVAL_Y

This parameter specifies the grid line density in the Y direction.

mapX:SCALE

This parameter specifies the map scale for a layout map item. This is useful to ensure scale based visibility of layers and labels even if client and server may have different algorithms to calculate the scale denominator.

mapX:LAYERS

This parameter specifies the layers for a layout map item. See GetMap Layers for more information on this parameter.

mapX:STYLES

This parameter specifies the layers‘ styles defined in a specific layout map item. See GetMap Styles for more information on this parameter.

3.2.8. GetProjectSettings

This request type works similar to GetCapabilities, but it is more specific to QGIS Server and allows a client to read additional information which are not available in the GetCapabilities output:

• initial visibility of layers

• information about vector attributes and their edit types

• information about layer order and drawing order

• list of layers published in WFS

• show if a group in the layer tree is mutually exclusive

The GetProjectSettings request supports the following parameters:

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Name of the request (GetProjectSettings)

3.2.9. GetSchemaExtension

The GetSchemaExtension request allows to retrieve optional extended capabilities and operations of the WMS service such as implemented by QGIS Server.

Parametras	Privalomas	Aprašymas
MAP	Taip	QGIS projekto failas
SERVICE	Taip	Paslaugos pavadinimas (WMS)
REQUEST	Taip	Name of the request (GetSchemaExtension)

URL pavyzdys:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetSchemaExtension

The XML document looks like:

<schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:wms="http://www.opengis.net/wms" xmlns:qgs="http://www.qgis.org/wms" targetNamespace="http://www.qgis.org/wms" elementFormDefault="qualified" version="1.0.0">
    <import namespace="http://www.opengis.net/wms" schemaLocation="http://schemas.opengis.net/wms/1.3.0/capabilities_1_3_0.xsd"/>
    <element name="GetPrint" type="wms:OperationType" substitutionGroup="wms:_ExtendedOperation"/>
    <element name="GetStyles" type="wms:OperationType" substitutionGroup="wms:_ExtendedOperation"/>
</schema>

3.2.10. External WMS layers

QGIS Server allows including layers from external WMS servers in WMS GetMap and WMS GetPrint requests. This is especially useful if a web client uses an external background layer in the web map. For performance reasons, such layers should be directly requested by the web client (not cascaded via QGIS server). For printing however, these layers should be cascaded via QGIS server in order to appear in the printed map.

External layers can be added to the LAYERS parameter as EXTERNAL_WMS:<layername>. The parameters for the external WMS layers (e.g. url, format, dpiMode, crs, layers, styles) can later be given as service parameters <layername>:<parameter>. In a GetMap request, this might look like this:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=EXTERNAL_WMS:basemap,layer1,layer2
&OPACITIES=100,200,255
&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

Similarly, external layers can be used in GetPrint requests:

http://localhost/qgisserver?
SERVICE=WMS
&REQUEST=GetPrint
&TEMPLATE=A4
&map0:layers=EXTERNAL_WMS:basemap,layer1,layer2
&map0:EXTENT=<minx,miny,maxx,maxy>
&OPACITIES=100,200,255
&basemap:url=http://externalserver.com/wms.fcgi
&basemap:format=image/jpeg
&basemap:dpiMode=7
&basemap:crs=EPSG:2056
&basemap:layers=orthofoto
&basemap:styles=default

3.2.11. Paryškinimas

This feature is available and can be used with GetMap and GetPrint requests.

The redlining feature can be used to pass geometries and labels in the request which are overlapped by the server over the standard returned image (map). This permits the user to put emphasis or maybe add some comments (labels) to some areas, locations etc. that are not in the standard map.

The GetMap request is in the format:

http://localhost/qgisserver?
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

The GetPrint equivalent is in the format (note that mapX: parameter is added to tell which map has redlining):

http://localhost/qgisserver?
SERVICE=WMS
&VERSION=1.3.0
&REQUEST=GetPrint
&map0:HIGHLIGHT_GEOM=POLYGON((590000 5647000, 590000 6110620, 2500000 6110620, 2500000 5647000, 590000 5647000))
&map0: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>
&map0:HIGHLIGHT_LABELSTRING=Write label here
&map0:HIGHLIGHT_LABELSIZE=16
&map0:HIGHLIGHT_LABELCOLOR=%23000000
&map0:HIGHLIGHT_LABELBUFFERCOLOR=%23FFFFFF
&map0:HIGHLIGHT_LABELBUFFERSIZE=1.5

Here is the image outputed by the above request in which a polygon and a label are drawn on top of the normal map:

Fig. 3.23 Server response to a GetMap request with redlining parameters

You can see there are several parameters in this request to control the redlining feature. The full list includes:

• HIGHLIGHT_GEOM: You can add POINT, MULTILINESTRING, POLYGON etc. It supports multipart geometries. Here is an example: HIGHLIGHT_GEOM=MULTILINESTRING((0 0, 0 1, 1 1)). The coordinates should be in the CRS of the GetMap/GetPrint request.

• HIGHLIGHT_LABELBUFFERCOLOR: This parameter controls the label buffer color.

• HIGHLIGHT_LABELBUFFERSIZE: This parameter controls the label buffer size.

• HIGHLIGHT_LABELCOLOR: This parameter controls the label color.

• HIGHLIGHT_LABEL_DISTANCE: controls the distance between feature (e.g. point or line) and the label in mm

• HIGHLIGHT_LABELFONT: This parameter controls the font of the label (e.g. Arial)

• HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT: places the label horizontally on a point using the specified alignment (e.g. ‚left‘, ‚center‘, ‚right‘)

• HIGHLIGHT_LABEL_ROTATION: controls the label rotation in degrees

• HIGHLIGHT_LABELSIZE: This parameter controls the size of the label.

• HIGHLIGHT_LABELSTRING: You can pass your labeling text to this parameter.

• HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT: places the label vertically on a point using the specified alignment (e.g. ‚top‘, ‚half‘, ‚bottom‘)

• HIGHLIGHT_SYMBOL: This controls how the geometry is outlined and you can change the stroke width, color and opacity.