Class: QgsServerProjectUtils

class qgis.server.QgsServerProjectUtils

Bases: sip.simplewrapper

Enums

Methods

owsServiceAbstract Returns the owsService abstract defined in project.
owsServiceAccessConstraints Returns the owsService access constraints defined in project.
owsServiceCapabilities Returns if owsService capabilities are enabled.
owsServiceContactMail Returns the owsService contact mail defined in project.
owsServiceContactOrganization Returns the owsService contact organization defined in project.
owsServiceContactPerson Returns the owsService contact person defined in project.
owsServiceContactPhone Returns the owsService contact phone defined in project.
owsServiceContactPosition Returns the owsService contact position defined in project.
owsServiceFees Returns the owsService fees defined in project.
owsServiceKeywords Returns the owsService keywords defined in project.
owsServiceOnlineResource Returns the owsService online resource defined in project.
owsServiceTitle Returns the owsService title defined in project.
wcsLayerIds Returns the Layer ids list defined in a QGIS project as published in WCS.
wcsServiceUrl Returns the WCS service url defined in a QGIS project.
wfsLayerIds Returns the Layer ids list defined in a QGIS project as published in WFS.
wfsLayerPrecision Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
wfsServiceUrl Returns the WFS service url defined in a QGIS project.
wfstDeleteLayerIds Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.
wfstInsertLayerIds Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.
wfstUpdateLayerIds Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.
wmsExtent Returns the WMS Extent restriction.
wmsFeatureInfoAddWktGeometry Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.
wmsFeatureInfoDocumentElement Returns the document element name for XML GetFeatureInfo request.
wmsFeatureInfoDocumentElementNs Returns the document element namespace for XML GetFeatureInfo request.
wmsFeatureInfoLayerAliasMap Returns the mapping between layer name and wms layer name for GetFeatureInfo request.
wmsFeatureInfoPrecision Returns the geometry precision for GetFeatureInfo request.
wmsFeatureInfoSchema Returns the schema URL for XML GetFeatureInfo request.
wmsFeatureInfoSegmentizeWktGeometry Returns if the geometry has to be segmentize in GetFeatureInfo request.
wmsImageQuality Returns the quality for WMS images defined in a QGIS project.
wmsInfoFormatSia2045 Returns if the info format is SIA20145.
wmsInspireActivate Returns if Inspire is activated.
wmsInspireLanguage Returns the Inspire language.
wmsInspireMetadataDate Returns the Inspire metadata date.
wmsInspireMetadataUrl Returns the Inspire metadata URL.
wmsInspireMetadataUrlType Returns the Inspire metadata URL type.
wmsInspireTemporalReference Returns the Inspire temporal reference.
wmsMaxAtlasFeatures Returns the maximum number of atlas features which can be printed in a request
wmsMaxHeight Returns the maximum height for WMS images defined in a QGIS project.
wmsMaxWidth Returns the maximum width for WMS images defined in a QGIS project.
wmsOutputCrsList Returns the WMS output CRS list.
wmsRestrictedComposers Returns the restricted composer list.
wmsRestrictedLayers Returns the restricted layer name list.
wmsRootName Returns the WMS root layer name defined in a QGIS project.
wmsServiceUrl Returns the WMS service url defined in a QGIS project.
wmsUseLayerIds Returns if layer ids are used as name in WMS.
wmtsServiceUrl Returns the WMTS service url defined in a QGIS project.

Signals

Attributes

owsServiceAbstract(project: QgsProject) → str

Returns the owsService abstract defined in project.

Parameters:project – the QGIS project
Returns:the owsService abstract if defined in project.
owsServiceAccessConstraints(project: QgsProject) → str

Returns the owsService access constraints defined in project.

Parameters:project – the QGIS project
Returns:the owsService access constraints if defined in project.
owsServiceCapabilities(project: QgsProject) → bool

Returns if owsService capabilities are enabled.

Parameters:project – the QGIS project
Returns:if owsService capabilities are enabled.
owsServiceContactMail(project: QgsProject) → str

Returns the owsService contact mail defined in project.

Parameters:project – the QGIS project
Returns:the owsService contact mail if defined in project.
owsServiceContactOrganization(project: QgsProject) → str

Returns the owsService contact organization defined in project.

Parameters:project – the QGIS project
Returns:the owsService contact organization if defined in project.
owsServiceContactPerson(project: QgsProject) → str

Returns the owsService contact person defined in project.

Parameters:project – the QGIS project
Returns:the owsService contact person if defined in project.
owsServiceContactPhone(project: QgsProject) → str

Returns the owsService contact phone defined in project.

Parameters:project – the QGIS project
Returns:the owsService contact phone if defined in project.
owsServiceContactPosition(project: QgsProject) → str

Returns the owsService contact position defined in project.

Parameters:project – the QGIS project
Returns:the owsService contact position if defined in project.
owsServiceFees(project: QgsProject) → str

Returns the owsService fees defined in project.

Parameters:project – the QGIS project
Returns:the owsService fees if defined in project.
owsServiceKeywords(project: QgsProject) → List[str]

Returns the owsService keywords defined in project.

Parameters:project – the QGIS project
Returns:the owsService keywords if defined in project.
owsServiceOnlineResource(project: QgsProject) → str

Returns the owsService online resource defined in project.

Parameters:project – the QGIS project
Returns:the owsService online resource if defined in project.
owsServiceTitle(project: QgsProject) → str

Returns the owsService title defined in project.

Parameters:project – the QGIS project
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 – the QGIS project
Returns:the Layer ids list.
wcsServiceUrl(project: QgsProject) → str

Returns the WCS service url defined in a QGIS project.

Parameters:project – the QGIS project
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 – the QGIS project
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 – the QGIS project
  • layerId – the layer id in the project
Returns:

the layer precision for WFS GetFeature.

wfsServiceUrl(project: QgsProject) → str

Returns the WFS service url defined in a QGIS project.

Parameters:project – the QGIS project
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 – the QGIS project
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 – the QGIS project
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 – the QGIS project
Returns:the Layer ids list.
wmsExtent(project: QgsProject) → QgsRectangle

Returns the WMS Extent restriction.

Parameters:project – the QGIS project
Returns:the WMS Extent restriction.
wmsFeatureInfoAddWktGeometry(project: QgsProject) → bool

Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.

Parameters:project – the QGIS project
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 – the QGIS project
Returns:the document element name for XML GetFeatureInfo request.
wmsFeatureInfoDocumentElementNs(project: QgsProject) → str

Returns the document element namespace for XML GetFeatureInfo request.

Parameters:project – the QGIS project
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 – the QGIS project
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 – the QGIS project
Returns:the geometry precision for GetFeatureInfo request.
wmsFeatureInfoSchema(project: QgsProject) → str

Returns the schema URL for XML GetFeatureInfo request.

Parameters:project – the QGIS project
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 – the QGIS project
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 – the QGIS project
Returns:quality if defined in project, -1 otherwise.
wmsInfoFormatSia2045(project: QgsProject) → bool

Returns if the info format is SIA20145.

Parameters:project – the QGIS project
Returns:if the info format is SIA20145.
wmsInspireActivate(project: QgsProject) → bool

Returns if Inspire is activated.

Parameters:project – the QGIS project
Returns:if Inspire is activated.
wmsInspireLanguage(project: QgsProject) → str

Returns the Inspire language.

Parameters:project – the QGIS project
Returns:the Inspire language if defined in project.
wmsInspireMetadataDate(project: QgsProject) → str

Returns the Inspire metadata date.

Parameters:project – the QGIS project
Returns:the Inspire metadata date if defined in project.
wmsInspireMetadataUrl(project: QgsProject) → str

Returns the Inspire metadata URL.

Parameters:project – the QGIS project
Returns:the Inspire metadata URL if defined in project.
wmsInspireMetadataUrlType(project: QgsProject) → str

Returns the Inspire metadata URL type.

Parameters:project – the QGIS project
Returns:the Inspire metadata URL type if defined in project.
wmsInspireTemporalReference(project: QgsProject) → str

Returns the Inspire temporal reference.

Parameters:project – the QGIS project
Returns:the Inspire temporal reference if defined in project.
wmsMaxAtlasFeatures(project: QgsProject) → int

Returns the maximum number of atlas features which can be printed in a request

Parameters:project – the QGIS project
Returns:the number of atlas features
wmsMaxHeight(project: QgsProject) → int

Returns the maximum height for WMS images defined in a QGIS project.

Parameters:project – the QGIS project
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 – the QGIS project
Returns:width if defined in project, -1 otherwise.
wmsOutputCrsList(project: QgsProject) → List[str]

Returns the WMS output CRS list.

Parameters:project – the QGIS project
Returns:the WMS output CRS list.
wmsRestrictedComposers(project: QgsProject) → List[str]

Returns the restricted composer list.

Parameters:project – the QGIS project
Returns:the restricted composer list if defined in project.
wmsRestrictedLayers(project: QgsProject) → List[str]

Returns the restricted layer name list.

Parameters:project – the QGIS project
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 – the QGIS project
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 – the QGIS project
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 – the QGIS project
Returns:if layer ids are used as name.
wmtsServiceUrl(project: QgsProject) → str

Returns the WMTS service url defined in a QGIS project.

Parameters:project – the QGIS project
Returns:url if defined in project, an empty string otherwise.

New in version 3.4.