Class: QgsServerProjectUtils¶
-
class
qgis.server.
QgsServerProjectUtils
¶ Bases:
sip.simplewrapper
Methods
Returns the owsService abstract defined in project.
Returns the owsService access constraints defined in project.
Returns if owsService capabilities are enabled.
Returns the owsService contact mail defined in project.
Returns the owsService contact organization defined in project.
Returns the owsService contact person defined in project.
Returns the owsService contact phone defined in project.
Returns the owsService contact position defined in project.
Returns the owsService fees defined in project.
Returns the owsService keywords defined in project.
Returns the owsService online resource defined in project.
Returns the owsService title defined in project.
Returns the Layer ids list defined in a QGIS project as published in WCS.
Returns the WCS service url defined in a QGIS project.
Returns the Layer ids list defined in a QGIS project as published in WFS.
Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
Returns the WFS service url defined in a QGIS project.
Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.
Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.
Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.
Returns the default number of map units per millimeters in case of the scale is not given
Returns the WMS Extent restriction.
Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.
Returns the document element name for XML GetFeatureInfo request.
Returns the document element namespace for XML GetFeatureInfo request.
Returns the mapping between layer name and wms layer name for GetFeatureInfo request.
Returns the geometry precision for GetFeatureInfo request.
Returns the schema URL for XML GetFeatureInfo request.
Returns if the geometry has to be segmentize in GetFeatureInfo request.
Returns the quality for WMS images defined in a QGIS project.
Returns if the info format is SIA20145.
Returns if Inspire is activated.
Returns the Inspire language.
Returns the Inspire metadata date.
Returns the Inspire metadata URL.
Returns the Inspire metadata URL type.
Returns the Inspire temporal reference.
Returns the maximum height for WMS images defined in a QGIS project.
Returns the maximum width for WMS images defined in a QGIS project.
Returns the WMS output CRS list.
Returns the restricted composer list.
Returns the restricted layer name list.
Returns the WMS root layer name defined in a QGIS project.
Returns the WMS service url defined in a QGIS project.
Returns if layer ids are used as name in WMS.
Returns the WMTS service url defined in a QGIS project.
-
owsServiceAbstract
(project: QgsProject) → str¶ Returns the owsService abstract defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService abstract if defined in project.
-
owsServiceAccessConstraints
(project: QgsProject) → str¶ Returns the owsService access constraints defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService access constraints if defined in project.
-
owsServiceCapabilities
(project: QgsProject) → bool¶ Returns if owsService capabilities are enabled.
- Parameters
project (QgsProject) – the QGIS project
- Return type
bool
- Returns
if owsService capabilities are enabled.
-
owsServiceContactMail
(project: QgsProject) → str¶ Returns the owsService contact mail defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService contact mail if defined in project.
-
owsServiceContactOrganization
(project: QgsProject) → str¶ Returns the owsService contact organization defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService contact organization if defined in project.
-
owsServiceContactPerson
(project: QgsProject) → str¶ Returns the owsService contact person defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService contact person if defined in project.
-
owsServiceContactPhone
(project: QgsProject) → str¶ Returns the owsService contact phone defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService contact phone if defined in project.
-
owsServiceContactPosition
(project: QgsProject) → str¶ Returns the owsService contact position defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService contact position if defined in project.
-
owsServiceFees
(project: QgsProject) → str¶ Returns the owsService fees defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService fees if defined in project.
-
owsServiceKeywords
(project: QgsProject) → List[str]¶ Returns the owsService keywords defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the owsService keywords if defined in project.
-
owsServiceOnlineResource
(project: QgsProject) → str¶ Returns the owsService online resource defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService online resource if defined in project.
-
owsServiceTitle
(project: QgsProject) → str¶ Returns the owsService title defined in project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the owsService title if defined in project.
-
wcsLayerIds
(project: QgsProject) → List[str]¶ Returns the Layer ids list defined in a QGIS project as published in WCS.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the Layer ids list.
-
wcsServiceUrl
(project: QgsProject) → str¶ Returns the WCS service url defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
url if defined in project, an empty string otherwise.
-
wfsLayerIds
(project: QgsProject) → List[str]¶ Returns the Layer ids list defined in a QGIS project as published in WFS.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the Layer ids list.
-
wfsLayerPrecision
(project: QgsProject, layerId: str) → int¶ Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
- Parameters
project (QgsProject) – the QGIS project
layerId (str) – the layer id in the project
- Return type
int
- Returns
the layer precision for WFS GetFeature.
-
wfsServiceUrl
(project: QgsProject) → str¶ Returns the WFS service url defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
url if defined in project, an empty string otherwise.
-
wfstDeleteLayerIds
(project: QgsProject) → List[str]¶ Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the Layer ids list.
-
wfstInsertLayerIds
(project: QgsProject) → List[str]¶ Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the Layer ids list.
-
wfstUpdateLayerIds
(project: QgsProject) → List[str]¶ Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the Layer ids list.
-
wmsDefaultMapUnitsPerMm
(project: QgsProject) → float¶ Returns the default number of map units per millimeters in case of the scale is not given
- Parameters
project (QgsProject) – the QGIS project
- Return type
float
- Returns
the default number of map units per millimeter
New in version 3.4.
-
wmsExtent
(project: QgsProject) → QgsRectangle¶ Returns the WMS Extent restriction.
- Parameters
project (QgsProject) – the QGIS project
- Return type
- Returns
the WMS Extent restriction.
-
wmsFeatureInfoAddWktGeometry
(project: QgsProject) → bool¶ Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.
- Parameters
project (QgsProject) – the QGIS project
- Return type
bool
- Returns
if the geometry is displayed as Well Known Text in GetFeatureInfo request.
-
wmsFeatureInfoDocumentElement
(project: QgsProject) → str¶ Returns the document element name for XML GetFeatureInfo request.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the document element name for XML GetFeatureInfo request.
-
wmsFeatureInfoDocumentElementNs
(project: QgsProject) → str¶ Returns the document element namespace for XML GetFeatureInfo request.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the document element namespace for XML GetFeatureInfo request.
-
wmsFeatureInfoLayerAliasMap
(project: QgsProject) → Dict[str, str]¶ Returns the mapping between layer name and wms layer name for GetFeatureInfo request.
- Parameters
project (QgsProject) – the QGIS project
- Return type
Dict[str, str]
- Returns
the mapping between layer name and wms layer name for GetFeatureInfo request.
-
wmsFeatureInfoPrecision
(project: QgsProject) → int¶ Returns the geometry precision for GetFeatureInfo request.
- Parameters
project (QgsProject) – the QGIS project
- Return type
int
- Returns
the geometry precision for GetFeatureInfo request.
-
wmsFeatureInfoSchema
(project: QgsProject) → str¶ Returns the schema URL for XML GetFeatureInfo request.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the schema URL for XML GetFeatureInfo request.
-
wmsFeatureInfoSegmentizeWktGeometry
(project: QgsProject) → bool¶ Returns if the geometry has to be segmentize in GetFeatureInfo request.
- Parameters
project (QgsProject) – the QGIS project
- Return type
bool
- Returns
if the geometry has to be segmentize in GetFeatureInfo request.
-
wmsImageQuality
(project: QgsProject) → int¶ Returns the quality for WMS images defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
int
- Returns
quality if defined in project, -1 otherwise.
-
wmsInfoFormatSia2045
(project: QgsProject) → bool¶ Returns if the info format is SIA20145.
- Parameters
project (QgsProject) – the QGIS project
- Return type
bool
- Returns
if the info format is SIA20145.
-
wmsInspireActivate
(project: QgsProject) → bool¶ Returns if Inspire is activated.
- Parameters
project (QgsProject) – the QGIS project
- Return type
bool
- Returns
if Inspire is activated.
-
wmsInspireLanguage
(project: QgsProject) → str¶ Returns the Inspire language.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the Inspire language if defined in project.
-
wmsInspireMetadataDate
(project: QgsProject) → str¶ Returns the Inspire metadata date.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the Inspire metadata date if defined in project.
-
wmsInspireMetadataUrl
(project: QgsProject) → str¶ Returns the Inspire metadata URL.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the Inspire metadata URL if defined in project.
-
wmsInspireMetadataUrlType
(project: QgsProject) → str¶ Returns the Inspire metadata URL type.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the Inspire metadata URL type if defined in project.
-
wmsInspireTemporalReference
(project: QgsProject) → str¶ Returns the Inspire temporal reference.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
the Inspire temporal reference if defined in project.
-
wmsMaxHeight
(project: QgsProject) → int¶ Returns the maximum height for WMS images defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
int
- Returns
height if defined in project, -1 otherwise.
-
wmsMaxWidth
(project: QgsProject) → int¶ Returns the maximum width for WMS images defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
int
- Returns
width if defined in project, -1 otherwise.
-
wmsOutputCrsList
(project: QgsProject) → List[str]¶ Returns the WMS output CRS list.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the WMS output CRS list.
-
wmsRestrictedComposers
(project: QgsProject) → List[str]¶ Returns the restricted composer list.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the restricted composer list if defined in project.
-
wmsRestrictedLayers
(project: QgsProject) → List[str]¶ Returns the restricted layer name list.
- Parameters
project (QgsProject) – the QGIS project
- Return type
List[str]
- Returns
the restricted layer name list if defined in project.
-
wmsRootName
(project: QgsProject) → str¶ Returns the WMS root layer name defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
root layer name if defined in project, an empty string otherwise.
-
wmsServiceUrl
(project: QgsProject) → str¶ Returns the WMS service url defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
url if defined in project, an empty string otherwise.
-
wmsUseLayerIds
(project: QgsProject) → bool¶ Returns if layer ids are used as name in WMS.
- Parameters
project (QgsProject) – the QGIS project
- Return type
bool
- Returns
if layer ids are used as name.
-
wmtsServiceUrl
(project: QgsProject) → str¶ Returns the WMTS service url defined in a QGIS project.
- Parameters
project (QgsProject) – the QGIS project
- Return type
str
- Returns
url if defined in project, an empty string otherwise.
New in version 3.4.
-