サービス

QGISサーバーでは、 Open Geospatial Consortium（OGC） に記載されているように、標準プロトコルに従ってデータを提供できます。

  • WMS 1.1.0 and 1.3.0

  • WFS 1.0.0 and 1.1.0

  • WCS 1.1.1

  • WMTS 1.0.0

QGISレンダリングエンジンのおかげでその振る舞いをカスタマイズする可能性を大いに高めるオリジナルの規格に加えて、追加のベンダーパラメータと要求がサポートされています。

Web地図サービス (WMS)

QGISサーバーに実装された 1.1.0 および 1.3.0 WMS標準は、QGISプロジェクトから作成された地図または凡例の画像を要求するHTTPインターフェースを提供します。典型的なWMSリクエストは、使用するQGISプロジェクト、レンダリングするレイヤ、作成する画像フォーマットを定義します。 Styled Layer Descriptor（SLD） 規格についても基本的なサポートが利用可能です。

Specifications document according to the version number of the service:

Standard requests provided by QGIS Server:

Request

Description

GetCapabilities

Return XML metadata with information about the server

GetMap

Return a map

GetFeatureInfo

Retrieves data (geometry and values) for a pixel location

GetLegendGraphics

Returns legend symbols

Vendor requests provided by QGIS Server:

Request

Description

GetPrint

Returns a QGIS composition

GetProjectSettings

Returns specific information about QGIS Server

GetMap

Standard parameters for the GetMap request according to the OGC WMS 1.1.0 and 1.3.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMS)

VERSION

No

Version of the service

REQUEST

Yes

Name of the request (GetMap)

LAYERS

No

Layers to display

STYLES

No

Layers' style

SRS / CRS

Yes

座標参照系

BBOX

No

Map extent

WIDTH

Yes

Width of the image in pixels

HEIGHT

Yes

Height of the image in pixels

FORMAT

No

Image format

TRANSPARENT

No

透明な背景

標準のものに加えて、QGISサーバーでは以下の追加パラメータをサポートしています：

Parameter

Required

Description

MAP

Yes

Specify the QGIS project file

BGCOLOR

No

Specify the background color

DPI

No

Specify the output resolution

IMAGE_QUALITY

No

JPEG compression

OPACITIES

No

Opacity for layer or group

FILTER

No

Subset of features

SELECTION

No

Highlight features

FILE_NAME

No

Only for FORMAT=application/dxf

File name of the downloaded file

FORMAT_OPTIONS

No

Only for FORMAT=application/dxf

key:value pairs separated by semicolon.

  • SCALE: to be used for symbology rules, filters and styles (not actual scaling of the data - data remains in the original scale).

  • MODE:NOSYMBOLOGY|FEATURESYMBOLOGY|SYMBOLLAYERSYMBOLOGY はQGISデスクトップのDXFエクスポートダイアログボックスで提供される3つのエクスポートオプションに対応しています。

  • LAYERSATTRIBUTES:yourcolumn_with_values_to_be_used_for_dxf_layernames if not specified, the original QGIS layer names are used.

  • USE_TITLE_AS_LAYERNAME: if enabled, the title of the layer will be used as layer name.

URL example:

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

This parameter has to be WMS in case of the GetMap request.

VERSION

This parameter allows to specify the version of the service to use. Available values for the VERSION parameter are:

  • 1.1.0

  • 1.3.0

If no version is indicated in the request, then 1.3.0 is used by default.

According to the version number, slight differences have to be expected as explained later for the next parameters:

  • CRS / SRS

  • BBOX

REQUEST

This parameter is GetMap in case of the GetMap request.

LAYERS

This parameter allows to specify the layers to display on the map. Names have to be separated by a comma.

In addition, QGIS Server introduced some options to select layers by:

  • a short name

  • the layer id

The short name of a layer may be configured through Properties ‣ Metadata in layer menu. If the short name is defined, then it's used by default instead of the layer's name:

http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mynickname1,mynickname2
&...

さらに、プロジェクト - > プロパティ ... ダイアログの OWSサーバ - > WMS capabilities メニューにIDでレイヤーを選択できるプロジェクトオプションがあります。このオプションを有効にするには、チェックボックス レイヤーIDを名前として使用 を選択する必要があります。

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

STYLES

This parameter can be used to specify a layer's style for the rendering step. Styles have to be separated by a comma. The name of the default style is default.

SRS / CRS

This parameter allows to indicate the map output Spatial Reference System in WMS 1.1.0 and has to be formed like EPSG:XXXX. Note that CRS is also supported if current version is 1.1.0.

For WMS 1.3.0, CRS parameter is preferable but SRS is also supported.

Note that if both CRS and SRS parameters are indicated in the request, then it's the current version indicated in VERSION parameter which is decisive.

In the next case, the SRS parameter is kept whatever the VERSION parameter because CRS is not indicated:

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

In the next case, the SRS parameter is kept instead of CRS because of the VERSION parameter:

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

In the next case, the CRS parameter is kept instead of SRS because of the VERSION parameter:

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

BBOX

This parameter allows to specify the map extent with units according to the current CRS. Coordinates have to be separated by a comma.

しかし、現在の VERSION パラメータに応じてわずかな違いがあります。実際、WMS 1.1.0 では、座標は minx,miny,maxx,maxy や minlong,minlat,maxlong,maxlat のように形成されます。例えば：

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

But the axis is reversed in WMS 1.3.0, so coordinates are formed like: miny,minx,maxy,maxx or minlat,minlong,maxlat,maxlong. For example:

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

WIDTH

This parameter allows to specify the width in pixels of the output image.

HEIGHT

This parameter allows to specify the height in pixels of the output image.

FORMAT

This parameter may be used to specify the format of map image. Available values are:

  • jpg

  • jpeg

  • image/jpeg

  • image/png

  • image/png; mode=1bit

  • image/png; mode=8bit

  • image/png; mode=16bit

  • application/dxf Only layers that have read access in the WFS service are exported in the DXF format.

    URL example:

    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

This boolean parameter can be used to specify the background transparency. Available values are (not case sensitive):

  • TRUE

  • FALSE

However, this parameter is ignored if the format of the map image indicated with FORMAT is different from PNG.

MAP

This parameter allows to define the QGIS project file to use.

GetMap パラメータテーブル で述べたように、リクエストは実際に動作するためにQGISプロジェクトを必要とするので MAP は必須です。しかし、 QGIS_PROJECT_FILE 環境変数がデフォルトのQGISプロジェクトを定義するために使用されるかもしれません。この場合、 MAP はもはや必須のパラメータではありません。より詳しい情報は 高度な構成 を参照してください。

BGCOLOR

This parameter allows to indicate a background color for the map image. However it cannot be combined with TRANSPARENT parameter in case of PNG images (transparency takes priority). The colour may be literal or in hexadecimal notation.

URL example with the literal notation:

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

URL example with the hexadecimal notation:

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

DPI

This parameter can be used to specify the requested output resolution.

IMAGE_QUALITY

This parameter is only used for JPEG images. By default, the JPEG compression is -1.

You can change the default per QGIS project in the OWS Server ‣ WMS capabilities menu of the Project ‣ Properties... dialog. If you want to override it in a GetMap request you can do it using the IMAGE_QUALITY parameter.

OPACITIES

Opacity can be set on layer or group level. Allowed values range from 0 (fully transparent) to 255 (fully opaque).

FILTER

レイヤのサブセットは FILTER パラメータで選択できます。構文は基本的にQGISサブセット文字列と同じです。ただし、QGISサーバーを介したデータベースへのSQLインジェクションを回避するための制限がいくつかあります。危険な文字列がパラメータに見つかった場合、QGISサーバーは次のエラーを返します：

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

URL example:

http://localhost/qgis_server?
SERVICE=WMS
&REQUEST=GetMap
&LAYERS=mylayer1,mylayer2
&FILTER=mylayer1:"OBJECTID" = 3;mylayer2:'text' = 'blabla'
&...

注釈

GetFeatureInfoを経由して、属性検索を行い、FILTERがある場合、X / Yパラメータを省略することが可能です。QGISサーバは、マッチングの機能についての情報を返し、XML出力の組み合わせバウンディングボックスを生成します。

SELECTION

The SELECTION parameter can highlight features from one or more layers. Vector features can be selected by passing comma separated lists with feature ids.

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

The following image presents the response from a GetMap request using the SELECTION option e.g. http://myserver.com/...&SELECTION=countries:171,65.

As those features id's correspond in the source dataset to France and Romania they're highlighted in yellow.

../../../../_images/server_selection_parameter.png

SELECTIONパラメーターを指定したGetMapリクエストに対するサーバーの応答

GetFeatureInfo

Standard parameters for the GetFeatureInfo request according to the OGC WMS 1.1.0 and 1.3.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMS)

VERSION

No

See GetMap

REQUEST

Yes

See GetMap

LAYERS

No

See GetMap

STYLES

No

See GetMap

SRS / CRS

Yes

See GetMap

BBOX

No

See GetMap

WIDTH

Yes

See GetMap

HEIGHT

Yes

See GetMap

TRANSPARENT

No

See GetMap

INFO_FORMAT

No

出力形式

QUERY_LAYERS

Yes

Layers to query

FEATURE_COUNT

No

Maximum number of features to return

I

No

Pixel column of the point to query

X

No

Same as I parameter, but in WMS 1.1.0

J

No

Pixel row of the point to query

Y

No

Same as J parameter, but in WMS 1.1.0

標準のものに加えて、QGISサーバーでは以下の追加パラメータをサポートしています：

Parameter

Required

Description

MAP

Yes

See GetMap

FILTER

No

See GetMap

FI_POINT_TOLERANCE

No

Tolerance in pixels for point layers

FI_LINE_TOLERANCE

No

ラインレイヤでの許容誤差（ピクセル）

FI_POLYGON_TOLERANCE：

No

Tolerance in pixels for polygon layers

FILTER_GEOM

No

Geometry filtering

WITH_MAPTIP

No

Add map tips to the output

WITH_GEOMETRY

No

Add geometry to the output

URL example:

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

このパラメータは結果のフォーマットを指定するために使用されます。利用可能な値は以下のとおりです：

  • text/xml

  • text/html

  • text/plain

  • application/vnd.ogc.gml

  • application/json

QUERY_LAYERS

This parameter specifies the layers to display on the map. Names are separated by a comma.

In addition, QGIS Server introduces options to select layers by:

  • short name

  • layer id

See the LAYERS parameter defined in See GetMap for more information.

FEATURE_COUNT

このパラメータでは、レイヤごとに返す地物の最大数を指定します。例えば、 QUERY_LAYERS が layer1,layer2 に設定され、 FEATURE_COUNT が 3 に設定されている場合、layer1から最大3つの地物が返されます。同様に、layer2から最大3つの地物が返されます。

By default, only 1 feature per layer is returned.

I

This parameter, defined in WMS 1.3.0, allows you to specify the pixel column of the query point.

X

Same parameter as I, but defined in WMS 1.1.0.

J

This parameter, defined in WMS 1.3.0, allows you to specify the pixel row of the query point.

Y

Same parameter as J, but defined in WMS 1.1.0.

FI_POINT_TOLERANCE

このパラメータではラインレイヤでの許容誤差（ピクセル）を指定します。

FI_LINE_TOLERANCE

This parameter specifies the tolerance in pixels for line layers.

FI_POLYGON_TOLERANCE：

This parameter specifies the tolerance in pixels for polygon layers.

FILTER_GEOM

This parameter specifies a WKT geometry with which features have to intersect.

WITH_MAPTIP

This parameter specifies whether to add map tips to the output.

Available values are (not case sensitive):

  • TRUE

  • FALSE

WITH_GEOMETRY

This parameter specifies whether to add geometries to the output.

Available values are (not case sensitive):

  • TRUE

  • FALSE

GetPrint

QGISサーバには、PDFまたはピクセル形式のプリントレイアウト出力を作成する機能があります。公表されたプロジェクトでのプリントレイアウトがテンプレートとして使用されます。GETPRINT要求では、クライアントは含まれているレイアウト地図とラベルのパラメータを指定する可能性があります。

Parameters for the GetPrint request:

Parameter

Required

Description

MAP

Yes

Specify the QGIS project file

SERVICE

Yes

Name of the service (WMS)

VERSION

No

See GetMap

REQUEST

