QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
QgsWms::QgsRenderer Class Reference

Map renderer for WMS requests. More...

#include <qgswmsrenderer.h>

Public Types

typedef QHash< QgsVectorLayer *, SymbolSetHitTest
 
typedef QSet< QString > SymbolSet
 

Public Member Functions

 QgsRenderer (const QgsWmsRenderContext &context)
 Constructor for QgsRenderer.
 
 ~QgsRenderer ()
 
void configureLayers (QList< QgsMapLayer * > &layers, QgsMapSettings *settings=nullptr)
 Configures layers for rendering optionally considering the map settings.
 
std::unique_ptr< QgsDxfExportgetDxf ()
 Returns the map as DXF data.
 
QByteArray getFeatureInfo (const QString &version="1.3.0")
 Creates an xml document that describes the result of the getFeatureInfo request.
 
QImage * getLegendGraphics (QgsLayerTreeModel &model)
 Returns the map legend as an image (or nullptr in case of error).
 
QImage * getLegendGraphics (QgsLayerTreeModelLegendNode &nodeModel)
 Returns the map legend as an image (or nullptr in case of error).
 
QJsonObject getLegendGraphicsAsJson (QgsLayerTreeModel &model, const Qgis::LegendJsonRenderFlags &jsonRenderFlags=Qgis::LegendJsonRenderFlags())
 Returns the map legend as a JSON object.
 
QJsonObject getLegendGraphicsAsJson (QgsLayerTreeModelLegendNode &legendNode, const Qgis::LegendJsonRenderFlags &jsonRenderFlags=Qgis::LegendJsonRenderFlags())
 Returns the map legend as a JSON object (or nullptr in case of error).
 
QImage * getMap ()
 Returns the map as an image (or nullptr in case of error).
 
std::unique_ptr< QgsMapRendererTaskgetPdf (const QString &tmpFileName)
 Returns a configured pdf export task.
 
QByteArray getPrint ()
 Returns printed page as binary.
 
HitTest symbols ()
 Returns the hit test according to the current context.
 

Detailed Description

Map renderer for WMS requests.

Definition at line 67 of file qgswmsrenderer.h.

Member Typedef Documentation

◆ HitTest

Definition at line 119 of file qgswmsrenderer.h.

◆ SymbolSet

typedef QSet<QString> QgsWms::QgsRenderer::SymbolSet

Definition at line 118 of file qgswmsrenderer.h.

Constructor & Destructor Documentation

◆ QgsRenderer()

QgsWms::QgsRenderer::QgsRenderer ( const QgsWmsRenderContext context)

Constructor for QgsRenderer.

Parameters
contextThe rendering context.
Since
QGIS 3.8

Definition at line 103 of file qgswmsrenderer.cpp.

◆ ~QgsRenderer()

QgsWms::QgsRenderer::~QgsRenderer ( )

Definition at line 112 of file qgswmsrenderer.cpp.

Member Function Documentation

◆ configureLayers()

void QgsWms::QgsRenderer::configureLayers ( QList< QgsMapLayer * > &  layers,
QgsMapSettings settings = nullptr 
)

Configures layers for rendering optionally considering the map settings.

Definition at line 3827 of file qgswmsrenderer.cpp.

◆ getDxf()

std::unique_ptr< QgsDxfExport > QgsWms::QgsRenderer::getDxf ( )

Returns the map as DXF data.

Returns
the map as DXF data

Definition at line 1100 of file qgswmsrenderer.cpp.

◆ getFeatureInfo()

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 1254 of file qgswmsrenderer.cpp.

◆ getLegendGraphics() [1/2]

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.

Parameters
modelThe layer tree model to use for building the legend
Returns
the legend as an image
Since
QGIS 3.8

Definition at line 117 of file qgswmsrenderer.cpp.

◆ getLegendGraphics() [2/2]

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.

Parameters
nodeModelThe node model to use for building the legend
Returns
the legend as an image
Since
QGIS 3.8

Definition at line 204 of file qgswmsrenderer.cpp.

◆ getLegendGraphicsAsJson() [1/2]

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.

Parameters
modelThe layer tree model to use for building the legend
jsonRenderFlagsThe JSON export flags
Returns
the legend as a JSON object
Since
QGIS 3.36

Definition at line 245 of file qgswmsrenderer.cpp.

◆ getLegendGraphicsAsJson() [2/2]

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.

Parameters
legendNodeThe legend node to use for building the legend
jsonRenderFlagsThe JSON export flags
Returns
the legend as a JSON object
Since
QGIS 3.36

Definition at line 265 of file qgswmsrenderer.cpp.

◆ getMap()

QImage * QgsWms::QgsRenderer::getMap ( )

Returns the map as an image (or nullptr in case of error).

The caller takes ownership of the image object).

Since
QGIS 3.8

Definition at line 1047 of file qgswmsrenderer.cpp.

◆ getPdf()

std::unique_ptr< QgsMapRendererTask > QgsWms::QgsRenderer::getPdf ( const QString &  tmpFileName)

Returns a configured pdf export task.

Parameters
tmpFileNamethe name of the temporary file to store the pdf
Returns
pdf export object
Since
QGIS 3.36

Definition at line 1200 of file qgswmsrenderer.cpp.

◆ getPrint()

QByteArray QgsWms::QgsRenderer::getPrint ( )

Returns printed page as binary.

Returns
printed page as binary or 0 in case of error

Definition at line 387 of file qgswmsrenderer.cpp.

◆ symbols()

QgsRenderer::HitTest QgsWms::QgsRenderer::symbols ( )

Returns the hit test according to the current context.

Since
QGIS 3.8

Definition at line 352 of file qgswmsrenderer.cpp.


The documentation for this class was generated from the following files: