QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject. More...
Functions | |
SERVER_EXPORT double | ceilWithPrecision (double number, int places) |
Returns a double greater than number to the specified number of places. More... | |
SERVER_EXPORT double | floorWithPrecision (double number, int places) |
Returns a double less than number to the specified number of places. More... | |
SERVER_EXPORT QString | owsServiceAbstract (const QgsProject &project) |
Returns the owsService abstract defined in project. More... | |
SERVER_EXPORT QString | owsServiceAccessConstraints (const QgsProject &project) |
Returns the owsService access constraints defined in project. More... | |
SERVER_EXPORT bool | owsServiceCapabilities (const QgsProject &project) |
Returns if owsService capabilities are enabled. More... | |
SERVER_EXPORT QString | owsServiceContactMail (const QgsProject &project) |
Returns the owsService contact mail defined in project. More... | |
SERVER_EXPORT QString | owsServiceContactOrganization (const QgsProject &project) |
Returns the owsService contact organization defined in project. More... | |
SERVER_EXPORT QString | owsServiceContactPerson (const QgsProject &project) |
Returns the owsService contact person defined in project. More... | |
SERVER_EXPORT QString | owsServiceContactPhone (const QgsProject &project) |
Returns the owsService contact phone defined in project. More... | |
SERVER_EXPORT QString | owsServiceContactPosition (const QgsProject &project) |
Returns the owsService contact position defined in project. More... | |
SERVER_EXPORT QString | owsServiceFees (const QgsProject &project) |
Returns the owsService fees defined in project. More... | |
SERVER_EXPORT QStringList | owsServiceKeywords (const QgsProject &project) |
Returns the owsService keywords defined in project. More... | |
SERVER_EXPORT QString | owsServiceOnlineResource (const QgsProject &project) |
Returns the owsService online resource defined in project. More... | |
SERVER_EXPORT QString | owsServiceTitle (const QgsProject &project) |
Returns the owsService title defined in project. More... | |
SERVER_EXPORT QStringList | wcsLayerIds (const QgsProject &project) |
Returns the Layer ids list defined in a QGIS project as published in WCS. More... | |
SERVER_EXPORT QString | wcsServiceUrl (const QgsProject &project) |
Returns the WCS service url defined in a QGIS project. More... | |
SERVER_EXPORT QStringList | wfsLayerIds (const QgsProject &project) |
Returns the Layer ids list defined in a QGIS project as published in WFS. More... | |
SERVER_EXPORT int | wfsLayerPrecision (const QgsProject &project, const QString &layerId) |
Returns the Layer precision defined in a QGIS project for the WFS GetFeature. More... | |
SERVER_EXPORT QString | wfsServiceUrl (const QgsProject &project) |
Returns the WFS service url defined in a QGIS project. More... | |
SERVER_EXPORT QStringList | wfstDeleteLayerIds (const QgsProject &project) |
Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities. More... | |
SERVER_EXPORT QStringList | wfstInsertLayerIds (const QgsProject &project) |
Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities. More... | |
SERVER_EXPORT QStringList | wfstUpdateLayerIds (const QgsProject &project) |
Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities. More... | |
SERVER_EXPORT double | wmsDefaultMapUnitsPerMm (const QgsProject &project) |
Returns the default number of map units per millimeters in case of the scale is not given. More... | |
SERVER_EXPORT QgsRectangle | wmsExtent (const QgsProject &project) |
Returns the WMS Extent restriction. More... | |
SERVER_EXPORT bool | wmsFeatureInfoAddWktGeometry (const QgsProject &project) |
Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request. More... | |
SERVER_EXPORT QString | wmsFeatureInfoDocumentElement (const QgsProject &project) |
Returns the document element name for XML GetFeatureInfo request. More... | |
SERVER_EXPORT QString | wmsFeatureInfoDocumentElementNs (const QgsProject &project) |
Returns the document element namespace for XML GetFeatureInfo request. More... | |
SERVER_EXPORT QHash< QString, QString > | wmsFeatureInfoLayerAliasMap (const QgsProject &project) |
Returns the mapping between layer name and wms layer name for GetFeatureInfo request. More... | |
SERVER_EXPORT int | wmsFeatureInfoPrecision (const QgsProject &project) |
Returns the geometry precision for GetFeatureInfo request. More... | |
SERVER_EXPORT QString | wmsFeatureInfoSchema (const QgsProject &project) |
Returns the schema URL for XML GetFeatureInfo request. More... | |
SERVER_EXPORT bool | wmsFeatureInfoSegmentizeWktGeometry (const QgsProject &project) |
Returns if the geometry has to be segmentize in GetFeatureInfo request. More... | |
SERVER_EXPORT bool | wmsFeatureInfoUseAttributeFormSettings (const QgsProject &project) |
Returns if feature form settings should be considered for the format of the feature info response. More... | |
SERVER_EXPORT int | wmsImageQuality (const QgsProject &project) |
Returns the quality for WMS images defined in a QGIS project. More... | |
SERVER_EXPORT bool | wmsInfoFormatSia2045 (const QgsProject &project) |
Returns if the info format is SIA20145. More... | |
SERVER_EXPORT bool | wmsInspireActivate (const QgsProject &project) |
Returns if Inspire is activated. More... | |
SERVER_EXPORT QString | wmsInspireLanguage (const QgsProject &project) |
Returns the Inspire language. More... | |
SERVER_EXPORT QString | wmsInspireMetadataDate (const QgsProject &project) |
Returns the Inspire metadata date. More... | |
SERVER_EXPORT QString | wmsInspireMetadataUrl (const QgsProject &project) |
Returns the Inspire metadata URL. More... | |
SERVER_EXPORT QString | wmsInspireMetadataUrlType (const QgsProject &project) |
Returns the Inspire metadata URL type. More... | |
SERVER_EXPORT QString | wmsInspireTemporalReference (const QgsProject &project) |
Returns the Inspire temporal reference. More... | |
SERVER_EXPORT int | wmsMaxAtlasFeatures (const QgsProject &project) |
Returns the maximum number of atlas features which can be printed in a request. More... | |
SERVER_EXPORT int | wmsMaxHeight (const QgsProject &project) |
Returns the maximum height for WMS images defined in a QGIS project. More... | |
SERVER_EXPORT int | wmsMaxWidth (const QgsProject &project) |
Returns the maximum width for WMS images defined in a QGIS project. More... | |
SERVER_EXPORT QStringList | wmsOutputCrsList (const QgsProject &project) |
Returns the WMS output CRS list. More... | |
SERVER_EXPORT bool | wmsRenderMapTiles (const QgsProject &project) |
Returns true if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible artifacts are visible between adjacent tiles. More... | |
SERVER_EXPORT QStringList | wmsRestrictedComposers (const QgsProject &project) |
Returns the restricted composer list. More... | |
SERVER_EXPORT QStringList | wmsRestrictedLayers (const QgsProject &project) |
Returns the restricted layer name list. More... | |
SERVER_EXPORT QString | wmsRootName (const QgsProject &project) |
Returns the WMS root layer name defined in a QGIS project. More... | |
SERVER_EXPORT QString | wmsServiceUrl (const QgsProject &project) |
Returns the WMS service url defined in a QGIS project. More... | |
SERVER_EXPORT int | wmsTileBuffer (const QgsProject &project) |
Returns the tile buffer in pixels for WMS images defined in a QGIS project. More... | |
SERVER_EXPORT bool | wmsUseLayerIds (const QgsProject &project) |
Returns if layer ids are used as name in WMS. More... | |
SERVER_EXPORT QString | wmtsServiceUrl (const QgsProject &project) |
Returns the WMTS service url defined in a QGIS project. More... | |
The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject.
double QgsServerProjectUtils::ceilWithPrecision | ( | double | number, |
int | places | ||
) |
Returns a double greater than number to the specified number of places.
Definition at line 21 of file qgsserverprojectutils.cpp.
double QgsServerProjectUtils::floorWithPrecision | ( | double | number, |
int | places | ||
) |
Returns a double less than number to the specified number of places.
Definition at line 27 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceAbstract | ( | const QgsProject & | project | ) |
Returns the owsService abstract defined in project.
project | the QGIS project |
Definition at line 52 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceAccessConstraints | ( | const QgsProject & | project | ) |
Returns the owsService access constraints defined in project.
project | the QGIS project |
Definition at line 119 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::owsServiceCapabilities | ( | const QgsProject & | project | ) |
Returns if owsService capabilities are enabled.
project | the QGIS project |
Definition at line 33 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceContactMail | ( | const QgsProject & | project | ) |
Returns the owsService contact mail defined in project.
project | the QGIS project |
Definition at line 104 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceContactOrganization | ( | const QgsProject & | project | ) |
Returns the owsService contact organization defined in project.
project | the QGIS project |
Definition at line 89 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceContactPerson | ( | const QgsProject & | project | ) |
Returns the owsService contact person defined in project.
project | the QGIS project |
Definition at line 99 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceContactPhone | ( | const QgsProject & | project | ) |
Returns the owsService contact phone defined in project.
project | the QGIS project |
Definition at line 109 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceContactPosition | ( | const QgsProject & | project | ) |
Returns the owsService contact position defined in project.
project | the QGIS project |
Definition at line 94 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceFees | ( | const QgsProject & | project | ) |
Returns the owsService fees defined in project.
project | the QGIS project |
Definition at line 114 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::owsServiceKeywords | ( | const QgsProject & | project | ) |
Returns the owsService keywords defined in project.
project | the QGIS project |
Definition at line 57 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceOnlineResource | ( | const QgsProject & | project | ) |
Returns the owsService online resource defined in project.
project | the QGIS project |
Definition at line 75 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::owsServiceTitle | ( | const QgsProject & | project | ) |
Returns the owsService title defined in project.
project | the QGIS project |
Definition at line 38 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wcsLayerIds | ( | const QgsProject & | project | ) |
Returns the Layer ids list defined in a QGIS project as published in WCS.
project | the QGIS project |
Definition at line 383 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wcsServiceUrl | ( | const QgsProject & | project | ) |
Returns the WCS service url defined in a QGIS project.
project | the QGIS project |
Definition at line 378 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wfsLayerIds | ( | const QgsProject & | project | ) |
Returns the Layer ids list defined in a QGIS project as published in WFS.
project | the QGIS project |
Definition at line 353 of file qgsserverprojectutils.cpp.
int QgsServerProjectUtils::wfsLayerPrecision | ( | const QgsProject & | project, |
const QString & | layerId | ||
) |
Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
project | the QGIS project |
layerId | the layer id in the project |
Definition at line 358 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wfsServiceUrl | ( | const QgsProject & | project | ) |
Returns the WFS service url defined in a QGIS project.
project | the QGIS project |
Definition at line 348 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wfstDeleteLayerIds | ( | const QgsProject & | project | ) |
Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.
project | the QGIS project |
Definition at line 373 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wfstInsertLayerIds | ( | const QgsProject & | project | ) |
Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.
project | the QGIS project |
Definition at line 368 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wfstUpdateLayerIds | ( | const QgsProject & | project | ) |
Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.
project | the QGIS project |
Definition at line 363 of file qgsserverprojectutils.cpp.
double QgsServerProjectUtils::wmsDefaultMapUnitsPerMm | ( | const QgsProject & | project | ) |
Returns the default number of map units per millimeters in case of the scale is not given.
project | the QGIS project |
Definition at line 154 of file qgsserverprojectutils.cpp.
QgsRectangle QgsServerProjectUtils::wmsExtent | ( | const QgsProject & | project | ) |
Returns the WMS Extent restriction.
project | the QGIS project |
Definition at line 332 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::wmsFeatureInfoAddWktGeometry | ( | const QgsProject & | project | ) |
Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.
project | the QGIS project |
Definition at line 167 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsFeatureInfoDocumentElement | ( | const QgsProject & | project | ) |
Returns the document element name for XML GetFeatureInfo request.
project | the QGIS project |
Definition at line 195 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsFeatureInfoDocumentElementNs | ( | const QgsProject & | project | ) |
Returns the document element namespace for XML GetFeatureInfo request.
project | the QGIS project |
Definition at line 200 of file qgsserverprojectutils.cpp.
QHash< QString, QString > QgsServerProjectUtils::wmsFeatureInfoLayerAliasMap | ( | const QgsProject & | project | ) |
Returns the mapping between layer name and wms layer name for GetFeatureInfo request.
project | the QGIS project |
Definition at line 210 of file qgsserverprojectutils.cpp.
int QgsServerProjectUtils::wmsFeatureInfoPrecision | ( | const QgsProject & | project | ) |
Returns the geometry precision for GetFeatureInfo request.
project | the QGIS project |
Definition at line 190 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsFeatureInfoSchema | ( | const QgsProject & | project | ) |
Returns the schema URL for XML GetFeatureInfo request.
project | the QGIS project |
Definition at line 205 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::wmsFeatureInfoSegmentizeWktGeometry | ( | const QgsProject & | project | ) |
Returns if the geometry has to be segmentize in GetFeatureInfo request.
project | the QGIS project |
Definition at line 182 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::wmsFeatureInfoUseAttributeFormSettings | ( | const QgsProject & | project | ) |
Returns if feature form settings should be considered for the format of the feature info response.
project | the QGIS project |
Definition at line 175 of file qgsserverprojectutils.cpp.
int QgsServerProjectUtils::wmsImageQuality | ( | const QgsProject & | project | ) |
Returns the quality for WMS images defined in a QGIS project.
project | the QGIS project |
Definition at line 139 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::wmsInfoFormatSia2045 | ( | const QgsProject & | project | ) |
Returns if the info format is SIA20145.
project | the QGIS project |
Definition at line 159 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::wmsInspireActivate | ( | const QgsProject & | project | ) |
Returns if Inspire is activated.
project | the QGIS project |
Definition at line 237 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsInspireLanguage | ( | const QgsProject & | project | ) |
Returns the Inspire language.
project | the QGIS project |
Definition at line 242 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsInspireMetadataDate | ( | const QgsProject & | project | ) |
Returns the Inspire metadata date.
project | the QGIS project |
Definition at line 262 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsInspireMetadataUrl | ( | const QgsProject & | project | ) |
Returns the Inspire metadata URL.
project | the QGIS project |
Definition at line 247 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsInspireMetadataUrlType | ( | const QgsProject & | project | ) |
Returns the Inspire metadata URL type.
project | the QGIS project |
Definition at line 252 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsInspireTemporalReference | ( | const QgsProject & | project | ) |
Returns the Inspire temporal reference.
project | the QGIS project |
Definition at line 257 of file qgsserverprojectutils.cpp.
int QgsServerProjectUtils::wmsMaxAtlasFeatures | ( | const QgsProject & | project | ) |
Returns the maximum number of atlas features which can be printed in a request.
project | the QGIS project |
Definition at line 149 of file qgsserverprojectutils.cpp.
int QgsServerProjectUtils::wmsMaxHeight | ( | const QgsProject & | project | ) |
Returns the maximum height for WMS images defined in a QGIS project.
project | the QGIS project |
Definition at line 129 of file qgsserverprojectutils.cpp.
int QgsServerProjectUtils::wmsMaxWidth | ( | const QgsProject & | project | ) |
Returns the maximum width for WMS images defined in a QGIS project.
project | the QGIS project |
Definition at line 124 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wmsOutputCrsList | ( | const QgsProject & | project | ) |
Returns the WMS output CRS list.
project | the QGIS project |
Definition at line 272 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::wmsRenderMapTiles | ( | const QgsProject & | project | ) |
Returns true
if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible artifacts are visible between adjacent tiles.
This flag can slow down rendering considerably, so it is only used if the corresponding setting is enabled in the project.
project | the QGIS project |
true
if the flag should be used, or false
if not.Definition at line 393 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wmsRestrictedComposers | ( | const QgsProject & | project | ) |
Returns the restricted composer list.
project | the QGIS project |
Definition at line 267 of file qgsserverprojectutils.cpp.
QStringList QgsServerProjectUtils::wmsRestrictedLayers | ( | const QgsProject & | project | ) |
Returns the restricted layer name list.
project | the QGIS project |
Definition at line 327 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsRootName | ( | const QgsProject & | project | ) |
Returns the WMS root layer name defined in a QGIS project.
project | the QGIS project |
Definition at line 322 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmsServiceUrl | ( | const QgsProject & | project | ) |
Returns the WMS service url defined in a QGIS project.
project | the QGIS project |
Definition at line 317 of file qgsserverprojectutils.cpp.
int QgsServerProjectUtils::wmsTileBuffer | ( | const QgsProject & | project | ) |
Returns the tile buffer in pixels for WMS images defined in a QGIS project.
project | the QGIS project |
Definition at line 144 of file qgsserverprojectutils.cpp.
bool QgsServerProjectUtils::wmsUseLayerIds | ( | const QgsProject & | project | ) |
Returns if layer ids are used as name in WMS.
project | the QGIS project |
Definition at line 134 of file qgsserverprojectutils.cpp.
QString QgsServerProjectUtils::wmtsServiceUrl | ( | const QgsProject & | project | ) |
Returns the WMTS service url defined in a QGIS project.
project | the QGIS project |
Definition at line 388 of file qgsserverprojectutils.cpp.