Yes

Name of the request (GetPrint)

LAYERS

No

See GetMap

TEMPLATE

Yes

Layout template to use

SRS / CRS

Yes

See GetMap

FORMAT

Yes

出力形式

STYLES

No

See GetMap

TRANSPARENT

No

See GetMap

OPACITIES

No

See GetMap

SELECTION

No

See GetMap

mapX:EXTENT

No

Extent of the map 'X'

mapX:LAYERS

No

Layers of the map 'X'

mapX:STYLES

No

Layers' style of the map 'X'

mapX:SCALE

No

Layers' scale of the map 'X'

mapX:ROTATION

No

Rotation of the map 'X'

mapX:GRID_INTERVAL_X

No

Grid interval on x axis of the map 'X'

mapX:GRID_INTERVAL_Y

No

Grid interval on y axis of the map 'X'

URL example:

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

レイアウトテンプレートには複数のマップが含まれている可能性があることに注意してください。このように、特定のマップを設定したい場合は、 mapX: パラメータを使う必要があります。ここで、 X は GetProjectSettings リクエストのおかげで取得できる正数です。

For example:

<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

This parameter has to be WMS.

REQUEST

This parameter has to be GetPrint for the GetPrint request.

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:

  • jpg

  • jpeg

  • image/jpeg

  • png

  • image/png

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

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

このパラメータは、レイアウト地図アイテムの地図縮尺を指定します。これは、クライアントとサーバーで縮尺分母を計算するアルゴリズムが異なる場合でもレイヤとラベルの縮尺に基づく可視性を確保するのに役立ちます。

mapX:LAYERS

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

mapX:STYLES

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

GetLegendGraphics

いくつかの追加のパラメーターは、凡例の要素のサイズを変更できます：

  • BOXSPACE 凡例フレームと内容の間の空白(mm)

  • LAYERSPACE vertical space between layers (mm)

  • LAYERTITLESPACE レイヤータイトルと後続アイテム間の垂直方向のスペース（mm）

  • SYMBOLSPACE シンボルとアイテム間の垂直方向の間隔（mm）

  • ICONLABELSPACE シンボルとラベルのテキストの間の水平スペース（ミリメートル）

  • SYMBOLWIDTH シンボルプレビューの幅（mm）

  • SYMBOLHEIGHT シンボルプレビューの高さ（mm）

これらのパラメーターは、レイヤーのタイトルや項目ラベルのフォントプロパティを変更します。

  • LAYERFONTFAMILY / ITEMFONTFAMILY レイヤータイトル／項目テキストのためのフォントファミリー

  • LAYERFONTBOLD / ITEMFONTBOLD TRUE to use a bold font

  • LAYERFONTSIZE / ITEMFONTSIZE ポイントでのフォントサイズ

  • LAYERFONTITALIC / ITEMFONTITALIC TRUE to use italic font

  • LAYERFONTCOLOR / ITEMFONTCOLOR Hex color code (e.g. #FF0000 for red)

  • LAYERTITLE / RULELABEL set them to FALSE to get only the legend graphics without labels

コンテストに基づく凡例。これらのパラメータでは、要求された領域に入る地物のシンボルだけを表示する凡例をクライアントに要求させます。

  • BBOX 凡例を構築する必要のある地域

  • CRS / SRS BBOX座標を定義するために採用された座標参照系

  • 設定されている場合** WIDTH / HEIGHT **これらは、地図ビューの画像サイズに応じてQGIS サーバーがシンボルを縮尺設定できるように、GetMapリクエストのために定義されたものと一致する必要があります。

内容に基づく凡例機能は、 UMN MapServer 実装に基づきます：

  • SHOWFEATURECOUNT if set to TRUE adds in the legend the feature count of the features like in the following image:

    ../../../../_images/getfeaturecount_legend.png

GetProjectSettings

このリクエストタイプは GetCapabilities に似ていますが、それはQGIS サーバーに対してより具体的であり、クライアントは、GetCapabilities出力では利用できない追加情報を読み取ることができます：

  • レイヤーの初期可視性

  • ベクターの属性とその編集タイプに関する情報

  • レイヤーの順序と描画順序に関する情報

  • WFSに掲載されたレイヤのリスト

Web Feature Service (WFS)

The 1.0.0 and 1.1.0 WFS standards implemented in QGIS Server provide a HTTP interface to query geographic features from a QGIS project. A typical WFS request defines the QGIS project to use and the layer to query.

Specifications document according to the version number of the service:

Standard requests provided by QGIS Server:

Request

Description

GetCapabilities

Returns XML metadata with information about the server

GetFeature

Returns a selection of features

DescribeFeatureType

Returns a description of feature types and properties

Transaction

Allows features to be inserted, updated or deleted

GetFeature

Standard parameters for the GetFeature request according to the OGC WFS 1.0.0 and 1.1.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service

VERSION

No

Version of the service

REQUEST

Yes

Name of the request

TYPENAME

No

レイヤの名前

OUTPUTFORMAT

No

Output Format

RESULTTYPE

No

Type of the result

PROPERTYNAME

No

Name of properties to return

MAXFEATURES

No

Maximum number of features to return

SRSNAME

No

座標参照系

FEATUREID

No

Filter the features by ids

FILTER

No

OGC Filter Encoding

BBOX

No

Map Extent

SORTBY

No

Sort the results

標準のものに加えて、QGISサーバーでは以下の追加パラメータをサポートしています：

Parameter

Required

Description

MAP

Yes

Specify the QGIS project file

STARTINDEX

No

Paging

GEOMETRYNAME

No

Type of geometry to return

EXP_FILTER

No

Expression filtering

SERVICE

This parameter has to be WFS in case of the GetFeature request.

For example:

http://localhost/qgis_server?
SERVICE=WFS
&...

VERSION

This parameter allows to specify the version of the service to use. Available values for the VERSION parameter are:

  • 1.0.0

  • 1.1.0

If no version is indicated in the request, then 1.1.0 is used by default.

URL example:

http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&...

REQUEST

This parameter is GetFeature in case of the GetFeature request.

URL example:

http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&...

RESULTTYPE

This parameter may be used to specify the kind of result to return. Available values are:

  • results: the default behavior

  • hits: returns only a feature count

URL example:

http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&RESULTTYPE=hits
&...

GEOMETRYNAME

このパラメータは、地物に返すジオメトリの種類を指定するために使用できます。利用可能な値は以下のとおりです：

  • 範囲

  • 重心

  • なし

URL example:

http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&GEOMETRYNAME=centroid
&...

STARTINDEX

This parameter is standard in WFS 2.0, but it's an extension for WFS 1.0.0. Actually, it can be used to skip some features in the result set and in combination with MAXFEATURES, it provides the ability to page through results.

URL example:

http://localhost/qgis_server?
SERVICE=WFS
&VERSION=1.1.0
&REQUEST=GetFeature
&STARTINDEX=2
&...

Web Map Tile Service (WMTS)

QGISサーバに実装された 1.0.0 WMTS標準は、QGISプロジェクトから作成されたタイル地図画像を要求するためのHTTPインターフェースを提供します。典型的なWMTSリクエストでは、使用するQGISプロジェクト、レンダリングするレイヤなどの一部のWMSパラメータ、およびタイルパラメータを定義しました。

Specifications document of the service:

Standard requests provided by QGIS Server:

Request

Description

GetCapabilities

Returns XML metadata with information about the server

GetTile

Returns a tile

GetFeatureInfo

Retrieves data (geometry and values) for a pixel location

GetCapabilities

Standard parameters for the GetCapabilities request according to the OGC WMTS 1.0.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMTS)

REQUEST

Yes

Name of the request (GetCapabilities)

標準のものに加えて、QGISサーバーでは以下の追加パラメータをサポートしています：

Parameter

Required

Description

MAP

Yes

Specify the QGIS project file

URL example:

http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetCapabilities
&MAP=/home/user/project.qgs

SERVICE

This parameter has to be WMTS in case of the GetCapabilities request.

REQUEST

This parameter is GetCapabilities in case of the GetCapabilities request.

MAP

This parameter allows to define the QGIS project file to use.

GetTile

Standard parameters for the GetTile request according to the OGC WMTS 1.0.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMTS)

REQUEST

Yes

Name of the request (GetTile)

LAYER

