|
QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
|
Map renderer for WMS requests. More...
#include <qgswmsrenderer.h>
Public Types | |
| typedef QHash< QgsVectorLayer *, SymbolSet > | HitTest |
| typedef QSet< QString > | SymbolSet |
Public Member Functions | |
| QgsRenderer (const QgsWmsRenderContext &context) | |
| Constructor for QgsRenderer. More... | |
| ~QgsRenderer () | |
| Destructor for QgsRenderer. More... | |
| void | configureLayers (QList< QgsMapLayer * > &layers, QgsMapSettings *settings=nullptr) |
| Configures layers for rendering optionally considering the map settings. More... | |
| std::unique_ptr< QgsDxfExport > | getDxf () |
| Returns the map as DXF data. More... | |
| QByteArray | getFeatureInfo (const QString &version="1.3.0") |
| Creates an xml document that describes the result of the getFeatureInfo request. More... | |
| QImage * | getLegendGraphics (QgsLayerTreeModel &model) |
Returns the map legend as an image (or nullptr in case of error). More... | |
| QImage * | getLegendGraphics (QgsLayerTreeModelLegendNode &nodeModel) |
Returns the map legend as an image (or nullptr in case of error). More... | |
| QJsonObject | getLegendGraphicsAsJson (QgsLayerTreeModel &model, const Qgis::LegendJsonRenderFlags &jsonRenderFlags=Qgis::LegendJsonRenderFlags()) |
| Returns the map legend as a JSON object. More... | |
| QJsonObject | getLegendGraphicsAsJson (QgsLayerTreeModelLegendNode &legendNode, const Qgis::LegendJsonRenderFlags &jsonRenderFlags=Qgis::LegendJsonRenderFlags()) |
Returns the map legend as a JSON object (or nullptr in case of error). More... | |
| QImage * | getMap () |
Returns the map as an image (or nullptr in case of error). More... | |
| std::unique_ptr< QgsMapRendererTask > | getPdf (const QString &tmpFileName) |
| Returns a configured pdf export task. More... | |
| QByteArray | getPrint () |
| Returns printed page as binary. More... | |
| HitTest | symbols () |
| Returns the hit test according to the current context. More... | |
Map renderer for WMS requests.
Definition at line 67 of file qgswmsrenderer.h.
| typedef QHash<QgsVectorLayer *, SymbolSet> QgsWms::QgsRenderer::HitTest |
Definition at line 123 of file qgswmsrenderer.h.
| typedef QSet<QString> QgsWms::QgsRenderer::SymbolSet |
Definition at line 122 of file qgswmsrenderer.h.
| QgsWms::QgsRenderer::QgsRenderer | ( | const QgsWmsRenderContext & | context | ) |
Constructor for QgsRenderer.
| context | The rendering context. |
Definition at line 103 of file qgswmsrenderer.cpp.
| QgsWms::QgsRenderer::~QgsRenderer | ( | ) |
Destructor for QgsRenderer.
Definition at line 112 of file qgswmsrenderer.cpp.
| void QgsWms::QgsRenderer::configureLayers | ( | QList< QgsMapLayer * > & | layers, |
| QgsMapSettings * | settings = nullptr |
||
| ) |
Configures layers for rendering optionally considering the map settings.
Definition at line 3850 of file qgswmsrenderer.cpp.
| std::unique_ptr< QgsDxfExport > QgsWms::QgsRenderer::getDxf | ( | ) |
Returns the map as DXF data.
Definition at line 1088 of file qgswmsrenderer.cpp.
| QByteArray QgsWms::QgsRenderer::getFeatureInfo | ( | const QString & | version = "1.3.0" | ) |
Creates an xml document that describes the result of the getFeatureInfo request.
May throw an exception
Definition at line 1239 of file qgswmsrenderer.cpp.
| QImage * QgsWms::QgsRenderer::getLegendGraphics | ( | QgsLayerTreeModel & | model | ) |
Returns the map legend as an image (or nullptr in case of error).
The caller takes ownership of the image object.
| model | The layer tree model to use for building the legend |
Definition at line 117 of file qgswmsrenderer.cpp.
| QImage * QgsWms::QgsRenderer::getLegendGraphics | ( | QgsLayerTreeModelLegendNode & | nodeModel | ) |
Returns the map legend as an image (or nullptr in case of error).
The caller takes ownership of the image object.
| nodeModel | The node model to use for building the legend |
Definition at line 177 of file qgswmsrenderer.cpp.
| QJsonObject QgsWms::QgsRenderer::getLegendGraphicsAsJson | ( | QgsLayerTreeModel & | model, |
| const Qgis::LegendJsonRenderFlags & | jsonRenderFlags = Qgis::LegendJsonRenderFlags() |
||
| ) |
Returns the map legend as a JSON object.
The caller takes the ownership of the JSON object.
| model | The layer tree model to use for building the legend |
| jsonRenderFlags | The JSON export flags |
Definition at line 218 of file qgswmsrenderer.cpp.
| QJsonObject QgsWms::QgsRenderer::getLegendGraphicsAsJson | ( | QgsLayerTreeModelLegendNode & | legendNode, |
| const Qgis::LegendJsonRenderFlags & | jsonRenderFlags = Qgis::LegendJsonRenderFlags() |
||
| ) |
Returns the map legend as a JSON object (or nullptr in case of error).
The caller takes ownership of the image object.
| legendNode | The legend node to use for building the legend |
| jsonRenderFlags | The JSON export flags |
Definition at line 238 of file qgswmsrenderer.cpp.
| QImage * QgsWms::QgsRenderer::getMap | ( | ) |
Returns the map as an image (or nullptr in case of error).
The caller takes ownership of the image object).
Definition at line 1034 of file qgswmsrenderer.cpp.
| std::unique_ptr< QgsMapRendererTask > QgsWms::QgsRenderer::getPdf | ( | const QString & | tmpFileName | ) |
Returns a configured pdf export task.
| tmpFileName | the name of the temporary file to store the pdf |
Definition at line 1183 of file qgswmsrenderer.cpp.
| QByteArray QgsWms::QgsRenderer::getPrint | ( | ) |
Returns printed page as binary.
Definition at line 361 of file qgswmsrenderer.cpp.
| QgsRenderer::HitTest QgsWms::QgsRenderer::symbols | ( | ) |
Returns the hit test according to the current context.
Definition at line 325 of file qgswmsrenderer.cpp.
1.9.4