77#include <QTemporaryFile>
80#include <nlohmann/json.hpp>
104 : mContext( context )
109 mWmsParameters.
dump();
114 removeTemporaryLayers();
120 std::unique_ptr<QgsWmsRestorer> restorer;
133 if ( !mWmsParameters.
bbox().isEmpty() )
137 std::unique_ptr<QImage> tmp( createImage( mContext.
mapSize(
false ) ) );
138 configureMapSettings( tmp.get(), mapSettings );
144 context = configureDefaultRenderContext();
148 std::unique_ptr<QImage> image;
150 const QSizeF minSize = renderer.
minimumSize( &context );
151 const QSize size(
static_cast<int>( minSize.width() * dpmm ),
static_cast<int>( minSize.height() * dpmm ) );
156 image.reset( createImage( size ) );
159 QPainter painter( image.get() );
162 if ( painter.renderHints() & QPainter::SmoothPixmapTransform )
164 if ( painter.renderHints() & QPainter::LosslessImageRendering )
174 return image.release();
180 std::unique_ptr<QgsWmsRestorer> restorer;
194 std::unique_ptr<QImage> image( createImage( size ) );
198 std::unique_ptr<QPainter> painter;
199 painter.reset(
new QPainter( image.get() ) );
200 painter->setRenderHint( QPainter::Antialiasing,
true );
201 painter->scale( dpmm, dpmm );
212 nodeModel.
drawSymbol( settings, &ctx, size.height() / dpmm );
215 return image.release();
221 std::unique_ptr<QgsWmsRestorer> restorer;
241 std::unique_ptr<QgsWmsRestorer> restorer;
261 if ( vLayer->renderer() )
265 const QString ruleExp { vLayer->renderer()->legendKeyToExpression( ruleKey, vLayer, ok ) };
268 jsonSymbol[ QStringLiteral(
"rule" ) ] = ruleExp;
277 void QgsRenderer::runHitTest(
const QgsMapSettings &mapSettings, HitTest &hitTest )
const
281 for (
const QString &
id : mapSettings.layerIds() )
298 runHitTestLayer( vl, usedSymbols, context );
304 std::unique_ptr< QgsFeatureRenderer > r( vl->
renderer()->
clone() );
306 r->startRender( context, vl->
fields() );
314 if ( moreSymbolsPerFeature )
316 for (
QgsSymbol *s : r->originalSymbolsForFeature( f, context ) )
322 r->stopRender( context );
331 QStringLiteral(
"The requested map size is too large" ) );
335 std::unique_ptr<QgsWmsRestorer> restorer;
345 std::unique_ptr<QPainter> painter;
346 std::unique_ptr<QImage> image( createImage( mContext.
mapSize() ) );
349 configureMapSettings( image.get(), mapSettings );
356 runHitTest( mapSettings,
symbols );
364 std::unique_ptr<QgsWmsRestorer> restorer;
369 if ( templateName.isEmpty() )
393 QStringLiteral(
"The template has no pages" ) );
396 std::unique_ptr<QgsPrintLayout> layout( sourceLayout->
clone() );
400 QStringList atlasPk = mWmsParameters.
atlasPk();
401 if ( !atlasPk.isEmpty() )
403 atlas = layout->atlas();
404 if ( !atlas || !atlas->
enabled() )
408 QStringLiteral(
"The template has no atlas enabled" ) );
415 QStringLiteral(
"The atlas has no coverage layer" ) );
419 if ( atlasPk.size() == 1 && atlasPk.at( 0 ) == QLatin1String(
"*" ) )
423 if ( atlas->
count() > maxAtlasFeatures )
426 QString(
"The project configuration allows printing maximum %1 atlas features at a time" ).arg( maxAtlasFeatures ) );
432 if ( pkIndexes.size() == 0 )
434 QgsDebugMsgLevel( QStringLiteral(
"Atlas print: layer %1 has no primary key attributes" ).arg( cLayer->
name() ), 2 );
438 const int pkIndexesSize {std::max< int >( pkIndexes.size(), 1 )};
440 QStringList pkAttributeNames;
441 for (
int pkIndex : std::as_const( pkIndexes ) )
443 pkAttributeNames.append( cLayer->
fields().
at( pkIndex ).
name() );
446 const int nAtlasFeatures = atlasPk.size() / pkIndexesSize;
447 if ( nAtlasFeatures * pkIndexesSize != atlasPk.size() )
450 QStringLiteral(
"Wrong number of ATLAS_PK parameters" ) );
454 if ( nAtlasFeatures > maxAtlasFeatures )
457 QString(
"%1 atlas features have been requested, but the project configuration only allows printing %2 atlas features at a time" )
458 .arg( nAtlasFeatures ).arg( maxAtlasFeatures ) );
461 QString filterString;
462 int currentAtlasPk = 0;
464 for (
int i = 0; i < nAtlasFeatures; ++i )
468 filterString.append(
" OR " );
471 filterString.append(
"( " );
474 if ( pkAttributeNames.isEmpty() )
476 filterString.append( QStringLiteral(
"$id = %1" ).arg( atlasPk.at( currentAtlasPk ) ) );
481 for (
int j = 0; j < pkIndexes.size(); ++j )
485 filterString.append(
" AND " );
492 filterString.append(
" )" );
501 if ( !errorString.isEmpty() )
503 throw QgsException( QStringLiteral(
"An error occurred during the Atlas print: %1" ).arg( errorString ) );
516 std::unique_ptr<QImage> image(
new QImage() );
517 configureMapSettings( image.get(), mapSettings );
523 configurePrintLayout( layout.get(), mapSettings, atlas );
527 const QList<QgsMapLayer *> lyrs = mapSettings.
layers();
529#ifdef HAVE_SERVER_PYTHON_PLUGINS
530 mContext.accessControl()->resolveFilterFeatures( lyrs );
534 QHash<const QgsVectorLayer *, QStringList> fltrs;
539 fltrs.insert( vl, dimensionFilter( vl ) );
551 QTemporaryFile tempOutputFile( QDir::tempPath() +
'/' + QStringLiteral(
"XXXXXX.%1" ).arg( extension ) );
552 if ( !tempOutputFile.open() )
554 throw QgsException( QStringLiteral(
"Could not open temporary file for the GetPrint request." ) );
563 if ( !mWmsParameters.
dpi().isEmpty() )
566 double dpi( mWmsParameters.
dpi().toDouble( &ok ) );
568 exportSettings.
dpi = dpi;
581 atlasSvgExport.
exportToSvg( tempOutputFile.fileName(), exportSettings );
587 exporter.
exportToSvg( tempOutputFile.fileName(), exportSettings );
596 double dpi( layout->renderContext().dpi( ) );
597 if ( !mWmsParameters.
dpi().isEmpty() )
600 double _dpi = mWmsParameters.
dpi().toDouble( &ok );
604 exportSettings.
dpi = dpi;
610 QgsLayoutSize layoutSize( layout->pageCollection()->page( 0 )->sizeWithUnits() );
615 const QSize imageSize = QSize(
static_cast<int>( width.
length() * dpi / 25.4 ),
static_cast<int>( height.
length() * dpi / 25.4 ) );
617 const QString paramWidth = mWmsParameters.
width();
618 const QString paramHeight = mWmsParameters.
height();
623 if ( !paramWidth.isEmpty() && !paramHeight.isEmpty() )
625 exportSettings.
imageSize = QSize( paramWidth.toInt(), paramHeight.toInt() );
627 else if ( !paramWidth.isEmpty() && paramHeight.isEmpty() )
629 exportSettings.
imageSize = QSize( paramWidth.toInt(),
static_cast<double>( paramWidth.toInt() ) / imageSize.width() * imageSize.height() );
631 else if ( paramWidth.isEmpty() && !paramHeight.isEmpty() )
633 exportSettings.
imageSize = QSize(
static_cast<double>( paramHeight.toInt() ) / imageSize.height() * imageSize.width(), paramHeight.toInt() );
641 exportSettings.
pages.append( 0 );
649 atlasPngExport.
exportToImage( tempOutputFile.fileName(), exportSettings );
653 throw QgsServiceException( QStringLiteral(
"Bad request" ), QStringLiteral(
"Atlas error: empty atlas." ), QString(), 400 );
659 exporter.
exportToImage( tempOutputFile.fileName(), exportSettings );
667 if ( !mWmsParameters.
dpi().isEmpty() )
670 double dpi( mWmsParameters.
dpi().toDouble( &ok ) );
672 exportSettings.
dpi = dpi;
677 exportSettings.
rasterizeWholeImage = layout->customProperty( QStringLiteral(
"rasterize" ),
false ).toBool();
680 if ( requestMapScales.size() > 0 )
690 if ( exportThemes.size() > 0 )
718 exporter.
exportToPdf( tempOutputFile.fileName(), exportSettings );
729 handlePrintErrors( atlas->
layout() );
733 handlePrintErrors( layout.get() );
736 return tempOutputFile.readAll();
744 QList<QgsLayoutItemMap *> maps;
750 for (
const auto &map : std::as_const( maps ) )
756 if ( cMapParams.
mLayers.isEmpty() )
761 if ( !atlas || !map->atlasDriven() )
767 c->removeLayoutItem( map );
785 if ( cMapParams.
mScale > 0 )
787 map->setScale(
static_cast<double>( cMapParams.
mScale ) );
793 map->setMapRotation( cMapParams.
mRotation );
797 if ( !map->keepLayerSet() )
800 QList<QgsMapLayer *> layerSet;
802 for (
const auto &layer : std::as_const( cMapParams.mLayers ) )
806 QList<QgsMapLayer *> layersFromGroup;
808 const QList<QgsMapLayer *> cLayersFromGroup = mContext.
layersFromGroup( layer.mNickname );
809 for (
QgsMapLayer *layerFromGroup : cLayersFromGroup )
812 if ( ! layerFromGroup )
817 layersFromGroup.push_front( layerFromGroup );
820 if ( !layersFromGroup.isEmpty() )
822 layerSet.append( layersFromGroup );
834 setLayerStyle( mlayer, layer.mStyle );
839 std::reverse( layerSet.begin(), layerSet.end() );
844 QMap<QString, QString> layersStyle;
845 if ( map->followVisibilityPreset() )
856 const QString presetName = map->followVisibilityPresetName();
857 if ( layerSet.isEmpty() )
861 layerSet = map->layersToRender( &ex );
864 map->setFollowVisibilityPreset(
false );
868 for (
const auto &layerMapThemeRecord : std::as_const( mapThemeRecords ) )
870 if ( layerSet.contains( layerMapThemeRecord.layer() ) )
872 layersStyle.insert( layerMapThemeRecord.layer()->id(),
873 layerMapThemeRecord.layer()->styleManager()->style( layerMapThemeRecord.currentStyle ).xmlData() );
879 const QList< QgsMapLayer *> highlights = highlightLayers( cMapParams.
mHighlightLayers );
880 for (
const auto &hl : std::as_const( highlights ) )
882 layerSet.prepend( hl );
885 map->setLayers( layerSet );
886 map->setKeepLayerSet(
true );
890 if ( !layersStyle.isEmpty() )
892 map->setLayerStyleOverrides( layersStyle );
893 map->setKeepLayerStyles(
true );
900 map->grid()->setIntervalX(
static_cast<double>( cMapParams.
mGridX ) );
901 map->grid()->setIntervalY(
static_cast<double>( cMapParams.
mGridY ) );
906 QList<QgsLayoutItemLabel *> labels;
908 for (
const auto &label : std::as_const( labels ) )
911 const QString labelId = label->
id();
912 const QString labelParam = mWmsParameters.
layoutParameter( labelId, ok );
917 if ( labelParam.isEmpty() )
921 c->removeItem( label );
926 label->setText( labelParam );
930 QList<QgsLayoutItemHtml *> htmls;
932 for (
const auto &html : std::as_const( htmls ) )
934 if ( html->frameCount() == 0 )
939 const QString htmlId = htmlFrame->
id();
952 c->removeMultiFrame( html );
958 html->setUrl( newUrl );
964 QList<QgsLayoutItemLegend *> legends;
966 for (
const auto &legend : std::as_const( legends ) )
968 if ( legend->autoUpdateModel() )
978 legend->setAutoUpdateModel(
false );
982 QStringList layerSet;
983 QList<QgsMapLayer *> mapLayers;
984 if ( map->
layers().isEmpty() )
988 mapLayers = mProject->
mapLayers(
true ).values();
992 mapLayers = map->
layers();
994 const QList<QgsMapLayer *> layerList = mapLayers;
995 for (
const auto &layer : layerList )
996 layerSet << layer->id();
1008 for (
const auto &layerId : layerIds )
1015 if ( !layerSet.contains( layerId ) )
1017 qobject_cast<QgsLayerTreeGroup *>( nodeLayer->
parent() )->removeChildNode( nodeLayer );
1024 qobject_cast<QgsLayerTreeGroup *>( nodeLayer->
parent() )->removeChildNode( nodeLayer );
1040 QStringLiteral(
"The requested map size is too large" ) );
1044 std::unique_ptr<QgsWmsRestorer> restorer;
1055 std::unique_ptr<QPainter> painter;
1056 std::unique_ptr<QImage> image( createImage( mContext.
mapSize() ) );
1059 configureMapSettings( image.get(), mapSettings );
1065 QPainter *renderedPainter = layersRendering( mapSettings, *image );
1066 if ( !renderedPainter )
1071 painter.reset( renderedPainter );
1074 annotationsRendering( painter.get(), mapSettings );
1080 QImage *scaledImage = scaleImage( image.get() );
1082 image.reset( scaledImage );
1085 return image.release();
1096 QList< QgsDxfExport::DxfLayer > dxfLayers;
1108 int layerAttribute = -1;
1109 if ( attributes.size() > layerIdx )
1120 QString
crs = mWmsParameters.
crs();
1121 if (
crs.compare( QStringLiteral(
"CRS:84" ), Qt::CaseInsensitive ) == 0 )
1123 crs = QStringLiteral(
"EPSG:4326" );
1126 else if (
crs.isEmpty() )
1128 crs = QStringLiteral(
"EPSG:4326" );
1162 std::unique_ptr<QgsDxfExport> dxf = std::make_unique<QgsDxfExport>();
1163 dxf->setExtent( mapExtent );
1164 dxf->setDestinationCrs( outputCRS );
1165 dxf->addLayers( dxfLayers );
1167 dxf->setSymbologyExport( mWmsParameters.
dxfMode() );
1170 dxf->setSymbologyScale( mWmsParameters.
dxfScale() );
1173 dxf->setForce2d( mWmsParameters.
isForce2D() );
1174 QgsDxfExport::Flags flags;
1175 if ( mWmsParameters.
noMText() )
1178 dxf->setFlags( flags );
1206 std::unique_ptr<QgsMapRendererTask> pdf = std::make_unique<QgsMapRendererTask>( ms, tmpFileName, QStringLiteral(
"PDF" ),
false,
QgsTask::Hidden, geoPdf, pdfExportDetails );
1209 pdf->setSaveWorldFile(
true );
1217 if ( i < 0 || i > mapSettings.
outputSize().width() )
1225 if ( j < 0 || j > mapSettings.
outputSize().height() )
1250 const bool ijDefined = !mWmsParameters.
i().isEmpty() && !mWmsParameters.
j().isEmpty();
1251 const bool xyDefined = !mWmsParameters.
x().isEmpty() && !mWmsParameters.
y().isEmpty();
1252 const bool filtersDefined = !mWmsParameters.
filters().isEmpty();
1253 const bool filterGeomDefined = !mWmsParameters.
filterGeom().isEmpty();
1255 if ( !ijDefined && !xyDefined && !filtersDefined && !filterGeomDefined )
1259 if ( mWmsParameters.
j().isEmpty() )
1273 std::unique_ptr<QImage> outputImage( createImage( mContext.
mapSize() ) );
1276 std::unique_ptr<QgsWmsRestorer> restorer;
1281 bool mandatoryCrsParam =
true;
1282 if ( filtersDefined && !ijDefined && !xyDefined && mWmsParameters.
crs().isEmpty() )
1284 mandatoryCrsParam =
false;
1290 configureMapSettings( outputImage.get(), mapSettings, mandatoryCrsParam );
1306#ifdef HAVE_SERVER_PYTHON_PLUGINS
1307 mContext.accessControl()->resolveFilterFeatures( mapSettings.
layers() );
1310 QDomDocument result = featureInfoDocument( layers, mapSettings, outputImage.get(), version );
1315 ba = convertFeatureInfoToText( result );
1317 ba = convertFeatureInfoToHtml( result );
1319 ba = convertFeatureInfoToJson( layers, result );
1321 ba = result.toByteArray();
1326 QImage *QgsRenderer::createImage(
const QSize &size )
const
1328 std::unique_ptr<QImage> image;
1336 image = std::make_unique<QImage>( size, QImage::Format_ARGB32_Premultiplied );
1341 image = std::make_unique<QImage>( size, QImage::Format_RGB32 );
1346 if ( image->isNull() )
1348 throw QgsException( QStringLiteral(
"createImage: image could not be created, check for out of memory conditions" ) );
1351 const int dpm =
static_cast<int>( mContext.
dotsPerMm() * 1000.0 );
1352 image->setDotsPerMeterX( dpm );
1353 image->setDotsPerMeterY( dpm );
1355 return image.release();
1358 void QgsRenderer::configureMapSettings(
const QPaintDevice *paintDevice,
QgsMapSettings &mapSettings,
bool mandatoryCrsParam )
1362 throw QgsException( QStringLiteral(
"configureMapSettings: no paint device" ) );
1365 mapSettings.
setOutputSize( QSize( paintDevice->width(), paintDevice->height() ) );
1372 if ( !mWmsParameters.
bbox().isEmpty() && mapExtent.
isEmpty() )
1378 QString
crs = mWmsParameters.
crs();
1379 if (
crs.compare(
"CRS:84", Qt::CaseInsensitive ) == 0 )
1381 crs = QString(
"EPSG:4326" );
1384 else if (
crs.isEmpty() && !mandatoryCrsParam )
1386 crs = QString(
"EPSG:4326" );
1396 QgsWmsParameter parameter;
1438 else if ( backgroundColor.isValid() )
1467 const QString timeString { mWmsParameters.
dimensionValues().value( QStringLiteral(
"TIME" ), QString() ) };
1468 if ( ! timeString.isEmpty() )
1470 bool isValidTemporalRange {
true };
1473 const QDateTime dt { QDateTime::fromString( timeString, Qt::DateFormat::ISODateWithMs ) };
1486 isValidTemporalRange =
false;
1491 if ( isValidTemporalRange )
1501 QgsRenderContext QgsRenderer::configureDefaultRenderContext( QPainter *painter )
1514 QDomDocument QgsRenderer::featureInfoDocument( QList<QgsMapLayer *> &layers,
const QgsMapSettings &mapSettings,
1515 const QImage *outputImage,
const QString &version )
const
1519 bool ijDefined = ( !mWmsParameters.
i().isEmpty() && !mWmsParameters.
j().isEmpty() );
1521 bool xyDefined = ( !mWmsParameters.
x().isEmpty() && !mWmsParameters.
y().isEmpty() );
1523 bool filtersDefined = !mWmsParameters.
filters().isEmpty();
1525 bool filterGeomDefined = !mWmsParameters.
filterGeom().isEmpty();
1528 if ( featureCount < 1 )
1533 int i = mWmsParameters.
iAsInt();
1534 int j = mWmsParameters.
jAsInt();
1535 if ( xyDefined && !ijDefined )
1537 i = mWmsParameters.
xAsInt();
1538 j = mWmsParameters.
yAsInt();
1542 if ( ( i != -1 && j != -1 && width != 0 && height != 0 ) && ( width != outputImage->width() || height != outputImage->height() ) )
1544 i *= ( outputImage->width() /
static_cast<double>( width ) );
1545 j *= ( outputImage->height() /
static_cast<double>( height ) );
1549 std::unique_ptr<QgsRectangle> featuresRect;
1550 std::unique_ptr<QgsGeometry> filterGeom;
1551 std::unique_ptr<QgsPointXY> infoPoint;
1553 if ( i != -1 && j != -1 )
1556 infoPointToMapCoordinates( i, j, infoPoint.get(), mapSettings );
1558 else if ( filtersDefined )
1562 else if ( filterGeomDefined )
1567 QDomDocument result;
1568 const QDomNode header = result.createProcessingInstruction( QStringLiteral(
"xml" ), QStringLiteral(
"version=\"1.0\" encoding=\"UTF-8\"" ) );
1569 result.appendChild( header );
1571 QDomElement getFeatureInfoElement;
1575 getFeatureInfoElement = result.createElement( QStringLiteral(
"wfs:FeatureCollection" ) );
1576 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:wfs" ), QStringLiteral(
"http://www.opengis.net/wfs" ) );
1577 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
1578 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:gml" ), QStringLiteral(
"http://www.opengis.net/gml" ) );
1579 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:ows" ), QStringLiteral(
"http://www.opengis.net/ows" ) );
1580 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
1581 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:qgs" ), QStringLiteral(
"http://qgis.org/gml" ) );
1582 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:xsi" ), QStringLiteral(
"http://www.w3.org/2001/XMLSchema-instance" ) );
1583 getFeatureInfoElement.setAttribute( QStringLiteral(
"xsi:schemaLocation" ), QStringLiteral(
"http://www.opengis.net/wfs http://schemas.opengis.net/wfs/1.0.0/wfs.xsd http://qgis.org/gml" ) );
1588 if ( featureInfoElemName.isEmpty() )
1590 featureInfoElemName = QStringLiteral(
"GetFeatureInfoResponse" );
1593 if ( featureInfoElemNs.isEmpty() )
1595 getFeatureInfoElement = result.createElement( featureInfoElemName );
1599 getFeatureInfoElement = result.createElementNS( featureInfoElemNs, featureInfoElemName );
1603 if ( !featureInfoSchema.isEmpty() )
1605 getFeatureInfoElement.setAttribute( QStringLiteral(
"xmlns:xsi" ), QStringLiteral(
"http://www.w3.org/2001/XMLSchema-instance" ) );
1606 getFeatureInfoElement.setAttribute( QStringLiteral(
"xsi:schemaLocation" ), featureInfoSchema );
1609 result.appendChild( getFeatureInfoElement );
1619 for (
const QString &queryLayer : queryLayers )
1621 bool validLayer =
false;
1622 bool queryableLayer =
true;
1623 for (
QgsMapLayer *layer : std::as_const( layers ) )
1629 if ( !queryableLayer )
1634 QDomElement layerElement;
1637 layerElement = getFeatureInfoElement;
1641 layerElement = result.createElement( QStringLiteral(
"Layer" ) );
1642 QString layerName = queryLayer;
1645 QHash<QString, QString>::const_iterator layerAliasIt = layerAliasMap.constFind( layerName );
1646 if ( layerAliasIt != layerAliasMap.constEnd() )
1648 layerName = layerAliasIt.value();
1651 layerElement.setAttribute( QStringLiteral(
"name" ), layerName );
1652 const QString layerTitle = layer->title();
1653 if ( !layerTitle.isEmpty() )
1655 layerElement.setAttribute( QStringLiteral(
"title" ), layerTitle );
1659 layerElement.setAttribute( QStringLiteral(
"title" ), layerName );
1661 getFeatureInfoElement.appendChild( layerElement );
1664 layerElement.setAttribute( QStringLiteral(
"id" ), layer->id() );
1670 QgsVectorLayer *vectorLayer = qobject_cast<QgsVectorLayer *>( layer );
1673 ( void )featureInfoFromVectorLayer( vectorLayer, infoPoint.get(), featureCount, result, layerElement, mapSettings, renderContext, version, featuresRect.get(), filterGeom.get() );
1679 QgsRasterLayer *rasterLayer = qobject_cast<QgsRasterLayer *>( layer );
1688 QgsPointXY layerInfoPoint = mapSettings.mapToLayerCoordinates( layer, *( infoPoint.get() ) );
1695 layerElement = result.createElement( QStringLiteral(
"gml:featureMember" ) );
1696 getFeatureInfoElement.appendChild( layerElement );
1699 ( void )featureInfoFromRasterLayer( rasterLayer, mapSettings, &layerInfoPoint, renderContext, result, layerElement, version );
1707 param.mValue = queryLayer;
1711 else if ( ( validLayer && !queryableLayer ) || ( !validLayer && mContext.
isValidGroup( queryLayer ) ) )
1714 param.mValue = queryLayer;
1716 bool hasGroupAndQueryable {
false };
1721 for (
const QString &ql : constNicks )
1725 const QList<QgsMapLayer *> constLayers { mContext.
layerGroups()[ql] };
1728 if ( ( ! ml->shortName().isEmpty() && ml->shortName() == queryLayer ) || ( ml->name() == queryLayer ) )
1734 hasGroupAndQueryable =
true;
1743 if ( ! hasGroupAndQueryable )
1751 if ( featuresRect && ! featuresRect->isNull() )
1755 QDomElement bBoxElem = result.createElement( QStringLiteral(
"gml:boundedBy" ) );
1756 QDomElement boxElem;
1758 if ( gmlVersion < 3 )
1770 boxElem.setAttribute( QStringLiteral(
"srsName" ),
crs.
authid() );
1772 bBoxElem.appendChild( boxElem );
1773 getFeatureInfoElement.insertBefore( bBoxElem, QDomNode() );
1777 QDomElement bBoxElem = result.createElement( QStringLiteral(
"BoundingBox" ) );
1778 bBoxElem.setAttribute( QStringLiteral(
"CRS" ), mapSettings.destinationCrs().authid() );
1779 bBoxElem.setAttribute( QStringLiteral(
"minx" ),
qgsDoubleToString( featuresRect->xMinimum(), 8 ) );
1780 bBoxElem.setAttribute( QStringLiteral(
"maxx" ),
qgsDoubleToString( featuresRect->xMaximum(), 8 ) );
1781 bBoxElem.setAttribute( QStringLiteral(
"miny" ),
qgsDoubleToString( featuresRect->yMinimum(), 8 ) );
1782 bBoxElem.setAttribute( QStringLiteral(
"maxy" ),
qgsDoubleToString( featuresRect->yMaximum(), 8 ) );
1783 getFeatureInfoElement.insertBefore( bBoxElem, QDomNode() );
1789 convertFeatureInfoToSia2045( result );
1795 bool QgsRenderer::featureInfoFromVectorLayer(
QgsVectorLayer *layer,
1798 QDomDocument &infoDocument,
1799 QDomElement &layerElement,
1802 const QString &version,
1814 std::unique_ptr<QgsGeometry> layerFilterGeom;
1817 layerFilterGeom.reset(
new QgsGeometry( *filterGeom ) );
1831 searchRect = featureInfoSearchRect( layer, mapSettings, renderContext, *infoPoint );
1833 else if ( layerFilterGeom )
1835 searchRect = layerFilterGeom->boundingBox();
1837 else if ( !mWmsParameters.
bbox().isEmpty() )
1839 searchRect = layerRect;
1846 int featureCounter = 0;
1865 if ( layerFilterGeom )
1867 fReq.
setFilterExpression( QString(
"intersects( $geometry, geom_from_wkt('%1') )" ).arg( layerFilterGeom->asWkt() ) );
1872#ifdef HAVE_SERVER_PYTHON_PLUGINS
1873 mContext.accessControl()->filterFeatures( layer, fReq );
1875 QStringList attributes;
1876 for (
const QgsField &field : fields )
1878 attributes.append( field.name() );
1880 attributes = mContext.accessControl()->layerAttributes( layer, attributes );
1885 std::unique_ptr< QgsFeatureRenderer > r2( layer->
renderer() ? layer->
renderer()->
clone() : nullptr );
1888 r2->startRender( renderContext, layer->
fields() );
1891 bool featureBBoxInitialized =
false;
1900 if ( featureCounter > nFeatures )
1915 bool render = r2->willRenderFeature( feature, renderContext );
1928 if ( !featureBBoxInitialized && featureBBox->
isEmpty() )
1931 featureBBoxInitialized =
true;
1951 QDomElement elem = createFeatureGML(
1953#ifdef HAVE_SERVER_PYTHON_PLUGINS
1957 QDomElement featureMemberElem = infoDocument.createElement( QStringLiteral(
"gml:featureMember" ) );
1958 featureMemberElem.appendChild( elem );
1959 layerElement.appendChild( featureMemberElem );
1964 QDomElement featureElement = infoDocument.createElement( QStringLiteral(
"Feature" ) );
1966 layerElement.appendChild( featureElement );
1972 writeAttributesTabLayout( editConfig, layer, fields, featureAttributes, infoDocument, featureElement, renderContext
1973#ifdef HAVE_SERVER_PYTHON_PLUGINS
1980 for (
int i = 0; i < featureAttributes.count(); ++i )
1982 writeVectorLayerAttribute( i, layer, fields, featureAttributes, infoDocument, featureElement, renderContext
1983#ifdef HAVE_SERVER_PYTHON_PLUGINS
1994 QDomElement maptipElem = infoDocument.createElement( QStringLiteral(
"Attribute" ) );
1995 maptipElem.setAttribute( QStringLiteral(
"name" ), QStringLiteral(
"maptip" ) );
1999 featureElement.appendChild( maptipElem );
2005 QDomElement displayElem = infoDocument.createElement( QStringLiteral(
"Attribute" ) );
2006 displayElem.setAttribute( QStringLiteral(
"name" ), QStringLiteral(
"displayName" ) );
2009 displayExpression.
prepare( &context );
2010 displayElem.setAttribute( QStringLiteral(
"value" ), displayExpression.
evaluate( &context ).toString() );
2011 featureElement.appendChild( displayElem );
2018 QDomElement bBoxElem = infoDocument.createElement( QStringLiteral(
"BoundingBox" ) );
2019 bBoxElem.setAttribute( version == QLatin1String(
"1.1.1" ) ?
"SRS" :
"CRS",
outputCrs.authid() );
2024 featureElement.appendChild( bBoxElem );
2040 if ( segmentizeWktGeometry )
2048 geom.
set( segmentizedGeom );
2052 QDomElement geometryElement = infoDocument.createElement( QStringLiteral(
"Attribute" ) );
2053 geometryElement.setAttribute( QStringLiteral(
"name" ), QStringLiteral(
"geometry" ) );
2054 geometryElement.setAttribute( QStringLiteral(
"value" ), geom.
asWkt( mContext.
precision() ) );
2055 geometryElement.setAttribute( QStringLiteral(
"type" ), QStringLiteral(
"derived" ) );
2056 featureElement.appendChild( geometryElement );
2063 r2->stopRender( renderContext );
2074 QString groupName = container->
name();
2075 QDomElement nameElem;
2077 if ( !groupName.isEmpty() )
2079 nameElem = doc.createElement( groupName );
2080 parentElem.appendChild( nameElem );
2083 const QList<QgsAttributeEditorElement *> children = container->
children();
2088 writeAttributesTabGroup( child, layer, fields, featureAttributes, doc, nameElem.isNull() ? parentElem : nameElem, renderContext );
2098 writeVectorLayerAttribute( idx, layer, fields, featureAttributes, doc, nameElem.isNull() ? parentElem : nameElem, renderContext, attributes );
2109 if ( !editorContainer )
2114 writeAttributesTabGroup( editorContainer, layer, fields, featureAttributes, doc, featureElem, renderContext, attributes );
2117 void QgsRenderer::writeVectorLayerAttribute(
int attributeIndex,
QgsVectorLayer *layer,
const QgsFields &fields,
QgsAttributes &featureAttributes, QDomDocument &doc, QDomElement &featureElem,
QgsRenderContext &renderContext, QStringList *attributes )
const
2119#ifndef HAVE_SERVER_PYTHON_PLUGINS
2120 Q_UNUSED( attributes );
2133#ifdef HAVE_SERVER_PYTHON_PLUGINS
2135 if ( attributes && !attributes->contains( fields.
at( attributeIndex ).
name() ) )
2142 QDomElement attributeElement = doc.createElement( QStringLiteral(
"Attribute" ) );
2143 attributeElement.setAttribute( QStringLiteral(
"name" ), attributeName );
2145 attributeElement.setAttribute( QStringLiteral(
"value" ),
2147 replaceValueMapAndRelation(
2148 layer, attributeIndex,
2149 featureAttributes[attributeIndex] ),
2152 featureElem.appendChild( attributeElement );
2155 bool QgsRenderer::featureInfoFromRasterLayer(
QgsRasterLayer *layer,
2159 QDomDocument &infoDocument,
2160 QDomElement &layerElement,
2161 const QString &version )
const
2181 :
Qgis::RasterIdentifyFormat::Value );
2193 .arg( layer->
name() ) );
2202 if ( !identifyResult.
isValid() )
2205 QMap<int, QVariant> attributes = identifyResult.
results();
2219 for (
auto it = attributes.constBegin(); it != attributes.constEnd(); ++it )
2222 feature.
setAttribute( index++, QString::number( it.value().toDouble() ) );
2225 QDomElement elem = createFeatureGML(
2226 &feature,
nullptr, infoDocument, layerCrs, mapSettings,
typeName,
false, gmlVersion,
nullptr );
2227 layerElement.appendChild( elem );
2231 const auto values = identifyResult.
results();
2232 for (
auto it = values.constBegin(); it != values.constEnd(); ++it )
2234 QVariant value = it.value();
2235 if ( value.type() == QVariant::Bool && !value.toBool() )
2241 if ( value.type() == QVariant::String )
2252 for (
const QgsFeature &feature : storeFeatures )
2254 QDomElement elem = createFeatureGML(
2255 &feature,
nullptr, infoDocument, layerCrs, mapSettings,
typeName,
false, gmlVersion,
nullptr );
2256 layerElement.appendChild( elem );
2266 for (
auto it = attributes.constBegin(); it != attributes.constEnd(); ++it )
2268 QDomElement attributeElement = infoDocument.createElement( QStringLiteral(
"Attribute" ) );
2269 attributeElement.setAttribute( QStringLiteral(
"name" ), layer->
bandName( it.key() ) );
2274 value = QString::number( it.value().toDouble() );
2277 attributeElement.setAttribute( QStringLiteral(
"value" ), value );
2278 layerElement.appendChild( attributeElement );
2283 const auto values = identifyResult.
results();
2284 for (
auto it = values.constBegin(); it != values.constEnd(); ++it )
2286 QVariant value = it.value();
2287 if ( value.type() == QVariant::Bool && !value.toBool() )
2293 if ( value.type() == QVariant::String )
2303 for (
const QgsFeature &feature : storeFeatures )
2305 for (
const auto &fld : feature.fields() )
2307 const auto val { feature.
attribute( fld.name() )};
2308 if ( val.isValid() )
2310 QDomElement attributeElement = infoDocument.createElement( QStringLiteral(
"Attribute" ) );
2311 attributeElement.setAttribute( QStringLiteral(
"name" ), fld.name() );
2312 attributeElement.setAttribute( QStringLiteral(
"value" ), val.toString() );
2313 layerElement.appendChild( attributeElement );
2324 QDomElement maptipElem = infoDocument.createElement( QStringLiteral(
"Attribute" ) );
2325 maptipElem.setAttribute( QStringLiteral(
"name" ), QStringLiteral(
"maptip" ) );
2329 context.appendScope( scope );
2331 layerElement.appendChild( maptipElem );
2337 bool QgsRenderer::testFilterStringSafety(
const QString &filter )
const
2340 if ( filter.contains( QLatin1String(
";" ) ) )
2345 QStringList tokens = filter.split(
' ', Qt::SkipEmptyParts );
2346 groupStringList( tokens, QStringLiteral(
"'" ) );
2347 groupStringList( tokens, QStringLiteral(
"\"" ) );
2349 for (
auto tokenIt = tokens.constBegin() ; tokenIt != tokens.constEnd(); ++tokenIt )
2352 if ( tokenIt->compare( QLatin1String(
"," ) ) == 0
2353 || tokenIt->compare( QLatin1String(
"(" ) ) == 0
2354 || tokenIt->compare( QLatin1String(
")" ) ) == 0
2355 || tokenIt->compare( QLatin1String(
"=" ) ) == 0
2356 || tokenIt->compare( QLatin1String(
"!=" ) ) == 0
2357 || tokenIt->compare( QLatin1String(
"<" ) ) == 0
2358 || tokenIt->compare( QLatin1String(
"<=" ) ) == 0
2359 || tokenIt->compare( QLatin1String(
">" ) ) == 0
2360 || tokenIt->compare( QLatin1String(
">=" ) ) == 0
2361 || tokenIt->compare( QLatin1String(
"%" ) ) == 0
2362 || tokenIt->compare( QLatin1String(
"IS" ), Qt::CaseInsensitive ) == 0
2363 || tokenIt->compare( QLatin1String(
"NOT" ), Qt::CaseInsensitive ) == 0
2364 || tokenIt->compare( QLatin1String(
"NULL" ), Qt::CaseInsensitive ) == 0
2365 || tokenIt->compare( QLatin1String(
"AND" ), Qt::CaseInsensitive ) == 0
2366 || tokenIt->compare( QLatin1String(
"OR" ), Qt::CaseInsensitive ) == 0
2367 || tokenIt->compare( QLatin1String(
"IN" ), Qt::CaseInsensitive ) == 0
2368 || tokenIt->compare( QLatin1String(
"LIKE" ), Qt::CaseInsensitive ) == 0
2369 || tokenIt->compare( QLatin1String(
"ILIKE" ), Qt::CaseInsensitive ) == 0
2370 || tokenIt->compare( QLatin1String(
"DMETAPHONE" ), Qt::CaseInsensitive ) == 0
2371 || tokenIt->compare( QLatin1String(
"SOUNDEX" ), Qt::CaseInsensitive ) == 0
2379 tokenIt->toDouble( &isNumeric );
2388 if ( *tokenIt == QLatin1String(
"''" ) )
2394 if ( tokenIt->size() > 2
2395 && ( *tokenIt )[0] == QChar(
'\'' )
2396 && ( *tokenIt )[tokenIt->size() - 1] == QChar(
'\'' )
2397 && ( *tokenIt )[1] != QChar(
'\'' )
2398 && ( *tokenIt )[tokenIt->size() - 2] != QChar(
'\'' ) )
2404 if ( tokenIt->size() > 2
2405 && ( *tokenIt )[0] == QChar(
'"' )
2406 && ( *tokenIt )[tokenIt->size() - 1] == QChar(
'"' )
2407 && ( *tokenIt )[1] != QChar(
'"' )
2408 && ( *tokenIt )[tokenIt->size() - 2] != QChar(
'"' ) )
2419 void QgsRenderer::groupStringList( QStringList &list,
const QString &groupString )
2422 bool groupActive =
false;
2423 int startGroup = -1;
2424 QString concatString;
2426 for (
int i = 0; i < list.size(); ++i )
2428 QString &
str = list[i];
2429 if (
str.startsWith( groupString ) )
2433 concatString.clear();
2438 if ( i != startGroup )
2440 concatString.append(
" " );
2442 concatString.append(
str );
2445 if (
str.endsWith( groupString ) )
2448 groupActive =
false;
2450 if ( startGroup != -1 )
2452 list[startGroup] = concatString;
2453 for (
int j = startGroup + 1; j <= endGroup; ++j )
2455 list.removeAt( startGroup + 1 );
2460 concatString.clear();
2466 void QgsRenderer::convertFeatureInfoToSia2045( QDomDocument &doc )
const
2468 QDomDocument SIAInfoDoc;
2469 QDomElement infoDocElement = doc.documentElement();
2470 QDomElement SIAInfoDocElement = SIAInfoDoc.importNode( infoDocElement,
false ).toElement();
2471 SIAInfoDoc.appendChild( SIAInfoDocElement );
2473 QString currentAttributeName;
2474 QString currentAttributeValue;
2475 QDomElement currentAttributeElem;
2476 QString currentLayerName;
2477 QDomElement currentLayerElem;
2478 QDomNodeList layerNodeList = infoDocElement.elementsByTagName( QStringLiteral(
"Layer" ) );
2479 for (
int i = 0; i < layerNodeList.size(); ++i )
2481 currentLayerElem = layerNodeList.at( i ).toElement();
2482 currentLayerName = currentLayerElem.attribute( QStringLiteral(
"name" ) );
2484 QDomElement currentFeatureElem;
2486 QDomNodeList featureList = currentLayerElem.elementsByTagName( QStringLiteral(
"Feature" ) );
2487 if ( featureList.isEmpty() )
2490 QDomNodeList attributeList = currentLayerElem.elementsByTagName( QStringLiteral(
"Attribute" ) );
2491 QDomElement rasterLayerElem;
2492 if ( !attributeList.isEmpty() )
2494 rasterLayerElem = SIAInfoDoc.createElement( currentLayerName );
2496 for (
int j = 0; j < attributeList.size(); ++j )
2498 currentAttributeElem = attributeList.at( j ).toElement();
2499 currentAttributeName = currentAttributeElem.attribute( QStringLiteral(
"name" ) );
2500 currentAttributeValue = currentAttributeElem.attribute( QStringLiteral(
"value" ) );
2501 QDomElement outAttributeElem = SIAInfoDoc.createElement( currentAttributeName );
2502 QDomText outAttributeText = SIAInfoDoc.createTextNode( currentAttributeValue );
2503 outAttributeElem.appendChild( outAttributeText );
2504 rasterLayerElem.appendChild( outAttributeElem );
2506 if ( !attributeList.isEmpty() )
2508 SIAInfoDocElement.appendChild( rasterLayerElem );
2514 QSet<QString> layerPropertyAttributes;
2515 QString currentLayerId = currentLayerElem.attribute( QStringLiteral(
"id" ) );
2516 if ( !currentLayerId.isEmpty() )
2521 QString WMSPropertyAttributesString = currentLayer->
customProperty( QStringLiteral(
"WMSPropertyAttributes" ) ).toString();
2522 if ( !WMSPropertyAttributesString.isEmpty() )
2524 QStringList propertyList = WMSPropertyAttributesString.split( QStringLiteral(
"//" ) );
2525 for (
auto propertyIt = propertyList.constBegin() ; propertyIt != propertyList.constEnd(); ++propertyIt )
2527 layerPropertyAttributes.insert( *propertyIt );
2533 QDomElement propertyRefChild;
2534 for (
int j = 0; j < featureList.size(); ++j )
2536 QDomElement SIAFeatureElem = SIAInfoDoc.createElement( currentLayerName );
2537 currentFeatureElem = featureList.at( j ).toElement();
2538 QDomNodeList attributeList = currentFeatureElem.elementsByTagName( QStringLiteral(
"Attribute" ) );
2540 for (
int k = 0; k < attributeList.size(); ++k )
2542 currentAttributeElem = attributeList.at( k ).toElement();
2543 currentAttributeName = currentAttributeElem.attribute( QStringLiteral(
"name" ) );
2544 currentAttributeValue = currentAttributeElem.attribute( QStringLiteral(
"value" ) );
2545 if ( layerPropertyAttributes.contains( currentAttributeName ) )
2547 QDomElement propertyElem = SIAInfoDoc.createElement( QStringLiteral(
"property" ) );
2548 QDomElement identifierElem = SIAInfoDoc.createElement( QStringLiteral(
"identifier" ) );
2549 QDomText identifierText = SIAInfoDoc.createTextNode( currentAttributeName );
2550 identifierElem.appendChild( identifierText );
2551 QDomElement valueElem = SIAInfoDoc.createElement( QStringLiteral(
"value" ) );
2552 QDomText valueText = SIAInfoDoc.createTextNode( currentAttributeValue );
2553 valueElem.appendChild( valueText );
2554 propertyElem.appendChild( identifierElem );
2555 propertyElem.appendChild( valueElem );
2556 if ( propertyRefChild.isNull() )
2558 SIAFeatureElem.insertBefore( propertyElem, QDomNode() );
2559 propertyRefChild = propertyElem;
2563 SIAFeatureElem.insertAfter( propertyElem, propertyRefChild );
2568 QDomElement SIAAttributeElem = SIAInfoDoc.createElement( currentAttributeName );
2569 QDomText SIAAttributeText = SIAInfoDoc.createTextNode( currentAttributeValue );
2570 SIAAttributeElem.appendChild( SIAAttributeText );
2571 SIAFeatureElem.appendChild( SIAAttributeElem );
2574 SIAInfoDocElement.appendChild( SIAFeatureElem );
2581 QByteArray QgsRenderer::convertFeatureInfoToHtml(
const QDomDocument &doc )
const
2584 QString featureInfoString = QStringLiteral(
" <!DOCTYPE html>" );
2587 featureInfoString.append( QStringLiteral( R
"HTML(
2590 <title>Information</title>
2591 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2594 font-family: "Open Sans", "Calluna Sans", "Gill Sans MT", "Calibri", "Trebuchet MS", sans-serif;
2601 border: 1px solid black;
2602 border-collapse: collapse;
2623 const QDomNodeList layerList = doc.elementsByTagName( QStringLiteral(
"Layer" ) );
2626 for (
int i = 0; i < layerList.size(); ++i )
2628 const QDomElement layerElem = layerList.at( i ).toElement();
2631 const QDomNodeList featureNodeList = layerElem.elementsByTagName( QStringLiteral(
"Feature" ) );
2632 const QDomElement currentFeatureElement;
2634 if ( !featureNodeList.isEmpty() )
2638 const QString featureInfoLayerTitleString = QStringLiteral(
" <div class='layer-title'>%1</div>" ).arg( layerElem.attribute( QStringLiteral(
"title" ) ).toHtmlEscaped() );
2639 featureInfoString.append( featureInfoLayerTitleString );
2642 for (
int j = 0; j < featureNodeList.size(); ++j )
2644 const QDomElement featureElement = featureNodeList.at( j ).toElement();
2647 featureInfoString.append( QStringLiteral( R
"HTML(
2652 const QDomNodeList attributeNodeList = featureElement.elementsByTagName( QStringLiteral(
"Attribute" ) );
2653 for (
int k = 0; k < attributeNodeList.size(); ++k )
2655 const QDomElement attributeElement = attributeNodeList.at( k ).toElement();
2656 const QString name = attributeElement.attribute( QStringLiteral(
"name" ) ).toHtmlEscaped();
2657 QString value = attributeElement.attribute( QStringLiteral(
"value" ) );
2658 if ( name != QLatin1String(
"maptip" ) )
2660 value = value.toHtmlEscaped();
2665 const QString featureInfoAttributeString = QStringLiteral( R
"HTML(
2669 </tr>)HTML" ).arg( name, value );
2671 featureInfoString.append( featureInfoAttributeString );
2673 else if ( name == QStringLiteral(
"maptip" ) )
2675 featureInfoString.append( QStringLiteral( R
"HTML(
2676 %1)HTML" ).arg( value ) );
2683 featureInfoString.append( QStringLiteral( R
"HTML(
2690 const QDomNodeList attributeNodeList = layerElem.elementsByTagName( QStringLiteral(
"Attribute" ) );
2693 if ( !attributeNodeList.isEmpty() )
2697 const QString featureInfoLayerTitleString = QStringLiteral(
" <div class='layer-title'>%1</div>" ).arg( layerElem.attribute( QStringLiteral(
"title" ) ).toHtmlEscaped() );
2698 featureInfoString.append( featureInfoLayerTitleString );
2700 featureInfoString.append( QStringLiteral( R
"HTML(
2704 for (
int j = 0; j < attributeNodeList.size(); ++j )
2706 const QDomElement attributeElement = attributeNodeList.at( j ).toElement();
2707 const QString name = attributeElement.attribute( QStringLiteral(
"name" ) ).toHtmlEscaped();
2708 QString value = attributeElement.attribute( QStringLiteral(
"value" ) );
2709 if ( value.isEmpty() )
2711 value = QStringLiteral(
"no data" );
2713 if ( name != QLatin1String(
"maptip" ) )
2715 value = value.toHtmlEscaped();
2720 const QString featureInfoAttributeString = QStringLiteral( R
"HTML(
2724 </tr>)HTML" ).arg( name, value );
2727 featureInfoString.append( featureInfoAttributeString );
2729 else if ( name == QStringLiteral(
"maptip" ) )
2731 featureInfoString.append( QStringLiteral( R
"HTML(
2732 %1)HTML" ).arg( value ) );
2739 featureInfoString.append( QStringLiteral( R
"HTML(
2749 featureInfoString.append( QStringLiteral( R
"HTML(
2753 return featureInfoString.toUtf8();
2756 QByteArray QgsRenderer::convertFeatureInfoToText(
const QDomDocument &doc )
const
2758 QString featureInfoString;
2761 featureInfoString.append(
"GetFeatureInfo results\n" );
2762 featureInfoString.append(
"\n" );
2764 QDomNodeList layerList = doc.elementsByTagName( QStringLiteral(
"Layer" ) );
2767 for (
int i = 0; i < layerList.size(); ++i )
2769 QDomElement layerElem = layerList.at( i ).toElement();
2771 featureInfoString.append(
"Layer '" + layerElem.attribute( QStringLiteral(
"name" ) ) +
"'\n" );
2774 QDomNodeList featureNodeList = layerElem.elementsByTagName( QStringLiteral(
"Feature" ) );
2775 QDomElement currentFeatureElement;
2777 if ( !featureNodeList.isEmpty() )
2779 for (
int j = 0; j < featureNodeList.size(); ++j )
2781 QDomElement featureElement = featureNodeList.at( j ).toElement();
2782 featureInfoString.append(
"Feature " + featureElement.attribute( QStringLiteral(
"id" ) ) +
"\n" );
2785 QDomNodeList attributeNodeList = featureElement.elementsByTagName( QStringLiteral(
"Attribute" ) );
2786 for (
int k = 0; k < attributeNodeList.size(); ++k )
2788 QDomElement attributeElement = attributeNodeList.at( k ).toElement();
2789 featureInfoString.append( attributeElement.attribute( QStringLiteral(
"name" ) ) +
" = '" +
2790 attributeElement.attribute( QStringLiteral(
"value" ) ) +
"'\n" );
2796 QDomNodeList attributeNodeList = layerElem.elementsByTagName( QStringLiteral(
"Attribute" ) );
2797 for (
int j = 0; j < attributeNodeList.size(); ++j )
2799 QDomElement attributeElement = attributeNodeList.at( j ).toElement();
2800 QString value = attributeElement.attribute( QStringLiteral(
"value" ) );
2801 if ( value.isEmpty() )
2803 value = QStringLiteral(
"no data" );
2805 featureInfoString.append( attributeElement.attribute( QStringLiteral(
"name" ) ) +
" = '" +
2810 featureInfoString.append(
"\n" );
2813 return featureInfoString.toUtf8();
2816 QByteArray QgsRenderer::convertFeatureInfoToJson(
const QList<QgsMapLayer *> &layers,
const QDomDocument &doc )
const
2820 {
"type",
"FeatureCollection" },
2821 {
"features", json::array() },
2825 const QDomNodeList layerList = doc.elementsByTagName( QStringLiteral(
"Layer" ) );
2826 for (
int i = 0; i < layerList.size(); ++i )
2828 const QDomElement layerElem = layerList.at( i ).toElement();
2829 const QString layerName = layerElem.attribute( QStringLiteral(
"name" ) );
2834 if ( mContext.
layerNickname( *l ).compare( layerName ) == 0 )
2850 const QDomNodeList featuresNode = layerElem.elementsByTagName( QStringLiteral(
"Feature" ) );
2851 if ( featuresNode.isEmpty() )
2854 QMap<QgsFeatureId, QString> fidMap;
2856 for (
int j = 0; j < featuresNode.size(); ++j )
2858 const QDomElement featureNode = featuresNode.at( j ).toElement();
2859 const QString fid = featureNode.attribute( QStringLiteral(
"id" ) );
2862 if ( expression.isEmpty() )
2864 feature = vl->
getFeature( fid.toLongLong() );
2873 fidMap.insert( feature.
id(), fid );
2878 const QDomNodeList attrs = featureNode.elementsByTagName(
"Attribute" );
2879 for (
int k = 0; k < attrs.count(); k++ )
2881 const QDomElement elm = attrs.at( k ).toElement();
2882 if ( elm.attribute( QStringLiteral(
"name" ) ).compare(
"geometry" ) == 0 )
2884 wkt = elm.attribute(
"value" );
2889 if ( ! wkt.isEmpty() )
2895 features << feature;
2898 if ( !attributes.isEmpty() )
2901 const QDomNodeList attributesNode = featureNode.elementsByTagName( QStringLiteral(
"Attribute" ) );
2902 for (
int k = 0; k < attributesNode.size(); ++k )
2904 const QDomElement attributeElement = attributesNode.at( k ).toElement();
2905 const QString fieldName = attributeElement.
attribute( QStringLiteral(
"name" ) );
2907 attributes << feature.fieldNameIndex( fieldName );
2913 exporter.setAttributeDisplayName(
true );
2914 exporter.setAttributes( attributes );
2915 exporter.setIncludeGeometry( withGeometry );
2916 exporter.setTransformGeometries(
false );
2918 for (
const auto &feature : std::as_const( features ) )
2920 const QString
id = QStringLiteral(
"%1.%2" ).arg( layerName ).arg( fidMap.value( feature.id() ) );
2921 json[
"features"].push_back( exporter.exportFeatureToJsonObject( feature, QVariantMap(),
id ) );
2926 auto properties = json::object();
2927 const QDomNodeList attributesNode = layerElem.elementsByTagName( QStringLiteral(
"Attribute" ) );
2928 for (
int j = 0; j < attributesNode.size(); ++j )
2930 const QDomElement attrElmt = attributesNode.at( j ).toElement();
2931 const QString name = attrElmt.attribute( QStringLiteral(
"name" ) );
2933 QString value = attrElmt.attribute( QStringLiteral(
"value" ) );
2934 if ( value.isEmpty() )
2936 value = QStringLiteral(
"null" );
2939 properties[name.toStdString()] = value.toStdString();
2942 json[
"features"].push_back(
2944 {
"type",
"Feature" },
2945 {
"id", layerName.toStdString() },
2946 {
"properties", properties }
2952 return QByteArray::fromStdString( json.dump( 2 ) );
2954 return QByteArray::fromStdString( json.dump() );
2958 QDomElement QgsRenderer::createFeatureGML(
2967 QStringList *attributes )
const
2970 QDomElement typeNameElement = doc.createElement(
"qgs:" +
typeName );
2977 typeNameElement.setAttribute( QStringLiteral(
"fid" ), QStringLiteral(
"%1.%2" ).arg(
typeName, fid ) );
2980 if ( layer && layer->
crs() !=
crs )
3013 QDomElement bbElem = doc.createElement( QStringLiteral(
"gml:boundedBy" ) );
3014 QDomElement boxElem;
3026 boxElem.setAttribute( QStringLiteral(
"srsName" ),
crs.
authid() );
3028 bbElem.appendChild( boxElem );
3029 typeNameElement.appendChild( bbElem );
3041 QDomElement geomElem = doc.createElement( QStringLiteral(
"qgs:geometry" ) );
3042 QDomElement gmlElem;
3052 if ( !gmlElem.isNull() )
3056 gmlElem.setAttribute( QStringLiteral(
"srsName" ),
crs.
authid() );
3058 geomElem.appendChild( gmlElem );
3059 typeNameElement.appendChild( geomElem );
3066 for (
int i = 0; i < fields.
count(); ++i )
3068 QString attributeName = fields.
at( i ).
name();
3075 if ( attributes && !attributes->contains( attributeName ) )
3080 QDomElement fieldElem = doc.createElement(
"qgs:" + attributeName.replace(
' ',
'_' ) );
3081 QString fieldTextString = featureAttributes.at( i ).toString();
3086 QDomText fieldText = doc.createTextNode( fieldTextString );
3087 fieldElem.appendChild( fieldText );
3088 typeNameElement.appendChild( fieldElem );
3099 QDomElement fieldElem = doc.createElement( QStringLiteral(
"qgs:maptip" ) );
3100 QDomText maptipText = doc.createTextNode( fieldTextString );
3101 fieldElem.appendChild( maptipText );
3102 typeNameElement.appendChild( fieldElem );
3106 return typeNameElement;
3109 QString QgsRenderer::replaceValueMapAndRelation(
QgsVectorLayer *vl,
int idx,
const QVariant &attributeVal )
3113 QString value( fieldFormatter->
representValue( vl, idx, setup.
config(), QVariant(), attributeVal ) );
3115 if ( setup.
config().value( QStringLiteral(
"AllowMulti" ) ).toBool() && value.startsWith( QLatin1Char(
'{' ) ) && value.endsWith( QLatin1Char(
'}' ) ) )
3117 value = value.mid( 1, value.size() - 2 );
3129 double mapUnitTolerance = 0.0;
3139 mapUnitTolerance = mapSettings.
extent().
width() / 400.0;
3151 mapUnitTolerance = mapSettings.
extent().
width() / 200.0;
3163 mapUnitTolerance = mapSettings.
extent().
width() / 100.0;
3167 QgsRectangle mapRectangle( infoPoint.
x() - mapUnitTolerance, infoPoint.
y() - mapUnitTolerance,
3168 infoPoint.
x() + mapUnitTolerance, infoPoint.
y() + mapUnitTolerance );
3172 QList<QgsMapLayer *> QgsRenderer::highlightLayers( QList<QgsWmsParametersHighlightLayer> params )
3174 QList<QgsMapLayer *> highlightLayers;
3177 QString
crs = mWmsParameters.
crs();
3178 for (
const QgsWmsParametersHighlightLayer ¶m : params )
3181 QDomDocument sldDoc;
3185 if ( !sldDoc.setContent( param.mSld,
true, &errorMsg, &errorLine, &errorColumn ) )
3197 std::unique_ptr<QgsFeatureRenderer> renderer;
3198 QDomElement el = sldDoc.documentElement();
3209 if ( ! param.mLabel.isEmpty() )
3211 url +=
"&field=label:string";
3216 std::unique_ptr<QgsVectorLayer> layer = std::make_unique<QgsVectorLayer>( url, param.mName, QLatin1String(
"memory" ), options );
3217 if ( !layer->isValid() )
3224 if ( ! param.mLabel.isEmpty() )
3226 fet.setAttribute( 0, param.mLabel );
3234 palSettings.
dist = param.mLabelDistance;
3243 switch ( param.mGeom.type() )
3256 QVariant x( pt.
x() );
3259 QVariant y( pt.
y() );
3276 QVariant x( pt.
x() );
3280 QVariant y( pt.
y() );
3284 QVariant hali(
"Center" );
3288 QVariant vali(
"Half" );
3303 if ( param.mColor.isValid() )
3305 textFormat.
setColor( param.mColor );
3308 if ( param.mSize > 0 )
3310 textFormat.
setSize( param.mSize );
3318 if ( ! param.mFont.isEmpty() )
3320 textFormat.
setFont( param.mFont );
3323 if ( param.mBufferColor.isValid() )
3325 bufferSettings.
setColor( param.mBufferColor );
3328 if ( param.mBufferSize > 0 )
3331 bufferSettings.
setSize(
static_cast<double>( param.mBufferSize ) );
3338 layer->setLabeling( simpleLabeling );
3339 layer->setLabelsEnabled(
true );
3341 fet.setGeometry( param.mGeom );
3345 layer->setRenderer( renderer.release() );
3348 if ( layer->isValid() )
3350 highlightLayers.append( layer.release() );
3354 mTemporaryLayers.append( highlightLayers );
3355 return highlightLayers;
3358 void QgsRenderer::removeTemporaryLayers()
3360 qDeleteAll( mTemporaryLayers );
3361 mTemporaryLayers.clear();
3364 QPainter *QgsRenderer::layersRendering(
const QgsMapSettings &mapSettings, QImage &image )
const
3366 QPainter *painter =
nullptr;
3370#ifdef HAVE_SERVER_PYTHON_PLUGINS
3371 mContext.accessControl()->resolveFilterFeatures( mapSettings.
layers() );
3376 renderJob.render( mapSettings, &image, mContext.
socketFeedback() );
3377 painter = renderJob.takePainter();
3379 if ( !renderJob.errors().isEmpty() )
3383 QString layerWMSName;
3390 QString errorMessage = QStringLiteral(
"Rendering error : '%1'" ).arg( e.
message );
3391 if ( ! layerWMSName.isEmpty() )
3393 errorMessage = QStringLiteral(
"Rendering error : '%1' in layer '%2'" ).arg( e.
message, layerWMSName );
3401 void QgsRenderer::setLayerOpacity(
QgsMapLayer *layer,
int opacity )
const
3403 if ( opacity >= 0 && opacity <= 255 )
3405 switch ( layer->
type() )
3424 rasterRenderer->
setOpacity( opacity / 255. );
3446 void QgsRenderer::setLayerFilter(
QgsMapLayer *layer,
const QList<QgsWmsParametersFilter> &filters )
3451 QgsVectorLayer *filteredLayer = qobject_cast<QgsVectorLayer *>( layer );
3452 QStringList expList;
3453 for (
const QgsWmsParametersFilter &filter : filters )
3458 QDomDocument filterXml;
3460 if ( !filterXml.setContent( filter.mFilter,
true, &errorMsg ) )
3463 QStringLiteral(
"Filter string rejected. Error message: %1. The XML string was: %2" ).arg( errorMsg, filter.mFilter ) );
3465 QDomElement filterElem = filterXml.firstChildElement();
3470 expList << filterExp->dump();
3476 if ( !testFilterStringSafety( filter.mFilter ) )
3478 throw QgsSecurityException( QStringLiteral(
"The filter string %1"
3479 " has been rejected because of security reasons."
3480 " Note: Text strings have to be enclosed in single or double quotes."
3481 " A space between each word / special character is mandatory."
3482 " Allowed Keywords and special characters are"
3483 " IS,NOT,NULL,AND,OR,IN,=,<,>=,>,>=,!=,',',(,),DMETAPHONE,SOUNDEX%2."
3484 " Not allowed are semicolons in the filter expression." ).arg(
3487 mContext.settings().allowedExtraSqlTokens().join(
',' ).prepend(
',' ) ) );
3490 QString newSubsetString = filter.mFilter;
3493 newSubsetString.prepend(
") AND (" );
3494 newSubsetString.append(
")" );
3495 newSubsetString.prepend( filteredLayer->
subsetString() );
3496 newSubsetString.prepend(
"(" );
3500 QgsMessageLog::logMessage( QStringLiteral(
"Error setting subset string from filter for layer %1, filter: %2" ).arg( layer->
name(), newSubsetString ),
3501 QStringLiteral(
"Server" ),
3504 QStringLiteral(
"Filter not valid for layer %1: check the filter syntax and the field names." ).arg( layer->
name() ) );
3510 expList.append( dimensionFilter( filteredLayer ) );
3514 if ( expList.size() == 1 )
3518 else if ( expList.size() > 1 )
3520 exp = QStringLiteral(
"( %1 )" ).arg( expList.join( QLatin1String(
" ) AND ( " ) ) );
3522 if ( !exp.isEmpty() )
3524 std::unique_ptr<QgsExpression> expression(
new QgsExpression( exp ) );
3527 mFeatureFilter.
setFilter( filteredLayer, *expression );
3533 QStringList QgsRenderer::dimensionFilter(
QgsVectorLayer *layer )
const
3535 QStringList expList;
3538 const QList<QgsMapLayerServerProperties::WmsDimensionInfo> wmsDims = serverProperties->
wmsDimensions();
3539 if ( wmsDims.isEmpty() )
3554 if ( fieldIndex == -1 )
3559 int endFieldIndex = -1;
3560 if ( !dim.endFieldName.isEmpty() )
3562 endFieldIndex = layer->
fields().
indexOf( dim.endFieldName );
3563 if ( endFieldIndex == -1 )
3569 if ( !dimParamValues.contains( dim.name.toUpper() ) )
3573 if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::AllValues )
3577 else if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::ReferenceValue )
3579 defValue = dim.referenceValue;
3584 QSet<QVariant> uniqueValues = layer->
uniqueValues( fieldIndex );
3585 if ( endFieldIndex != -1 )
3587 uniqueValues.unite( layer->
uniqueValues( endFieldIndex ) );
3590 QList<QVariant> values = qgis::setToList( uniqueValues );
3591 std::sort( values.begin(), values.end() );
3592 if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::MinValue )
3594 defValue = values.first();
3596 else if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::MaxValue )
3598 defValue = values.last();
3602 if ( endFieldIndex == -1 )
3608 QStringList expElems;
3613 expList << expElems.join(
' ' );
3621 QString dimParamValue = dimParamValues[dim.name.toUpper()];
3623 QStringList dimExplist;
3625 QStringList dimValues = dimParamValue.split(
',' );
3626 for (
int i = 0; i < dimValues.size(); ++i )
3628 QString dimValue = dimValues[i];
3630 if ( dimValue.size() > 1 )
3632 dimValue = dimValue.trimmed();
3635 if ( dimValue.contains(
'/' ) )
3637 QStringList rangeValues = dimValue.split(
'/' );
3639 if ( rangeValues.size() != 2 )
3644 QVariant rangeMin = QVariant( rangeValues[0] );
3645 QVariant rangeMax = QVariant( rangeValues[1] );
3656 QStringList expElems;
3657 if ( endFieldIndex == -1 )
3677 << QStringLiteral(
")" );
3679 dimExplist << expElems.join(
' ' );
3683 QVariant dimVariant = QVariant( dimValue );
3689 if ( endFieldIndex == -1 )
3698 QStringList expElems;
3703 dimExplist << expElems.join(
' ' );
3708 if ( dimExplist.size() == 1 )
3710 expList << dimExplist;
3712 else if ( dimExplist.size() > 1 )
3714 expList << QStringLiteral(
"( %1 )" ).arg( dimExplist.join( QLatin1String(
" ) OR ( " ) ) );
3721 void QgsRenderer::setLayerSelection(
QgsMapLayer *layer,
const QStringList &fids )
const
3731 if ( selectedIds.empty() )
3742 void QgsRenderer::setLayerAccessControlFilter(
QgsMapLayer *layer )
const
3744#ifdef HAVE_SERVER_PYTHON_PLUGINS
3762 void QgsRenderer::annotationsRendering( QPainter *painter,
const QgsMapSettings &mapSettings )
const
3765 const QList< QgsAnnotation * > annotations = annotationManager->
annotations();
3775 if ( !annotation || !annotation->isVisible() )
3781 if ( annotation->hasFixedMapPosition() )
3783 QgsPointXY mapPos = annotation->mapPosition();
3784 if ( mapSettings.
destinationCrs() != annotation->mapPositionCrs() )
3789 mapPos = coordTransform.transform( mapPos );
3797 offsetX = devicePos.
x();
3798 offsetY = devicePos.
y();
3802 const QPointF relativePos = annotation->relativePosition();
3803 offsetX = mapSettings.
outputSize().width() * relativePos.x();
3804 offsetY = mapSettings.
outputSize().height() * relativePos.y();
3808 painter->translate( offsetX, offsetY );
3809 annotation->render( renderContext );
3814 QImage *QgsRenderer::scaleImage(
const QImage *image )
const
3819 QImage *scaledImage =
nullptr;
3820 const int width = mWmsParameters.
widthAsInt();
3822 if ( width != image->width() || height != image->height() )
3824 scaledImage =
new QImage( image->scaled( width, height, Qt::IgnoreAspectRatio, Qt::SmoothTransformation ) );
3830 void QgsRenderer::handlePrintErrors(
const QgsLayout *layout )
const
3836 QList< QgsLayoutItemMap * > mapList;
3839 QList< QgsLayoutItemMap * >::const_iterator mapIt = mapList.constBegin();
3840 for ( ; mapIt != mapList.constEnd(); ++mapIt )
3842 if ( !( *mapIt )->renderingErrors().isEmpty() )
3854 for (
auto layer : layers )
3867 setLayerOpacity( layer, param.
mOpacity );
3874 setLayerSld( layer, mContext.
sld( *layer ) );
3878 setLayerStyle( layer, mContext.
style( *layer ) );
3883 setLayerOpacity( layer, param.
mOpacity );
3888 setLayerFilter( layer, param.
mFilter );
3893 setLayerAccessControlFilter( layer );
3898 setLayerSelection( layer, param.
mSelection );
3903 updateExtent( layer, *settings );
3913 void QgsRenderer::setLayerStyle(
QgsMapLayer *layer,
const QString &style )
const
3915 if ( style.isEmpty() )
3924 QStringLiteral(
"Style '%1' does not exist for layer '%2'" ).arg( style, layer->
name() ) );
3928 void QgsRenderer::setLayerSld(
QgsMapLayer *layer,
const QDomElement &sld )
const
3933 QString sldStyleName =
"__sld_style";
3934 while ( styles.contains( sldStyleName ) )
3936 sldStyleName.append(
'@' );
3949 if ( !mWmsParameters.
bbox().isEmpty() )
3953 std::unique_ptr<QImage> tmp( createImage( mContext.
mapSize(
false ) ) );
3954 configureMapSettings( tmp.get(), mapSettings );
The Qgis class provides global constants for use throughout the application.
static QString version()
Version string.
@ MapOrientation
Signifies that the AboveLine and BelowLine flags should respect the map's orientation rather than the...
@ AboveLine
Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects...
@ Millimeters
Millimeters.
LabelPlacement
Placement modes which determine how label candidates are generated for a feature.
@ AroundPoint
Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygo...
@ Line
Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon'...
@ DragAndDrop
"Drag and drop" layout. Needs to be configured.
@ ExactIntersect
Use exact geometry intersection (slower) instead of bounding boxes.
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
@ NoFlags
No flags are set.
@ Warning
Warning message.
@ Info
Information message.
@ ShowRuleDetails
If set, the rule expression of a rule based renderer legend item will be added to the JSON.
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
@ LosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ Antialiasing
Use antialiasing while drawing.
@ HighQualityImageTransforms
Enable high quality image transformations, which results in better appearance of scaled or rotated ra...
@ RenderBlocking
Render and load remote sources in the same thread to ensure rendering remote sources (svg and images)...
RasterIdentifyFormat
Raster identify formats.
@ Feature
WMS GML/JSON -> feature.
@ Value
Numerical pixel value.
@ HideFromWms
Field is not available if layer is served as WMS from QGIS server.
@ AllowOverlapIfRequired
Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise ...
@ Reverse
Reverse/inverse transform (from destination to source)
@ RenderMapTile
Draw map such that there are no problems between adjacent tiles.
@ RecordProfile
Enable run-time profiling while rendering (since QGIS 3.34)
@ UseRenderingOptimization
Enable vector simplification and other rendering optimizations.
@ RenderBlocking
Render and load remote sources in the same thread to ensure rendering remote sources (svg and images)...
Abstract base class for all geometries.
virtual QgsAbstractGeometry * segmentize(double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const
Returns a version of the geometry without curves.
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
virtual void multiplyOpacity(double opacityFactor)
Multiply opacity by opacityFactor.
Manages storage of a set of QgsAnnotation annotation objects.
QList< QgsAnnotation * > annotations() const
Returns a list of all annotations contained in the manager.
Abstract base class for annotation items which are drawn over a map.
static QgsFieldFormatterRegistry * fieldFormatterRegistry()
Gets the registry of available field formatters.
This is a container for attribute editors, used to group them visually in the attribute form if it is...
QList< QgsAttributeEditorElement * > children() const
Gets a list of the children elements of this container.
This is an abstract base class for any elements of a drag and drop form.
QString name() const
Returns the name of this element.
This element will load a field's widget onto the form.
Exception thrown in case of malformed request.
This class represents a coordinate reference system (CRS).
static QgsCoordinateReferenceSystem fromOgcWmsCrs(const QString &ogcCrs)
Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
Qgis::DistanceUnit mapUnits
bool hasAxisInverted() const
Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/la...
Custom exception class for Coordinate Reference System related exceptions.
A server filter to apply a dimension filter to a request.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
@ FlagNoMText
Export text as TEXT elements. If not set, text will be exported as MTEXT elements.
Defines a QGIS exception class.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Class for parsing and evaluation of expressions (formerly called "search strings").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
QString expression() const
Returns the original, unmodified expression string.
static QString quotedValue(const QVariant &value)
Returns a string representation of a literal value, including appropriate quotations where required.
static QString createFieldEqualityExpression(const QString &fieldName, const QVariant &value, QVariant::Type fieldType=QVariant::Type::Invalid)
Create an expression allowing to evaluate if a field is equal to a value.
static QString replaceExpressionText(const QString &action, const QgsExpressionContext *context, const QgsDistanceArea *distanceArea=nullptr)
This function replaces each expression between [% and %] in the string with the result of its evaluat...
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes)
QVariant evaluate()
Evaluate the feature and return the result.
bool isValid() const
Checks if this expression is valid.
A filter filter provider grouping several filter providers.
QgsFeatureFilterProviderGroup & addProvider(const QgsFeatureFilterProvider *provider)
Add another filter provider to the group.
void setFilter(const QgsVectorLayer *layer, const QgsExpression &expression)
Set a filter for the given layer.
void filterFeatures(const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures) const override
Filter the features of the layer.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
@ MoreSymbolsPerFeature
May use more than one symbol to render a feature: symbolsForFeature() will return them.
static QgsFeatureRenderer * loadSld(const QDomNode &node, Qgis::GeometryType geomType, QString &errorMessage)
Create a new renderer according to the information contained in the UserStyle element of a SLD style ...
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
Qgis::FeatureRequestFlags flags() const
Returns the flags which affect how features are fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsExpression * filterExpression() const
Returns the filter expression (if set).
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QgsCoordinateTransformContext transformContext() const
Returns the transform context, for use when a destinationCrs() has been set and reprojection is requi...
const QgsFeatureIds & filterFids() const
Returns the feature IDs that should be fetched.
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
A container for features with the same fields and crs.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
void setFields(const QgsFields &fields, bool initAttributes=false)
Assigns a field map with the feature to allow attribute access by attribute name.
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
bool isCanceled() const
Tells whether the operation has been canceled already.
Encapsulate a field in an attribute table or data source.
bool convertCompatible(QVariant &v, QString *errorMessage=nullptr) const
Converts the provided variant to a compatible format.
Qgis::FieldConfigurationFlags configurationFlags
Container of fields for a vector layer.
bool append(const QgsField &field, FieldOrigin origin=OriginProvider, int originIndex=-1)
Appends a field. The field must have unique name, otherwise it is rejected (returns false)
int indexFromName(const QString &fieldName) const
Gets the field index from the field name.
int indexOf(const QString &fieldName) const
Gets the field index from the field name.
int count() const
Returns number of items.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
A geometry is the spatial representation of a feature.
QgsGeometry pointOnSurface() const
Returns a point guaranteed to lie on the surface of a geometry.
Qgis::GeometryOperationResult transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool transformZ=false)
Transforms this geometry as described by the coordinate transform ct.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
static QgsGeometry fromWkt(const QString &wkt)
Creates a new geometry from a WKT string.
QgsPointXY asPoint() const
Returns the contents of the geometry as a 2-dimensional point.
static QgsGeometry fromPointXY(const QgsPointXY &point)
Creates a new geometry from a QgsPointXY object.
void set(QgsAbstractGeometry *geometry)
Sets the underlying geometry store.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
QString asWkt(int precision=17) const
Exports the geometry to WKT.
Handles exporting QgsFeature features to GeoJSON features.
void setPlacementFlags(Qgis::LabelLinePlacementFlags flags)
Returns the line placement flags, which dictate how line labels can be placed above or below the line...
void setOverlapHandling(Qgis::LabelOverlapHandling handling)
Sets the technique used to handle overlapping labels.
void setAllowDegradedPlacement(bool allow)
Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed.
QStringList findLayerIds() const
Find layer IDs used in all layer nodes.
QgsLayerTreeLayer * findLayer(QgsMapLayer *layer) const
Find layer node representing the map layer.
void removeChildrenGroupWithoutLayers()
Remove all child group nodes without layers.
Layer tree node points to a map layer.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegen...
virtual QVariant data(int role) const =0
Returns data associated with the item. Must be implemented in derived class.
@ RuleKey
Rule key of the node (QString)
virtual QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const
Adds a symbol in base64 string within a JSON object with the key "icon".
QgsLayerTreeLayer * layerNode() const
Returns pointer to the parent layer node.
virtual QSizeF drawSymbol(const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const
Draws symbol on the left side of the item.
The QgsLayerTreeModel class is model implementation for Qt item views framework.
QgsLayerTree * rootGroup() const
Returns pointer to the root node of the layer tree. Always a non nullptr value.
QgsLayerTreeNode * parent()
Gets pointer to the parent. If parent is nullptr, the node is a root node.
Namespace with helper functions for layer tree operations.
static QgsLayerTreeLayer * toLayer(QgsLayerTreeNode *node)
Cast node to a layer.
Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector ...
bool beginRender() override
Called when rendering begins, before iteration commences.
bool setFilterExpression(const QString &expression, QString &errorString)
Sets the expression used for filtering features in the coverage layer.
bool first()
Seeks to the first feature, returning false if no feature was found.
QgsLayout * layout() override
Returns the layout associated with the iterator.
bool enabled() const
Returns whether the atlas generation is enabled.
int count() const override
Returns the number of features to iterate over.
void setFilterFeatures(bool filtered)
Sets whether features should be filtered in the coverage layer.
QgsVectorLayer * coverageLayer() const
Returns the coverage layer used for the atlas features.
int updateFeatures()
Requeries the current atlas coverage layer and applies filtering and sorting.
Handles rendering and exports of layouts to various formats.
ExportResult exportToSvg(const QString &filePath, const QgsLayoutExporter::SvgExportSettings &settings)
Exports the layout as an SVG to the filePath, using the specified export settings.
ExportResult exportToImage(const QString &filePath, const QgsLayoutExporter::ImageExportSettings &settings)
Exports the layout to the filePath, using the specified export settings.
ExportResult exportToPdf(const QString &filePath, const QgsLayoutExporter::PdfExportSettings &settings)
Exports the layout as a PDF to the filePath, using the specified export settings.
Base class for frame items, which form a layout multiframe item.
A layout multiframe subclass for HTML content.
A layout item subclass for text labels.
A layout item subclass for map legends.
Layout graphical items for displaying a map.
double scale() const
Returns the map scale.
QList< QgsMapLayer * > layers() const
Returns the stored layer set.
QString id() const
Returns the item's ID name.
Manages storage of a set of layouts.
QgsMasterLayoutInterface * layoutByName(const QString &name) const
Returns the layout with a matching name, or nullptr if no matching layouts were found.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
double length() const
Returns the length of the measurement.
int pageCount() const
Returns the number of pages in the collection.
Stores information relating to the current rendering settings for a layout.
void setFeatureFilterProvider(QgsFeatureFilterProvider *featureFilterProvider)
Sets feature filter provider to featureFilterProvider.
@ FlagDrawSelection
Draw selection.
@ FlagLosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ FlagDisableTiledRasterLayerRenders
If set, then raster layers will not be drawn as separate tiles. This may improve the appearance in ex...
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
double height() const
Returns the height of the size.
double width() const
Returns the width of the size.
static QVector< double > predefinedScales(const QgsLayout *layout)
Returns a list of predefined scales associated with a layout.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout's page collection, which stores and manages page items in the layout.
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
Item model implementation based on layer tree model for layout legend.
The QgsLegendRenderer class handles automatic layout and rendering of legend.
QSizeF minimumSize(QgsRenderContext *renderContext=nullptr)
Runs the layout algorithm and returns the minimum size required for the legend.
QJsonObject exportLegendToJson(const QgsRenderContext &context)
Renders the legend in a json object.
Q_DECL_DEPRECATED void drawLegend(QPainter *painter)
Draws the legend with given painter.
The QgsLegendSettings class stores the appearance and layout settings for legend drawing with QgsLege...
Q_DECL_DEPRECATED void setMapScale(double scale)
Sets the legend map scale.
Q_DECL_DEPRECATED void setMapUnitsPerPixel(double mapUnitsPerPixel)
Sets the mmPerMapUnit calculated by mapUnitsPerPixel mostly taken from the map settings.
void setJsonRenderFlags(const Qgis::LegendJsonRenderFlags &jsonRenderFlags)
Sets the the JSON export flags to jsonRenderFlags.
Manages QGIS Server properties for a map layer.
QStringList styles() const
Returns list of all defined style names.
bool setCurrentStyle(const QString &name)
Set a different style as the current style - will apply it to the layer.
bool addStyleFromLayer(const QString &name)
Add style by cloning the current one.
Base class for all map layer types.
bool isInScaleRange(double scale) const
Tests whether the layer should be visible at the specified scale.
virtual QgsRectangle extent() const
Returns the extent of the layer.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
QgsCoordinateReferenceSystem crs
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
virtual void setOpacity(double opacity)
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
Q_INVOKABLE void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for layer.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
@ Identifiable
If the layer is identifiable using the identify map tool and as a WMS layer.
virtual bool readSld(const QDomNode &node, QString &errorMessage)
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
virtual Q_INVOKABLE QgsDataProvider * dataProvider()
Returns the layer's data provider, it may be nullptr.
The QgsMapSettings class contains configuration for rendering of the map.
QgsPointXY layerToMapCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from layer's CRS to output CRS
QList< QgsMapLayer * > layers(bool expandGroupLayers=false) const
Returns the list of layers which will be rendered in the map.
void setSelectionColor(const QColor &color)
Sets the color that is used for drawing of selected vector features.
void setLayers(const QList< QgsMapLayer * > &layers)
Sets the list of layers to render in the map.
double scale() const
Returns the calculated map scale.
QgsCoordinateTransform layerTransform(const QgsMapLayer *layer) const
Returns the coordinate transform from layer's CRS to destination CRS.
QgsRectangle layerExtentToOutputExtent(const QgsMapLayer *layer, QgsRectangle extent) const
transform bounding box from layer's CRS to output CRS
void setDpiTarget(double dpi)
Sets the target dpi (dots per inch) to be taken into consideration when rendering.
void setOutputDpi(double dpi)
Sets the dpi (dots per inch) used for conversion between real world units (e.g.
const QgsMapToPixel & mapToPixel() const
double mapUnitsPerPixel() const
Returns the distance in geographical coordinates that equals to one pixel in the map.
QSize outputSize() const
Returns the size of the resulting map image, in pixels.
QgsRectangle extent() const
Returns geographical coordinates of the rectangle that should be rendered.
void setExtent(const QgsRectangle &rect, bool magnified=true)
Sets the coordinates of the rectangle which should be rendered.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
QColor selectionColor() const
Returns the color that is used for drawing of selected vector features.
void setExtentBuffer(double buffer)
Sets the buffer in map units to use around the visible extent for rendering symbols whose correspondi...
void setLabelingEngineSettings(const QgsLabelingEngineSettings &settings)
Sets the global configuration of the labeling engine.
void setOutputSize(QSize size)
Sets the size of the resulting map image, in pixels.
QgsPointXY mapToLayerCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from output CRS to layer's CRS
void setBackgroundColor(const QColor &color)
Sets the background color of the map.
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
void setFlag(Qgis::MapSettingsFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
void setDestinationCrs(const QgsCoordinateReferenceSystem &crs)
Sets the destination crs (coordinate reference system) for the map render.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
QList< QgsMapThemeCollection::MapThemeLayerRecord > layerRecords() const
Returns a list of records for all visible layer belonging to the theme.
QgsMapThemeCollection::MapThemeRecord mapThemeState(const QString &name) const
Returns the recorded state of a map theme.
Perform transforms between map coordinates and device coordinates.
double mapUnitsPerPixel() const
Returns the current map units per pixel.
QgsPointXY transform(const QgsPointXY &p) const
Transforms a point p from map (world) coordinates to device coordinates.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
static void applyAccessControlLayerFilters(const QgsAccessControl *accessControl, QgsMapLayer *mapLayer, QHash< QgsMapLayer *, QString > &originalLayerFilters)
Apply filter from AccessControl.
static QDomElement geometryToGML(const QgsGeometry &geometry, QDomDocument &doc, QgsOgcUtils::GMLVersion gmlVersion, const QString &srsName, bool invertAxisOrientation, const QString &gmlIdBase, int precision=17)
Exports the geometry to GML.
static QDomElement rectangleToGMLEnvelope(QgsRectangle *env, QDomDocument &doc, int precision=17)
Exports the rectangle to GML3 Envelope.
static QgsExpression * expressionFromOgcFilter(const QDomElement &element, QgsVectorLayer *layer=nullptr)
Parse XML with OGC filter into QGIS expression.
static QDomElement rectangleToGMLBox(QgsRectangle *box, QDomDocument &doc, int precision=17)
Exports the rectangle to GML2 Box.
Contains settings for how a map layer will be labeled.
const QgsLabelPlacementSettings & placementSettings() const
Returns the label placement settings.
void setFormat(const QgsTextFormat &format)
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
Qgis::LabelPlacement placement
Label placement mode.
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the label's property collection, used for data defined overrides.
int priority
Label priority.
const QgsLabelLineSettings & lineSettings() const
Returns the label line settings, which contain settings related to how the label engine places and fo...
double dist
Distance from feature to the label.
Property
Data definable properties.
@ PositionX
X-coordinate data defined label position.
@ LabelRotation
Label rotation.
@ PositionY
Y-coordinate data defined label position.
@ Vali
Vertical alignment for data defined label position (Bottom, Base, Half, Cap, Top)
@ Hali
Horizontal alignment for data defined label position (Left, Center, Right)
QString fieldName
Name of field (or an expression) to use for label text.
A class to represent a 2D point.
void setY(double y)
Sets the y value of the point.
void setX(double x)
Sets the x value of the point.
Print layout, a QgsLayout subclass for static or atlas-based layouts.
QgsPrintLayout * clone() const override
Creates a clone of the layout.
A class to describe the version of a project.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsMapThemeCollection * mapThemeCollection
QgsAnnotationManager * annotationManager()
Returns pointer to the project's annotation manager.
QgsProjectMetadata metadata
QgsCoordinateTransformContext transformContext
const QgsLayoutManager * layoutManager() const
Returns the project's layout manager, which manages print layouts, atlases and reports within the pro...
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns project's global labeling engine settings.
QMap< QString, QgsMapLayer * > mapLayers(const bool validOnly=false) const
Returns a map of all registered layers by layer ID.
void setProperty(int key, const QgsProperty &property)
Adds a property to the collection and takes ownership of it.
virtual QgsRasterIdentifyResult identify(const QgsPointXY &point, Qgis::RasterIdentifyFormat format, const QgsRectangle &boundingBox=QgsRectangle(), int width=0, int height=0, int dpi=96)
Identify raster value(s) found on the point position.
Raster identify results container.
bool isValid() const
Returns true if valid.
QMap< int, QVariant > results() const
Returns the identify results.
@ IdentifyValue
Numerical values.
@ IdentifyFeature
WMS GML -> feature.
virtual int capabilities() const
Returns a bitmask containing the supported capabilities.
Represents a raster layer.
QgsRasterRenderer * renderer() const
Returns the raster's renderer.
QString bandName(int bandNoInt) const
Returns the name of a band given its number.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
Raster renderer pipe that applies colors to a raster.
void setOpacity(double opacity)
Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1....
A rectangle specified with double values.
bool contains(const QgsRectangle &rect) const
Returns true when rectangle contains other rectangle.
double xMinimum() const
Returns the x minimum value (left side of rectangle).
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
double width() const
Returns the width of the rectangle.
double xMaximum() const
Returns the x maximum value (right side of rectangle).
double yMaximum() const
Returns the y maximum value (top side of rectangle).
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given rectangle.
bool isEmpty() const
Returns true if the rectangle has no area.
double height() const
Returns the height of the rectangle.
void invert()
Swap x/y coordinates in the rectangle.
Contains information about the context of a rendering operation.
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
void setCoordinateTransform(const QgsCoordinateTransform &t)
Sets the current coordinate transform for the context.
void setDistanceArea(const QgsDistanceArea &distanceArea)
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
void setScaleFactor(double factor)
Sets the scaling factor for the render to convert painter units to physical sizes.
QgsExpressionContext & expressionContext()
Gets the expression context.
const QgsRectangle & extent() const
When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the l...
void setFeedback(QgsFeedback *feedback)
Attach a feedback object that can be queried regularly during rendering to check if rendering should ...
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
void setExtent(const QgsRectangle &extent)
When rendering a map layer, calling this method sets the "clipping" extent for the layer (in the laye...
void setMapToPixel(const QgsMapToPixel &mtp)
Sets the context's map to pixel transform, which transforms between map coordinates and device coordi...
void setPainter(QPainter *p)
Sets the destination QPainter for the render operation.
static QgsRenderContext fromMapSettings(const QgsMapSettings &mapSettings)
create initialized QgsRenderContext instance from given QgsMapSettings
static QgsRenderContext fromQPainter(QPainter *painter)
Creates a default render context given a pixel based QPainter destination.
Calculates scale for a given combination of canvas size, map extent, and monitor dpi.
double calculate(const QgsRectangle &mapExtent, double canvasWidth) const
Calculate the scale denominator.
Scoped object for temporary scaling of a QgsRenderContext for millimeter based rendering.
Bad request error API exception.
static QgsDateTimeRange parseTemporalDateTimeInterval(const QString &interval)
Parses a datetime interval and returns a QgsDateTimeRange.
Exception base class for server exceptions.
int maxThreads() const
Returns the maximum number of threads to use.
bool logProfile() const
Returns true if profile information has to be added to the logs, default value is false.
QStringList allowedExtraSqlTokens() const
Returns the list of strings that represent the allowed extra SQL tokens accepted as components of a f...
bool parallelRendering() const
Returns parallel rendering setting.
const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > wmsDimensions() const
Returns the QGIS Server WMS Dimension list.
static QString symbolProperties(QgsSymbol *symbol)
Returns a string representing the symbol.
Abstract base class for all rendered symbols.
@ Hidden
Hide task from GUI (since QGIS 3.26)
bool isActive() const
Returns true if the temporal property is active.
void setIsActive(bool active)
Sets whether the temporal property is active.
void setIsTemporal(bool enabled)
Sets whether the temporal range is enabled (i.e.
void setTemporalRange(const QgsDateTimeRange &range)
Sets the temporal range for the object.
Container for settings relating to a text buffer.
void setColor(const QColor &color)
Sets the color for the buffer.
void setEnabled(bool enabled)
Sets whether the text buffer will be drawn.
void setSize(double size)
Sets the size of the buffer.
Container for all settings relating to text rendering.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
void setSize(double size)
Sets the size for rendered text.
void setFont(const QFont &font)
Sets the font used for rendering text.
void setBuffer(const QgsTextBufferSettings &bufferSettings)
Sets the text's buffer settings.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
This is the base class for vector data providers.
virtual QgsAttributeList pkAttributeIndexes() const
Returns list of indexes of fields that make up the primary key.
Basic implementation of the labeling interface.
Represents a vector layer which manages a vector based data sets.
QString attributeDisplayName(int index) const
Convenience function that returns the attribute alias if defined or the field name else.
bool labelsEnabled() const
Returns whether the layer contains labels which are enabled and should be drawn.
QgsMapLayerTemporalProperties * temporalProperties() override
Returns the layer's temporal properties.
void updateFields()
Will regenerate the fields property of this layer by obtaining all fields from the dataProvider,...
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
Q_INVOKABLE void selectByExpression(const QString &expression, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection, QgsExpressionContext *context=nullptr)
Selects matching features using an expression.
const QgsAbstractVectorLayerLabeling * labeling() const
Access to const labeling configuration.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
QString displayExpression
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
QgsEditorWidgetSetup editorWidgetSetup(int index) const
The editor widget setup defines which QgsFieldFormatter and editor widget will be used for the field ...
QgsFeature getFeature(QgsFeatureId fid) const
Queries the layer for the feature with the given id.
Q_INVOKABLE void selectByIds(const QgsFeatureIds &ids, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection)
Selects matching features using a list of feature IDs.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
virtual bool setSubsetString(const QString &subset)
Sets the string (typically sql) used to define a subset of the layer.
QgsAttributeList primaryKeyAttributes() const
Returns the list of attributes which make up the layer's primary keys.
QgsEditFormConfig editFormConfig
QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const FINAL
Calculates a list of unique values contained within an attribute in the layer.
Implements a map layer that is dedicated to rendering of vector tiles.
static QString displayString(Qgis::WkbType type)
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
static bool isCurvedType(Qgis::WkbType type)
Returns true if the WKB type is a curved type or can contain curved geometries.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
Exception thrown in case of malformed request.
QgsRenderer(const QgsWmsRenderContext &context)
Constructor for QgsRenderer.
QHash< QgsVectorLayer *, SymbolSet > HitTest
QByteArray getPrint()
Returns printed page as binary.
HitTest symbols()
Returns the hit test according to the current context.
std::unique_ptr< QgsDxfExport > getDxf()
Returns the map as DXF data.
QSet< QString > SymbolSet
void configureLayers(QList< QgsMapLayer * > &layers, QgsMapSettings *settings=nullptr)
Configures layers for rendering optionally considering the map settings.
std::unique_ptr< QgsMapRendererTask > getPdf(const QString &tmpFileName)
Returns a configured pdf export task.
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).
QJsonObject getLegendGraphicsAsJson(QgsLayerTreeModel &model, const Qgis::LegendJsonRenderFlags &jsonRenderFlags=Qgis::LegendJsonRenderFlags())
Returns the map legend as a JSON object.
QImage * getMap()
Returns the map as an image (or nullptr in case of error).
~QgsRenderer()
Destructor for QgsRenderer.
Exception class for WMS service exceptions.
ExceptionCode
Exception codes as defined in OGC scpecifications for WMS 1.1.1 and WMS 1.3.0.
@ QGIS_InvalidParameterValue
@ QGIS_MissingParameterValue
WMS parameter received from the client.
bool htmlInfoOnlyMapTip() const
Returns true if only maptip information is requested for HTML feature info response.
double dxfScale() const
Returns the DXF SCALE parameter.
bool transparentAsBool() const
Returns TRANSPARENT parameter as a bool or its default value if not defined.
QString x() const
Returns X parameter or an empty string if not defined.
QString formatAsString() const
Returns FORMAT parameter as a string.
QgsProjectVersion versionAsNumber() const
Returns VERSION parameter if defined or its default value.
QgsWmsParametersComposerMap composerMapParameters(int mapId) const
Returns the requested parameters for a composer map parameter.
QgsRectangle bboxAsRectangle() const
Returns BBOX as a rectangle if defined and valid.
bool withGeometry() const
Returns if the client wants the feature info response with geometry information.
DxfFormatOption
Options for DXF format.
QString pointTolerance() const
Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.
QString filterGeom() const
Returns the filter geometry found in FILTER_GEOM parameter.
QString composerTemplate() const
Returns TEMPLATE parameter or an empty string if not defined.
Format infoFormat() const
Returns infoFormat.
QString y() const
Returns Y parameter or an empty string if not defined.
double dpiAsDouble() const
Returns DPI parameter as an int or its default value if not defined.
void dump() const
Dumps parameters.
int pointToleranceAsInt() const
Returns FI_POINT_TOLERANCE parameter as an integer.
bool withMapTip() const
withMapTip
QString polygonTolerance() const
Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.
QString i() const
Returns I parameter or an empty string if not defined.
bool pdfLosslessImageCompression() const
Returns true if images embedded in pdf must be compressed using a lossless algorithm.
int lineToleranceAsInt() const
Returns FI_LINE_TOLERANCE parameter as an integer.
QString lineTolerance() const
Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.
QStringList pdfExportMapThemes() const
Returns map themes for GeoPDF export.
bool pdfUseOgcBestPracticeFormatGeoreferencing() const
Returns true if OGC best practice georeferencing shall be used.
bool pdfExportMetadata() const
Returns true if metadata shall be added to the pdf.
QString j() const
Returns J parameter or an empty string if not defined.
int xAsInt() const
Returns X parameter as an int or its default value if not defined.
QString bbox() const
Returns BBOX if defined or an empty string.
int heightAsInt() const
Returns HEIGHT parameter as an int or its default value if not defined.
QColor backgroundColorAsColor() const
Returns BGCOLOR parameter as a QColor or its default value if not defined.
Format format() const
Returns format.
QStringList atlasPk() const
Returns the ATLAS_PK parameter.
QList< QgsWmsParametersHighlightLayer > highlightLayersParameters() const
Returns parameters for each highlight layer.
int iAsInt() const
Returns I parameter as an int or its default value if not defined.
bool pdfAppendGeoreference() const
Returns true if georeference info shall be added to the pdf.
int polygonToleranceAsInt() const
Returns FI_POLYGON_TOLERANCE parameter as an integer.
int widthAsInt() const
Returns WIDTH parameter as an int or its default value if not defined.
QString sldBody() const
Returns SLD_body if defined or an empty string.
bool pdfDisableTiledRasterRendering() const
Returns true if rasters shall be untiled in the pdf.
QString layoutParameter(const QString &id, bool &ok) const
Returns a layout parameter thanks to its id.
bool dxfUseLayerTitleAsName() const
Returns the DXF USE_TITLE_AS_LAYERNAME parameter.
bool pdfForceVectorOutput() const
Returns if pdf should be exported as vector.
bool pdfUseIso32000ExtensionFormatGeoreferencing() const
Returns true, if Iso32000 georeferencing shall be used.
QMap< QString, QString > dimensionValues() const
Returns the dimensions parameter.
bool withDisplayName() const
withDisplayName
int infoFormatVersion() const
Returns the infoFormat version for GML.
QgsLegendSettings legendSettings() const
Returns legend settings.
Qgis::TextRenderFormat pdfTextRenderFormat() const
Returns text render format for pdf export.
QStringList dxfLayerAttributes() const
Returns the DXF LAYERATTRIBUTES parameter.
bool writeGeoPdf() const
Returns if a GeoPDF shall be exported.
Qgis::FeatureSymbologyExport dxfMode() const
Returns the DXF MODE parameter.
QString height() const
Returns HEIGHT parameter or an empty string if not defined.
QString crs() const
Returns CRS or an empty string if none is defined.
int featureCountAsInt() const
Returns FEATURE_COUNT as an integer.
int yAsInt() const
Returns Y parameter as an int or its default value if not defined.
QMap< T, QString > formatOptions() const
Returns the format options for an output format.
Format
Output format for the response.
QString width() const
Returns WIDTH parameter or an empty string if not defined.
QStringList filters() const
Returns the list of filters found in FILTER parameter.
QString dpi() const
Returns DPI parameter or an empty string if not defined.
int jAsInt() const
Returns J parameter as an int or its default value if not defined.
QVector< qreal > pdfPredefinedMapScales() const
Returns list of map scales.
bool pdfSimplifyGeometries() const
Returns if geometries shall to be simplified.
QStringList queryLayersNickname() const
Returns nickname of layers found in QUERY_LAYERS parameter.
Rendering context for the WMS renderer.
QSize mapSize(bool aspectRatio=true) const
Returns the size (in pixels) of the map to render, according to width and height WMS parameters as we...
bool isExternalLayer(const QString &name) const
Returns true if the layer is an external layer, false otherwise.
bool isValidGroup(const QString &name) const
Returns true if name is a group.
QStringList flattenedQueryLayers(const QStringList &layerNames) const
Returns a list of query layer names where group names are replaced by the names of their layer compon...
QgsFeedback * socketFeedback() const
Returns the response feedback if any.
QList< QgsMapLayer * > layersToRender() const
Returns a list of all layers to actually render according to the current configuration.
QgsMapLayer * layer(const QString &nickname) const
Returns the layer corresponding to the nickname, or a nullptr if not found or if the layer do not nee...
bool updateExtent() const
Returns true if the extent has to be updated before the rendering, false otherwise.
const QgsServerSettings & settings() const
Returns settings of the server.
bool isValidWidthHeight() const
Returns true if width and height are valid according to the maximum values defined within the project...
QList< QgsMapLayer * > layersFromGroup(const QString &nickname) const
Returns the group's layers list corresponding to the nickname, or an empty list if not found.
QgsWmsParameters parameters() const
Returns WMS parameters.
void setScaleDenominator(double scaleDenominator)
Sets a custom scale denominator.
QString style(const QgsMapLayer &layer) const
Returns a style's name for a specific layer.
QMap< QString, QList< QgsMapLayer * > > layerGroups() const
Returns a map having layer group names as keys and a list of layers as values.
double mapTileBuffer(int mapWidth) const
Returns the tile buffer in geographical units for the given map width in pixels.
QString layerNickname(const QgsMapLayer &layer) const
Returns the nickname (short name, id or name) of the layer according to the current configuration.
qreal dotsPerMm() const
Returns default dots per mm according to the current configuration.
bool testFlag(Flag flag) const
Returns the status of a rendering flag.
QDomElement sld(const QgsMapLayer &layer) const
Returns a SLD document for a specific layer.
bool isValidLayer(const QString &nickname) const
Returns true if the layer has to be rendered, false otherwise.
const QgsProject * project() const
Returns the project.
int precision() const
Returns the precision to use according to the current configuration.
bool renderMapTiles() const
Returns true if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible ar...
RAII class to restore the rendering context configuration on destruction.
SERVER_EXPORT QString getExpressionFromServerFid(const QString &serverFid, const QgsVectorDataProvider *provider)
Returns the expression feature id based on primary keys.
SERVER_EXPORT QgsFeatureRequest updateFeatureRequestFromServerFids(QgsFeatureRequest &featureRequest, const QStringList &serverFids, const QgsVectorDataProvider *provider)
Returns the feature request based on feature ids build with primary keys.
SERVER_EXPORT QString getServerFid(const QgsFeature &feature, const QgsAttributeList &pkAttributes)
Returns the feature id based on primary keys.
SERVER_EXPORT QString wmsFeatureInfoSchema(const QgsProject &project)
Returns the schema URL for XML GetFeatureInfo request.
SERVER_EXPORT bool wmsInfoFormatSia2045(const QgsProject &project)
Returns if the info format is SIA20145.
SERVER_EXPORT QString wmsFeatureInfoDocumentElementNs(const QgsProject &project)
Returns the document element namespace for XML GetFeatureInfo request.
SERVER_EXPORT QStringList wmsRestrictedComposers(const QgsProject &project)
Returns the restricted composer list.
SERVER_EXPORT bool wmsFeatureInfoSegmentizeWktGeometry(const QgsProject &project)
Returns if the geometry has to be segmentize in GetFeatureInfo request.
SERVER_EXPORT bool wmsFeatureInfoUseAttributeFormSettings(const QgsProject &project)
Returns if feature form settings should be considered for the format of the feature info response.
SERVER_EXPORT QHash< QString, QString > wmsFeatureInfoLayerAliasMap(const QgsProject &project)
Returns the mapping between layer name and wms layer name for GetFeatureInfo request.
SERVER_EXPORT bool wmsFeatureInfoAddWktGeometry(const QgsProject &project)
Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.
SERVER_EXPORT double wmsDefaultMapUnitsPerMm(const QgsProject &project)
Returns the default number of map units per millimeters in case of the scale is not given.
SERVER_EXPORT QString wmsFeatureInfoDocumentElement(const QgsProject &project)
Returns the document element name for XML GetFeatureInfo request.
SERVER_EXPORT int wmsMaxAtlasFeatures(const QgsProject &project)
Returns the maximum number of atlas features which can be printed in a request.
Median cut implementation.
QgsLayerTreeModelLegendNode * legendNode(const QString &rule, QgsLayerTreeModel &model)
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
CONSTLATIN1STRING geoNone()
Constant that holds the string representation for "No ellips/No CRS".
#define Q_NOWARN_DEPRECATED_POP
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
#define Q_NOWARN_DEPRECATED_PUSH
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
QList< QgsFeature > QgsFeatureList
QSet< QgsFeatureId > QgsFeatureIds
#define FID_TO_STRING(fid)
QVector< QgsFeatureStore > QgsFeatureStoreList
QList< int > QgsAttributeList
#define QgsDebugMsgLevel(str, level)
QgsTemporalRange< QDateTime > QgsDateTimeRange
QgsRange which stores a range of date times.
const QgsCoordinateReferenceSystem & outputCrs
const QgsCoordinateReferenceSystem & crs
QgsAbstractMetadataBase::KeywordMap keywords
Metadata keyword map.
bool useIso32000ExtensionFormatGeoreferencing
true if ISO32000 extension format georeferencing should be used.
bool useOgcBestPracticeFormatGeoreferencing
true if OGC "best practice" format georeferencing should be used.
QDateTime creationDateTime
Metadata creation datetime.
QString author
Metadata author tag.
QString producer
Metadata producer tag.
QString creator
Metadata creator tag.
QString subject
Metadata subject tag.
QString title
Metadata title tag.
Layers and optional attribute index to split into multiple layers using attribute value as layer name...
Single variable definition for use within a QgsExpressionContextScope.
QPainter * painter
Painter.
Q_NOWARN_DEPRECATED_POP QgsRenderContext * context
Render context, if available.
Contains settings relating to exporting layouts to raster images.
QList< int > pages
List of specific pages to export, or an empty list to export all pages.
QSize imageSize
Manual size in pixels for output image.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
QVector< qreal > predefinedMapScales
A list of predefined scales to use with the layout.
Contains settings relating to exporting layouts to PDF.
bool useIso32000ExtensionFormatGeoreferencing
true if ISO3200 extension format georeferencing should be used.
bool forceVectorOutput
Set to true to force vector object exports, even when the resultant appearance will differ from the l...
bool rasterizeWholeImage
Set to true to force whole layout to be rasterized while exporting.
QStringList exportThemes
Optional list of map themes to export as GeoPDF layer groups.
bool appendGeoreference
Indicates whether PDF export should append georeference data.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
bool writeGeoPdf
true if GeoPDF files should be created, instead of normal PDF files.
double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
QVector< qreal > predefinedMapScales
A list of predefined scales to use with the layout.
bool simplifyGeometries
Indicates whether vector geometries should be simplified to avoid redundant extraneous detail,...
bool useOgcBestPracticeFormatGeoreferencing
true if OGC "best practice" format georeferencing should be used.
Qgis::TextRenderFormat textRenderFormat
Text rendering format, which controls how text should be rendered in the export (e....
Contains settings relating to exporting layouts to SVG.
double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
QVector< qreal > predefinedMapScales
A list of predefined scales to use with the layout.
Setting to define QGIS Server WMS Dimension.
Setting options for loading vector layers.
QList< QgsWmsParametersLayer > mLayers
QList< QgsWmsParametersHighlightLayer > mHighlightLayers
QList< QgsWmsParametersFilter > mFilter