Yes

Layer identifier

FORMAT

Yes

Output format of the tile

TILEMATRIXSET

Yes

Name of the pyramid

TILEMATRIX

Yes

Meshing

TILEROW

Yes

Row coordinate in the mesh

TILECOL

Yes

Column coordinate in the mesh

標準のものに加えて、QGISサーバーでは以下の追加パラメータをサポートしています：

Parameter

Required

Description

MAP

Yes

Specify the QGIS project file

URL example:

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

This parameter has to be WMTS in case of the GetTile request.

REQUEST

This parameter is GetTile in case of the GetTile request.

LAYER

This parameter allows to specify the layer to display on the tile.

In addition, QGIS Server introduced some options to select a layer by:

  • a short name

  • the layer id

The short name of a layer may be configured through Properties ‣ Metadata in layer menu. If the short name is defined, then it's used by default instead of the layer's name:

http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetTile
&LAYER=mynickname
&...

Moreover, there's a project option allowing to select layers by their id in OWS Server ‣ WMS capabilities menu of the Project ‣ Project Properties dialog. To activate this option, the checkbox Use layer ids as names has to be selected.

http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetTile
&LAYER=mylayerid1
&...

FORMAT

This parameter may be used to specify the format of tile image. Available values are:

  • jpg

  • jpeg

  • image/jpeg

  • image/png

If the FORMAT parameter is different from one of these values, then the default format PNG is used instead.

TILEMATRIXSET

This parameter allows to define the CRS to use to compute the underlying pyramid and has to be formed like EPSG:XXXX.

TILEMATRIX

This parameter allows to define the matrix to use for the output tile.

TILEROW

This parameter allows to select the row of the tile to get within the matrix.

TILECOL

This parameter allows to select the column of the tile to get within the matrix.

MAP

This parameter allows to define the QGIS project file to use.

GetMap パラメータテーブル で述べたように、リクエストは実際に動作するためにQGISプロジェクトを必要とするので MAP は必須です。しかし、 QGIS_PROJECT_FILE 環境変数がデフォルトのQGISプロジェクトを定義するために使用されるかもしれません。この場合、 MAP はもはや必須のパラメータではありません。より詳しい情報は 高度な構成 を参照してください。

GetFeatureInfo

Standard parameters for the GetFeatureInfo request according to the OGC WMTS 1.0.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMTS)

REQUEST

Yes

Name of the request (GetFeatureInfo)

LAYER

Yes

Layer identifier

INFOFORMAT

No

出力形式

I

No

X coordinate of a pixel

J

No

Y coordinate of a pixel

TILEMATRIXSET

Yes

See GetTile

TILEMATRIX

Yes

See GetTile

TILEROW

Yes

See GetTile

TILECOL

Yes

See GetTile

標準のものに加えて、QGISサーバーでは以下の追加パラメータをサポートしています：

Parameter

Required

Description

MAP

Yes

Specify the QGIS project file

URL example:

http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetFeatureInfo
&MAP=/home/user/project.qgs
&LAYER=mylayer
&INFOFORMAT=image/html
&I=10
&J=5

SERVICE

This parameter has to be WMTS in case of the GetFeatureInfo request.

REQUEST

This parameter is GetFeatureInfo in case of the GetFeatureInfo request.

MAP

This parameter allows to define the QGIS project file to use.

GetMap パラメータテーブル で述べたように、リクエストは実際に動作するためにQGISプロジェクトを必要とするので MAP は必須です。しかし、 QGIS_PROJECT_FILE 環境変数がデフォルトのQGISプロジェクトを定義するために使用されるかもしれません。この場合、 MAP はもはや必須のパラメータではありません。より詳しい情報は 高度な構成 を参照してください。

LAYER

This parameter allows to specify the layer to display on the tile.

In addition, QGIS Server introduced some options to select a layer by:

  • a short name

  • the layer id

The short name of a layer may be configured through Properties ‣ Metadata in layer menu. If the short name is defined, then it's used by default instead of the layer's name:

http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetFeatureInfo
&LAYER=mynickname
&...

Moreover, there's a project option allowing to select layers by their id in OWS Server ‣ WMS capabilities menu of the Project ‣ Project Properties dialog. To activate this option, the checkbox Use layer ids as names has to be selected.

