QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
Median cut implementation. More...
Classes | |
class | QgsBadRequestException |
Exception thrown in case of malformed request. More... | |
class | QgsMapRendererJobProxy |
Proxy for sequential or parallel map render job. More... | |
class | QgsRenderer |
Map renderer for WMS requests. More... | |
class | QgsSecurityException |
Exception thrown when data access violates access controls. More... | |
class | QgsServiceException |
Exception class for WMS service exceptions. More... | |
class | QgsWmsParameter |
WMS parameter received from the client. More... | |
class | QgsWmsParameters |
Provides an interface to retrieve and manipulate WMS parameters received from the client. More... | |
struct | QgsWmsParametersComposerMap |
struct | QgsWmsParametersExternalLayer |
struct | QgsWmsParametersFilter |
struct | QgsWmsParametersHighlightLayer |
struct | QgsWmsParametersLayer |
class | QgsWmsRenderContext |
Rendering context for the WMS renderer. More... | |
class | QgsWmsRestorer |
RAII class to restore the rendering context configuration on destruction. More... | |
class | Service |
OGC web service specialized for WMS. More... | |
Typedefs | |
typedef QList< QPair< QRgb, int > > | QgsColorBox |
typedef QMultiMap< int, QgsColorBox > | QgsColorBoxMap |
Enumerations | |
enum | ImageOutputFormat { UNKN , PNG , PNG8 , PNG16 , PNG1 , JPEG , WEBP } |
Supported image output format. More... | |
Functions | |
void | checkParameters (QgsWmsParameters ¶meters) |
checkParameters checks request parameters and sets SRCHEIGHT and SRCWIDTH to default values in case BBOX is specified for contextual legend and (SRC)HEIGHT or (SRC)WIDTH are not. More... | |
QDomDocument | describeLayer (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request) |
DescribeLayer is defined for WMS1.1.1/SLD1.0 and in WMS 1.3.0 SLD Extension. More... | |
QDomDocument | getCapabilities (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, bool projectSettings) |
Creates the WMS GetCapabilities XML document. More... | |
QDomElement | getCapabilityElement (QDomDocument &doc, const QgsProject *project, const QString &version, const QgsServerRequest &request, bool projectSettings, QgsServerInterface *serverIface) |
Create Capability element for get capabilities document. More... | |
QDomElement | getComposerTemplatesElement (QDomDocument &doc, const QgsProject *project) |
Create ComposerTemplates element for get capabilities document. More... | |
QDomDocument | getContext (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request) |
Returns XML document for the 'GetContext' request. More... | |
QDomElement | getInspireCapabilitiesElement (QDomDocument &doc, const QgsProject *project) |
Create InspireCapabilities element for get capabilities document. More... | |
QDomElement | getLayersAndStylesCapabilitiesElement (QDomDocument &doc, QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, bool projectSettings) |
Create element for get capabilities document. More... | |
QDomElement | getServiceElement (QDomDocument &doc, const QgsProject *project, const QString &version, const QgsServerRequest &request) |
Create Service element for get capabilities document. More... | |
QDomDocument | getStyle (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request) |
Returns an SLD file with the style of the requested layer. More... | |
QDomDocument | getStyles (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request) |
Returns an SLD file with the styles of the requested layers. More... | |
QDomElement | getWFSLayersElement (QDomDocument &doc, const QgsProject *project) |
Create WFSLayers element for get capabilities document. More... | |
bool | hasQueryableChildren (const QgsLayerTreeNode *childNode, const QStringList &wmsRestrictedLayers) |
QgsLayerTree * | layerTree (const QgsWmsRenderContext &context) |
QgsLayerTreeModel * | legendModel (const QgsWmsRenderContext &context, QgsLayerTree &tree) |
QgsLayerTreeModelLegendNode * | legendNode (const QString &rule, QgsLayerTreeModel &model) |
void | medianCut (QVector< QRgb > &colorTable, int nColors, const QImage &inputImage) |
Median cut implementation used when reducing RGB colors to palletized colors. More... | |
ImageOutputFormat | parseImageFormat (const QString &format) |
Parse image format parameter. More... | |
QUrl | serviceUrl (const QgsServerRequest &request, const QgsProject *project) |
Returns WMS service URL. More... | |
void | writeAsDxf (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetMap response in DXF format. More... | |
void | writeDescribeLayer (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetMap response in DXF format. More... | |
void | writeGetCapabilities (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response, bool projectSettings=false) |
Output GetCapabilities response. More... | |
void | writeGetContext (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetContext response. More... | |
void | writeGetFeatureInfo (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetFeatureInfo response. More... | |
void | writeGetLegendGraphics (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetLegendGRaphics response. More... | |
void | writeGetMap (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetMap response in DXF format. More... | |
void | writeGetPrint (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetPrint response. More... | |
void | writeGetSchemaExtension (QgsServerResponse &response) |
Output GetSchemaExtension response. More... | |
void | writeGetStyle (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetStyle response. More... | |
void | writeGetStyles (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response) |
Output GetStyles response. More... | |
void | writeImage (QgsServerResponse &response, QImage &img, const QString &formatStr, int imageQuality=-1) |
Write image response. More... | |
Median cut implementation.
WMS implementation.
WMS implementation
typedef QList< QPair<QRgb, int> > QgsWms::QgsColorBox |
Definition at line 31 of file qgsmediancut.cpp.
typedef QMultiMap< int, QgsColorBox > QgsWms::QgsColorBoxMap |
Definition at line 32 of file qgsmediancut.cpp.
Supported image output format.
Enumerator | |
---|---|
UNKN | |
PNG | |
PNG8 | |
PNG16 | |
PNG1 | |
JPEG | |
WEBP |
Definition at line 39 of file qgswmsutils.h.
void QgsWms::checkParameters | ( | QgsWmsParameters & | parameters | ) |
checkParameters checks request parameters and sets SRCHEIGHT and SRCWIDTH to default values in case BBOX is specified for contextual legend and (SRC)HEIGHT or (SRC)WIDTH are not.
Definition at line 174 of file qgswmsgetlegendgraphics.cpp.
QDomDocument QgsWms::describeLayer | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request | ||
) |
DescribeLayer is defined for WMS1.1.1/SLD1.0 and in WMS 1.3.0 SLD Extension.
Definition at line 40 of file qgswmsdescribelayer.cpp.
QDomDocument QgsWms::getCapabilities | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
bool | projectSettings | ||
) |
Creates the WMS GetCapabilities XML document.
serverIface | Interface for plugins |
project | Project |
version | WMS version |
request | WMS request |
projectSettings | If true , adds extended project information (does not validate against WMS schema) |
Definition at line 168 of file qgswmsgetcapabilities.cpp.
QDomElement QgsWms::getCapabilityElement | ( | QDomDocument & | doc, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
bool | projectSettings, | ||
QgsServerInterface * | serverIface | ||
) |
Create Capability element for get capabilities document.
Definition at line 417 of file qgswmsgetcapabilities.cpp.
QDomElement QgsWms::getComposerTemplatesElement | ( | QDomDocument & | doc, |
const QgsProject * | project | ||
) |
Create ComposerTemplates element for get capabilities document.
Definition at line 666 of file qgswmsgetcapabilities.cpp.
QDomDocument QgsWms::getContext | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request | ||
) |
Returns XML document for the 'GetContext' request.
Definition at line 89 of file qgswmsgetcontext.cpp.
QDomElement QgsWms::getInspireCapabilitiesElement | ( | QDomDocument & | doc, |
const QgsProject * | project | ||
) |
Create InspireCapabilities element for get capabilities document.
Definition at line 560 of file qgswmsgetcapabilities.cpp.
QDomElement QgsWms::getLayersAndStylesCapabilitiesElement | ( | QDomDocument & | doc, |
QgsServerInterface * | serverIface, | ||
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
bool | projectSettings | ||
) |
Create element for get capabilities document.
Definition at line 811 of file qgswmsgetcapabilities.cpp.
QDomElement QgsWms::getServiceElement | ( | QDomDocument & | doc, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request | ||
) |
Create Service element for get capabilities document.
Definition at line 257 of file qgswmsgetcapabilities.cpp.
QDomDocument QgsWms::getStyle | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request | ||
) |
Returns an SLD file with the style of the requested layer.
Definition at line 86 of file qgswmsgetstyles.cpp.
QDomDocument QgsWms::getStyles | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request | ||
) |
Returns an SLD file with the styles of the requested layers.
Exception is raised in case of troubles :-)
Definition at line 52 of file qgswmsgetstyles.cpp.
QDomElement QgsWms::getWFSLayersElement | ( | QDomDocument & | doc, |
const QgsProject * | project | ||
) |
Create WFSLayers element for get capabilities document.
Definition at line 781 of file qgswmsgetcapabilities.cpp.
bool QgsWms::hasQueryableChildren | ( | const QgsLayerTreeNode * | childNode, |
const QStringList & | wmsRestrictedLayers | ||
) |
Definition at line 2009 of file qgswmsgetcapabilities.cpp.
QgsLayerTree * QgsWms::layerTree | ( | const QgsWmsRenderContext & | context | ) |
Definition at line 307 of file qgswmsgetlegendgraphics.cpp.
QgsLayerTreeModel * QgsWms::legendModel | ( | const QgsWmsRenderContext & | context, |
QgsLayerTree & | tree | ||
) |
Definition at line 230 of file qgswmsgetlegendgraphics.cpp.
QgsLayerTreeModelLegendNode * QgsWms::legendNode | ( | const QString & | rule, |
QgsLayerTreeModel & | model | ||
) |
Definition at line 345 of file qgswmsgetlegendgraphics.cpp.
void QgsWms::medianCut | ( | QVector< QRgb > & | colorTable, |
int | nColors, | ||
const QImage & | inputImage | ||
) |
Median cut implementation used when reducing RGB colors to palletized colors.
Definition at line 256 of file qgsmediancut.cpp.
ImageOutputFormat QgsWms::parseImageFormat | ( | const QString & | format | ) |
QUrl QgsWms::serviceUrl | ( | const QgsServerRequest & | request, |
const QgsProject * | project | ||
) |
Returns WMS service URL.
Definition at line 32 of file qgswmsutils.cpp.
void QgsWms::writeAsDxf | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | , | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetMap response in DXF format.
Definition at line 24 of file qgsdxfwriter.cpp.
void QgsWms::writeDescribeLayer | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetMap response in DXF format.
Definition at line 31 of file qgswmsdescribelayer.cpp.
void QgsWms::writeGetCapabilities | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response, | ||
bool | projectSettings | ||
) |
Output GetCapabilities response.
Definition at line 93 of file qgswmsgetcapabilities.cpp.
void QgsWms::writeGetContext | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetContext response.
Definition at line 53 of file qgswmsgetcontext.cpp.
void QgsWms::writeGetFeatureInfo | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetFeatureInfo response.
Definition at line 27 of file qgswmsgetfeatureinfo.cpp.
void QgsWms::writeGetLegendGraphics | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | , | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetLegendGRaphics response.
Definition at line 39 of file qgswmsgetlegendgraphics.cpp.
void QgsWms::writeGetMap | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | , | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetMap response in DXF format.
Definition at line 31 of file qgswmsgetmap.cpp.
void QgsWms::writeGetPrint | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | , | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetPrint response.
Definition at line 28 of file qgswmsgetprint.cpp.
void QgsWms::writeGetSchemaExtension | ( | QgsServerResponse & | response | ) |
Output GetSchemaExtension response.
Definition at line 32 of file qgswmsgetschemaextension.cpp.
void QgsWms::writeGetStyle | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetStyle response.
Definition at line 78 of file qgswmsgetstyles.cpp.
void QgsWms::writeGetStyles | ( | QgsServerInterface * | serverIface, |
const QgsProject * | project, | ||
const QString & | version, | ||
const QgsServerRequest & | request, | ||
QgsServerResponse & | response | ||
) |
Output GetStyles response.
Definition at line 44 of file qgswmsgetstyles.cpp.
void QgsWms::writeImage | ( | QgsServerResponse & | response, |
QImage & | img, | ||
const QString & | formatStr, | ||
int | imageQuality | ||
) |
Write image response.
Definition at line 107 of file qgswmsutils.cpp.