http://localhost/qgis_server?
SERVICE=WMTS
&REQUEST=GetFeatureInfo
&LAYER=mylayerid1
&...

INFOFORMAT

This parameter allows to define the output format of the result. Available values are:

  • text/xml

  • text/html

  • text/plain

  • application/vnd.ogc.gml

The default value is text/plain.

I

This parameter allows to define the X coordinate of the pixel for which we want to retrieve underlying information.

J

This parameter allows to define the Y coordinate of the pixel for which we want to retrieve underlying information.

すべてのリクエストタイプでサポートされている追加パラメーター

  • FILE_NAME パラメーター：設定されている場合、サーバーの応答が指定したファイル名のファイルの添付ファイルとしてクライアントに送信されます。

  • MAP パラメーター：MapServerと同様に、 MAP パラメーターを使用してQGISプロジェクトファイルへのパスを指定できます。（ qgis_mapserv.fcgi ：ファイル）サーバーの実行可能ファイルの場所への絶対パスまたは相対パスを指定できます。指定されていない場合は、QGIS Serverは、サーバーの実行可能ファイルがあるディレクトリ内で.qgsファイルを検索します。

    例:

    http://localhost/cgi-bin/qgis_mapserv.fcgi?\
  REQUEST=GetMap&MAP=/home/qgis/mymap.qgs&...

注釈

QGISプロジェクトファイルをどこで検索するかをサーバーの実行可能ファイルに伝えるために、環境変数として QGIS_PROJECT_FILE を定義できます。この変数はQGISによってプロジェクトファイルが探される場所になります。定義されていない場合はリクエスト中のMAPパラメーターを使用し、最終的にはサーバーの実行可能ファイルのディレクトリを見ていきます。

REDLINING

この機能は利用可能であり、 GetMap および GetPrint 要求と共に使用できます。

赤線引き地物は、リクエスト中のジオメトリとラベルに渡すのに使用できます、標準返された画像（地図）上でサーバーによって重ねあわされます。これにより、ユーザーは、標準地図にないいくつかの領域、場所などに強調（emphasis）またはコメント（ラベル）を追加することが可能になります。

要求は以下の形式で行われます。

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

ポリゴンとラベルが通常地図の上に描かれている、上記の要求によって出力された画像は次のとおりです：

../../../../_images/server_redlining.png

レッドラインパラメーターを持つGetMapリクエストに対するサーバーの応答

このリクエストにはいくつかのパラメーターがあります。

  • HIGHLIGHT_GEOM ：POINT、MULTILINESTRING、POLYGONなどを追加できます。マルチパートジオメトリをサポートしています。例は： HIGHLIGHT_GEOM=MULTILINESTRING((0 0, 0 1, 1 1)) 。座標はGetMap/GetPrint要求のCRSになければなりません。

  • HIGHLIGHT_SYMBOL ：ジオメトリの輪郭をどのように表示するかを制御し、ストロークの幅、色、不透明度を変更できます。

  • HIGHLIGHT_LABELSTRING ：ラベルのテキストをこのパラメーターに渡すことができます。

  • HIGHLIGHT_LABELSIZE: このパラメーターは、ラベルのサイズを制御します。

  • HIGHLIGHT_LABELCOLOR: このパラメーターは、ラベルの色を制御します。

  • HIGHLIGHT_LABELBUFFERCOLOR: このパラメーターは、ラベルバッファの色を制御します。

  • HIGHLIGHT_LABELBUFFERSIZE: このパラメーターは、ラベルバッファのサイズを制御します。

External WMS layers

QGISサーバは、WMS GetMapとWMS GetPrintリクエストに外部WMSサーバからのレイヤを含めることを可能にします。これは、WebクライアントがWeb地図で外部の背景レイヤを使用している場合に特に便利です。パフォーマンス上の理由から、このようなレイヤはWebクライアントから直接要求される必要があります（QGISサーバを介してカスケードされることはありません）。ただし、印刷する場合は、印刷された地図に表示されるように、これらのレイヤーをQGISサーバ経由でカスケードする必要があります。

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

Similarly, external layers can be used in GetPrint requests:

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