20#include "moc_qgslayertreemodellegendnode.cpp"
50 , mEmbeddedInParent( false )
56 return qobject_cast<QgsLayerTreeModel *>( parent() );
61 return Qt::ItemIsEnabled;
97 std::optional< QgsScopedRenderContextScaleToPixels > scaleToPx( *ctx->
context );
120 const double itemHeight = std::max(
static_cast< double >( ctx && ctx->
patchSize.height() > 0 ? ctx->
patchSize.height() : settings.
symbolSize().height() ), textHeight );
134 const QString text =
data( Qt::DisplayRole ).toString();
135 json[ QStringLiteral(
"title" ) ] = text;
141 const QIcon symbolIcon =
data( Qt::DecorationRole ).value<QIcon>();
142 if ( symbolIcon.isNull() )
149 size.setWidth( ctx->
patchSize.width( ) );
151 size.setHeight( ctx->
patchSize.height( ) );
158 const int width =
static_cast<int>( size.width() * scaleFactor );
159 const int height =
static_cast<int>( size.height() * scaleFactor );
160 const int y =
static_cast<int>( ( ctx->
top + ( itemHeight - size.height() ) / 2 ) * scaleFactor );
167 x =
static_cast<int>( ctx->
columnLeft * scaleFactor );
170 x =
static_cast<int>( ( ctx->
columnRight - size.width() ) * scaleFactor );
173 symbolIcon.paint( ctx->
painter, x, y, width, height );
180 const QIcon icon =
data( Qt::DecorationRole ).value<QIcon>();
182 return QJsonObject();
184 const QImage image( icon.pixmap( settings.
symbolSize().width(), settings.
symbolSize().height() ).toImage() );
185 QByteArray byteArray;
186 QBuffer buffer( &byteArray );
187 image.save( &buffer,
"PNG" );
188 const QString base64 = QString::fromLatin1( byteArray.toBase64().data() );
191 json[ QStringLiteral(
"icon" ) ] = base64;
198 std::unique_ptr< QgsRenderContext > tempContext;
203 context = tempContext.get();
209 std::optional< QgsTextDocument > tempDocument;
215 document = &tempDocument.value();
218 std::optional< QgsTextDocumentMetrics > tempMetrics;
223 metrics = &tempMetrics.value();
230 const QSizeF labelSizeMM( documentSize / dotsPerMM );
232 double labelXMin = 0.0;
233 double labelXMax = 0.0;
234 double labelYMM = 0.0;
235 if ( ctx && context->
painter() )
261 if ( labelSizeMM.height() < symbolSizeMM.height() )
262 labelYMM += ( symbolSizeMM.height() - labelSizeMM.height() ) / 2;
272 ( labelXMax - labelXMin )* dotsPerMM,
273 std::max( symbolSizeMM.height(), labelSizeMM.height() ) * dotsPerMM ),
295 if ( !vlayer->renderer() )
299 for (
const auto &item : symbolList )
301 vlayer->renderer()->checkLegendSymbolItem( item.ruleKey(), ! vlayer->renderer()->legendSymbolItemChecked( item.ruleKey() ) );
305 vlayer->emitStyleChanged();
306 vlayer->triggerRepaint();
310 if ( !pclayer->renderer() )
313 const QStringList ruleKeys = pclayer->renderer()->legendRuleKeys();
314 for (
const QString &rule : ruleKeys )
316 pclayer->renderer()->checkLegendItem( rule, !pclayer->renderer()->legendItemChecked( rule ) );
320 pclayer->emitStyleChanged();
321 pclayer->triggerRepaint();
333 , mSymbolUsesMapUnits( false )
343 MINIMUM_SIZE = settings.
value(
"/qgis/legendsymbolMinimumSize", 0.5 ).toDouble();
344 MAXIMUM_SIZE = settings.
value(
"/qgis/legendsymbolMaximumSize", 20.0 ).toDouble();
351 connect( nodeLayer, &QObject::destroyed,
this, [
this]() {
mLayerNode =
nullptr; } );
364 return Qt::ItemIsEnabled | Qt::ItemIsUserCheckable | Qt::ItemIsSelectable;
366 return Qt::ItemIsEnabled | Qt::ItemIsSelectable;
384 int maxSize = largeIconSize;
392 if ( !ok && context )
407 context,
false,
nullptr,
nullptr, targetScreen ).toImage(),
409 true ).size() / targetScreen.devicePixelRatio();
412 if ( !mTextOnSymbolLabel.isEmpty() && context )
416 int wInt = ceil( w ), hInt = ceil( h );
417 if ( wInt > minSz.width() ) minSz.setWidth( wInt );
418 if ( hInt > minSz.height() ) minSz.setHeight( hInt );
462 return mCustomSymbol.get();
467 mCustomSymbol.reset(
symbol );
475 std::unique_ptr< QgsSymbol > s(
symbol );
477 if ( !vlayer || !vlayer->
renderer() )
494 if (
auto *lModel =
model() )
495 lModel->legendMapViewData( &mupp, &dpi, &scale );
501 auto context = std::make_unique<QgsRenderContext>( );
502 context->setScaleFactor( dpi / 25.4 );
503 context->setRendererScale( scale );
508 if (
model() && !
model()->targetScreenProperties().isEmpty() )
515 context->setExpressionContext( expContext );
517 return context.release();
520void QgsLayerTreeModelLegendNode::checkAll(
bool state )
524 if ( !vlayer->renderer() )
528 for (
const auto &item : symbolList )
530 vlayer->renderer()->checkLegendSymbolItem( item.ruleKey(), state );
534 vlayer->emitStyleChanged();
535 vlayer->triggerRepaint();
539 if ( !pclayer->renderer() )
542 const QStringList ruleKeys = pclayer->renderer()->legendRuleKeys();
543 for (
const QString &rule : ruleKeys )
545 pclayer->renderer()->checkLegendItem( rule, state );
549 pclayer->emitStyleChanged();
550 pclayer->triggerRepaint();
556 if ( role == Qt::DisplayRole )
560 else if ( role == Qt::EditRole )
564 else if ( role == Qt::DecorationRole )
566 if ( mPixmap.isNull() )
581 if ( !mTextOnSymbolLabel.isEmpty() && context )
583 QPainter painter( &mPixmap );
584 painter.setRenderHint( QPainter::Antialiasing );
585 context->setPainter( &painter );
586 bool isNullSize =
false;
587 const QFontMetricsF fm( mTextOnSymbolTextFormat.
scaledFont( *context, 1.0, &isNullSize ) );
590 const qreal yBaselineVCenter = ( mIconSize.height() + fm.ascent() - fm.descent() ) / 2;
592 QStringList() << mTextOnSymbolLabel, *context, mTextOnSymbolTextFormat );
599 mPixmap.fill( Qt::transparent );
604 else if ( role == Qt::CheckStateRole )
611 if ( !vlayer->renderer() )
614 return vlayer->renderer()->legendSymbolItemChecked( mItem.
ruleKey() ) ? Qt::Checked : Qt::Unchecked;
635 if ( role != Qt::CheckStateRole )
642 if ( !vlayer || !vlayer->
renderer() )
648 project->setDirty(
true );
668 std::unique_ptr< QgsRenderContext > tempRenderContext;
674 tempRenderContext = std::make_unique< QgsRenderContext >();
677 tempRenderContext->setScaleFactor( settings.
dpi() / 25.4 );
678 tempRenderContext->setRendererScale( settings.
mapScale() );
682 tempRenderContext->setForceVectorOutput(
true );
683 tempRenderContext->setPainter( ctx ? ctx->
painter : nullptr );
688 tempRenderContext->setExpressionContext( expContext );
689 context = tempRenderContext.get();
693 const bool hasFixedWidth = ctx && ctx->
patchSize.width() > 0;
694 const bool hasFixedHeight = ctx && ctx->
patchSize.height() > 0;
695 const double desiredHeight = hasFixedHeight ? ctx->
patchSize.height() : settings.
symbolSize().height();
696 const double desiredWidth = hasFixedWidth ? ctx->
patchSize.width() : settings.
symbolSize().width();
697 double height = desiredHeight;
698 double width = desiredWidth;
701 double widthOffset = 0;
702 double heightOffset = 0;
709 const double size = markerSymbol->size( *context ) / context->
scaleFactor();
712 if ( !hasFixedHeight )
714 if ( !hasFixedWidth )
719 bool restrictedSizeSymbolOK;
720 double restrictedSymbolWidth = width;
721 double restrictedSymbolHeight = height;
722 const std::unique_ptr<QgsSymbol> minMaxSizeSymbol(
QgsSymbolLayerUtils::restrictedSizeSymbol( s, minSymbolSize, maxSymbolSize, context, restrictedSymbolWidth, restrictedSymbolHeight, &restrictedSizeSymbolOK ) );
723 if ( minMaxSizeSymbol )
725 s = minMaxSizeSymbol.get();
726 if ( !hasFixedHeight )
727 height = restrictedSymbolHeight;
728 if ( !hasFixedWidth )
729 width = restrictedSymbolWidth;
734 if ( width < desiredWidth )
736 widthOffset = ( desiredWidth - width ) / 2.0;
738 if ( height < desiredHeight )
740 heightOffset = ( desiredHeight - height ) / 2.0;
745 const double currentYCoord = ctx->
top + ( itemHeight - desiredHeight ) / 2;
753 opacity =
static_cast<int >( std::round( 255 * layer->opacity() ) );
762 p->translate( ctx->
columnLeft + widthOffset, currentYCoord + heightOffset );
765 p->translate( ctx->
columnRight - widthOffset - width, currentYCoord + heightOffset );
769 p->scale( 1.0 / dotsPerMM, 1.0 / dotsPerMM );
775 if ( opacity != 255 && useAdvancedEffects )
782 const QSize symbolSize(
static_cast< int >( std::round( width * dotsPerMM ) ),
static_cast<int >( std::round( height * dotsPerMM ) ) );
783 const QSize tempImageSize( symbolSize.width() + maxBleed * 2, symbolSize.height() + maxBleed * 2 );
784 QImage tempImage = QImage( tempImageSize, QImage::Format_ARGB32 );
785 tempImage.fill( Qt::transparent );
786 QPainter imagePainter( &tempImage );
790 imagePainter.translate( maxBleed, maxBleed );
792 imagePainter.translate( -maxBleed, -maxBleed );
795 imagePainter.setCompositionMode( QPainter::CompositionMode_DestinationIn );
796 imagePainter.fillRect( tempImage.rect(), QColor( 0, 0, 0, opacity ) );
799 p->drawImage( -maxBleed, -maxBleed, tempImage );
801 else if ( !restrictedSizeSymbolOK )
806 const QSize symbolSize(
static_cast< int >( std::round( width * dotsPerMM ) ),
static_cast<int >( std::round( height * dotsPerMM ) ) );
807 const QSize maxSize( symbolSize.width() + maxBleed * 2, symbolSize.height() + maxBleed * 2 );
809 p->setClipRect( -maxBleed, -maxBleed, maxSize.width(), maxSize.height(), Qt::IntersectClip );
815 s->
drawPreviewIcon( p, QSize(
static_cast< int >( std::round( width * dotsPerMM ) ),
static_cast< int >( std::round( height * dotsPerMM ) ) ), context,
false,
nullptr, &
patchShape, ctx->
screenProperties );
818 if ( !mTextOnSymbolLabel.isEmpty() )
820 bool isNullSize =
false;
821 const QFontMetricsF fm( mTextOnSymbolTextFormat.
scaledFont( *context, 1.0, &isNullSize ) );
824 const qreal yBaselineVCenter = ( height * dotsPerMM + fm.ascent() - fm.descent() ) / 2;
826 QStringList() << mTextOnSymbolLabel, *context, mTextOnSymbolTextFormat );
831 return QSizeF( std::max( width + 2 * widthOffset,
static_cast< double >( desiredWidth ) ),
832 std::max( height + 2 * heightOffset,
static_cast< double >( desiredHeight ) ) );
840 json[ QStringLiteral(
"scaleMaxDenom" ) ] = mItem.
scaleMaxDenom();
844 json[ QStringLiteral(
"scaleMinDenom" ) ] = mItem.
scaleMinDenom();
847 const QgsSymbol *s = mCustomSymbol ? mCustomSymbol.get() : mItem.
symbol();
872 QImage img( pix.toImage().convertToFormat( QImage::Format_ARGB32_Premultiplied ) );
876 opacity = ( 255 * layer->opacity() );
878 if ( opacity != 255 )
881 painter.begin( &img );
882 painter.setCompositionMode( QPainter::CompositionMode_DestinationIn );
883 painter.fillRect( pix.rect(), QColor( 0, 0, 0, opacity ) );
887 QByteArray byteArray;
888 QBuffer buffer( &byteArray );
889 img.save( &buffer,
"PNG" );
890 const QString base64 = QString::fromLatin1( byteArray.toBase64().data() );
892 json[ QStringLiteral(
"icon" ) ] = base64;
905 if ( mSymbolUsesMapUnits )
914 if ( mIconSize == sz )
922void QgsSymbolLegendNode::updateLabel()
934 if ( showFeatureCount && vl )
940 mLabel += QStringLiteral(
" [%1%2]" ).arg(
941 estimatedCount ? QStringLiteral(
"≈" ) : QString(),
942 count != -1 ? QLocale().toString( count ) : tr(
"N/A" ) );
962 if ( label.isEmpty() )
967 else if ( symLabel.contains(
"[%" ) )
976 else if ( label.contains(
"[%" ) )
1011 if ( role == Qt::DisplayRole || role == Qt::EditRole )
1013 else if ( role == Qt::DecorationRole )
1034 if ( role == Qt::DecorationRole )
1036 return QPixmap::fromImage( mImage );
1038 else if ( role == Qt::SizeHintRole )
1040 return mImage.size();
1051 Q_UNUSED( itemHeight )
1057 const double imgWidth = settings.
wmsLegendSize().width() * scaleFactor;
1058 const double imgHeight = settings.
wmsLegendSize().height() * scaleFactor;
1060 const QImage scaledImg = mImage.scaled( QSizeF( imgWidth, imgHeight ).toSize(), Qt::KeepAspectRatio, Qt::SmoothTransformation );
1065 ctx->
painter->drawImage( QPointF( ctx->
columnLeft * scaleFactor, ctx->
top * scaleFactor ), scaledImg );
1068 case Qt::AlignRight:
1069 ctx->
painter->drawImage( QPointF( ctx->
columnRight * scaleFactor - imgWidth, ctx->
top * scaleFactor ), scaledImg );
1078 QByteArray byteArray;
1079 QBuffer buffer( &byteArray );
1080 mImage.save( &buffer,
"PNG" );
1081 const QString base64 = QString::fromLatin1( byteArray.toBase64().data() );
1084 json[ QStringLiteral(
"icon" ) ] = base64;
1094 , mCheckable( isCheckable )
1095 , mRuleKey( ruleKey )
1096 , mParentRuleKey( parentRuleKey )
1103 return Qt::ItemIsEnabled | Qt::ItemIsUserCheckable | Qt::ItemIsSelectable;
1105 return Qt::ItemIsEnabled | Qt::ItemIsSelectable;
1112 case Qt::DecorationRole:
1115 QPixmap pix( iconSize, iconSize );
1117 return QIcon( pix );
1120 case Qt::DisplayRole:
1131 return mParentRuleKey;
1133 case Qt::CheckStateRole:
1140 if ( !pclayer->renderer() )
1143 return pclayer->renderer()->legendItemChecked( mRuleKey ) ? Qt::Checked : Qt::Unchecked;
1156 if ( role != Qt::CheckStateRole )
1164 if ( !pclayer->renderer() )
1167 pclayer->renderer()->checkLegendItem( mRuleKey, value == Qt::Checked );
1170 pclayer->emitStyleChanged();
1172 pclayer->triggerRepaint();
1173 if ( pclayer->sync3DRendererTo2DRenderer() )
1174 pclayer->convertRenderer3DFromRenderer2D();
1193 if ( ctx->
patchSize.width() < size.width() )
1194 offsetX = ( size.width() - ctx->
patchSize.width() ) / 2.0;
1195 size.setWidth( ctx->
patchSize.width() );
1199 size.setHeight( ctx->
patchSize.height() );
1205 QColor itemColor = mColor;
1209 itemColor.setAlpha( rasterRenderer->opacity() * 255.0 );
1211 ctx->
painter->setBrush( itemColor );
1218 pen.setJoinStyle( Qt::MiterJoin );
1223 ctx->
painter->setPen( Qt::NoPen );
1230 ctx->
painter->drawRect( QRectF( ctx->
columnLeft + offsetX, ctx->
top + ( itemHeight - size.height() ) / 2,
1231 size.width(), size.height() ) );
1234 case Qt::AlignRight:
1235 ctx->
painter->drawRect( QRectF( ctx->
columnRight - size.width() - offsetX, ctx->
top + ( itemHeight - size.height() ) / 2,
1236 size.width(), size.height() ) );
1245 QImage img = QImage( settings.
symbolSize().toSize(), QImage::Format_ARGB32 );
1246 img.fill( Qt::transparent );
1248 QPainter painter( &img );
1249 painter.setRenderHint( QPainter::Antialiasing );
1251 QColor itemColor = mColor;
1255 itemColor.setAlpha( rasterRenderer->opacity() * 255.0 );
1257 painter.setBrush( itemColor );
1264 pen.setJoinStyle( Qt::MiterJoin );
1265 painter.setPen( pen );
1269 painter.setPen( Qt::NoPen );
1272 painter.drawRect( QRectF( 0, 0, settings.
symbolSize().width(), settings.
symbolSize().height() ) );
1274 QByteArray byteArray;
1275 QBuffer buffer( &byteArray );
1276 img.save( &buffer,
"PNG" );
1277 const QString base64 = QString::fromLatin1( byteArray.toBase64().data() );
1280 json[ QStringLiteral(
"icon" ) ] = base64;
1294QImage QgsWmsLegendNode::getLegendGraphic(
bool synchronous )
const
1296 if ( ! mValid && ! mFetcher )
1303 if ( layer && layer->
isValid() )
1314 Q_ASSERT( ! mFetcher );
1326 connect( mFetcher.get(), &QObject::destroyed, &loop, &QEventLoop::quit );
1333 QgsDebugError( QStringLiteral(
"Failed to download legend graphics: layer is not valid." ) );
1342 if ( role == Qt::DecorationRole )
1344 return QPixmap::fromImage( getLegendGraphic() );
1346 else if ( role == Qt::SizeHintRole )
1348 return getLegendGraphic().size();
1359 Q_UNUSED( itemHeight )
1363 double px2mm = 1000. / image.dotsPerMeterX();
1364 double mmWidth = image.width() * px2mm;
1365 double mmHeight = image.height() * px2mm;
1367 QSize targetSize = QSize( mmWidth, mmHeight );
1370 double targetHeight = mmHeight * settings.
wmsLegendSize().width() / mmWidth;
1371 targetSize = QSize( settings.
wmsLegendSize().width(), targetHeight );
1375 double targetWidth = mmWidth * settings.
wmsLegendSize().height() / mmHeight;
1376 targetSize = QSize( targetWidth, settings.
wmsLegendSize().height() );
1381 QImage smoothImage = image.scaled( targetSize / px2mm, Qt::KeepAspectRatio, Qt::SmoothTransformation );
1390 targetSize.height() ),
1392 QRectF( QPointF( 0, 0 ), smoothImage.size() ) );
1395 case Qt::AlignRight:
1399 targetSize.height() ),
1401 QRectF( QPointF( 0, 0 ), smoothImage.size() ) );
1410 QByteArray byteArray;
1411 QBuffer buffer( &byteArray );
1412 mImage.save( &buffer,
"PNG" );
1413 const QString base64 = QString::fromLatin1( byteArray.toBase64().data() );
1416 json[ QStringLiteral(
"icon" ) ] = base64;
1420QImage QgsWmsLegendNode::renderMessage(
const QString &msg )
const
1422 const int fontHeight = 10;
1423 const int margin = fontHeight / 2;
1424 const int nlines = 1;
1426 const int w = 512, h = fontHeight * nlines + margin * ( nlines + 1 );
1427 QImage image( w, h, QImage::Format_ARGB32_Premultiplied );
1429 painter.begin( &image );
1430 painter.setPen( QColor( 255, 0, 0 ) );
1431 painter.setFont( QFont( QStringLiteral(
"Chicago" ), fontHeight ) );
1432 painter.fillRect( 0, 0, w, h, QColor( 255, 255, 255 ) );
1433 painter.drawText( 0, margin + fontHeight, msg );
1440void QgsWmsLegendNode::getLegendGraphicProgress( qint64 cur, qint64 tot )
1442 const QString msg = tot > 0 ? tr(
"Downloading: %1% (%2)" ).arg(
static_cast< int >( std::round( 100 * cur / tot ) ) ).arg(
QgsFileUtils::representFileSize( tot ) )
1444 mImage = renderMessage( msg );
1448void QgsWmsLegendNode::getLegendGraphicErrored(
const QString & )
1461void QgsWmsLegendNode::getLegendGraphicFinished(
const QImage &image )
1466 if ( ! image.isNull() )
1468 if ( image != mImage )
1488 return getLegendGraphic(
true );
1506 if ( role == Qt::DecorationRole )
1509 return QPixmap::fromImage( mImage );
1511 else if ( role == Qt::SizeHintRole )
1514 return mImage.size();
1527 std::unique_ptr< QgsRenderContext > tempRenderContext;
1532 tempRenderContext = std::make_unique< QgsRenderContext >();
1535 tempRenderContext->setScaleFactor( settings.
dpi() / 25.4 );
1536 tempRenderContext->setRendererScale( settings.
mapScale() );
1538 tempRenderContext->setMapToPixel(
QgsMapToPixel( 1 / ( settings.
mmPerMapUnit() * tempRenderContext->scaleFactor() ) ) );
1539 tempRenderContext->setForceVectorOutput(
true );
1540 tempRenderContext->setPainter( ctx ? ctx->
painter : nullptr );
1547 tempRenderContext->setExpressionContext( expContext );
1548 context = tempRenderContext.get();
1565 double labelXOffset;
1569 context->
painter()->restore();
1578void QgsDataDefinedSizeLegendNode::cacheImage()
const
1580 if ( mImage.isNull() )
1586 Q_ASSERT( context );
1587 context->setScaleFactor( 96 / 25.4 );
1603 if ( role == Qt::DisplayRole )
1607 if ( role == Qt::DecorationRole )
1617 Q_UNUSED( itemHeight );
1620 return QSizeF( 0, 0 );
1624 if ( renderContext )
1629 return QSizeF( 0, 0 );
1634 const QStringList textLines( mLabelSettings.
legendString() );
1637 double textWidth, textHeight;
1638 textWidthHeight( textWidth, textHeight, ctx, textFormat, textLines );
1641 const QPointF textPos( renderContext.
scaleFactor() * ( xOffset + settings.
symbolSize().width() / 2.0 - textWidth / 2.0 ), renderContext.
scaleFactor() * ( yOffset + settings.
symbolSize().height() / 2.0 + textHeight / 2.0 ) );
1646 const double symbolWidth = std::max( textWidth, settings.
symbolSize().width() );
1647 const double symbolHeight = std::max( textHeight, settings.
symbolSize().height() );
1648 return QSizeF( symbolWidth, symbolHeight );
1653 Q_UNUSED( settings );
1655 const double mmToPixel = 96.0 / 25.4;
1657 const QStringList textLines( mLabelSettings.
legendString() );
1662 double textWidth, textHeight;
1663 textWidthHeight( textWidth, textHeight, ctx, textFormat, textLines );
1666 QByteArray byteArray;
1667 QBuffer buffer( &byteArray );
1668 previewPixmap.save( &buffer,
"PNG" );
1669 const QString base64 = QString::fromLatin1( byteArray.toBase64().data() );
1672 json[ QStringLiteral(
"icon" ) ] = base64;
1676void QgsVectorLabelLegendNode::textWidthHeight(
double &width,
double &height,
QgsRenderContext &ctx,
const QgsTextFormat &textFormat,
const QStringList &textLines )
const
@ Symbol
Symbol icon (excluding label)
@ SymbolLabel
Symbol label (excluding icon)
@ Point
Text at point of origin layout mode.
@ RectangleCapHeightBased
Similar to Rectangle mode, but uses cap height only when calculating font heights for the first line ...
@ Horizontal
Horizontally oriented text.
@ Millimeters
Millimeters.
@ RenderSymbolPreview
The render is for a symbol preview only and map based properties may not be available,...
@ LosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ Antialiasing
Use antialiasing while drawing.
@ UseAdvancedEffects
Enable layer opacity and blending effects.
TextHorizontalAlignment
Text horizontal alignment.
@ WrapLines
Automatically wrap long lines of text.
QgsDataDefinedSizeLegendNode(QgsLayerTreeLayer *nodeLayer, const QgsDataDefinedSizeLegend &settings, QObject *parent=nullptr)
Construct the node using QgsDataDefinedSizeLegend as definition of the node's appearance.
ItemMetrics draw(const QgsLegendSettings &settings, ItemContext *ctx) override
Entry point called from QgsLegendRenderer to do the rendering.
QVariant data(int role) const override
Returns data associated with the item. Must be implemented in derived class.
~QgsDataDefinedSizeLegendNode() override
Object that keeps configuration of appearance of marker symbol's data-defined size in legend.
void setFont(const QFont &font)
Sets font used for rendering of labels - only valid for collapsed legend.
void setTextColor(const QColor &color)
Sets text color for rendering of labels - only valid for collapsed legend.
QImage collapsedLegendImage(QgsRenderContext &context, const QColor &backgroundColor=Qt::transparent, double paddingMM=1) const
Returns output image that would be shown in the legend. Returns invalid image if legend is not config...
void drawCollapsedLegend(QgsRenderContext &context, QSizeF *outputSize SIP_OUT=nullptr, double *labelXOffset SIP_OUT=nullptr) const
Draw the legend if using LegendOneNodeForAll and optionally output size of the legend and x offset of...
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
Stores the component parts of a data source URI (e.g.
bool useEstimatedMetadata() const
Returns true if estimated metadata should be used for the connection.
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 QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void appendScopes(const QList< QgsExpressionContextScope * > &scopes)
Appends a list of scopes to the end of the context.
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...
virtual void setLegendSymbolItem(const QString &key, QgsSymbol *symbol)
Sets the symbol to be used for a legend symbol item.
virtual void checkLegendSymbolItem(const QString &key, bool state=true)
Sets whether the legend symbology item with the specified ley should be checked.
static QString representFileSize(qint64 bytes)
Returns the human size from bytes.
void progress(qint64 received, qint64 total)
Emitted to report progress.
void error(const QString &msg)
Emitted when an error occurs.
void finish(const QImage &legend)
Emitted when the download completes.
QVariant data(int role) const override
Returns data associated with the item. Must be implemented in derived class.
QgsImageLegendNode(QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent=nullptr)
Constructor for QgsImageLegendNode.
QSizeF drawSymbol(const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override
Draws symbol on the left side of the item.
QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const override
Adds a symbol in base64 string within a JSON object with the key "icon".
static QRect nonTransparentImageRect(const QImage &image, QSize minSize=QSize(), bool center=false)
Calculates the non-transparent region of an image.
Layer tree node points to a map layer.
QString labelExpression() const
Returns the expression member of the LayerTreeNode.
QgsLegendPatchShape patchShape() const
Returns the symbol patch shape to use when rendering the legend node symbol.
QString name() const override
Returns the layer's name.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
QSizeF patchSize() const
Returns the user (overridden) size for the legend node.
An abstract interface for legend items returned from QgsMapLayerLegend implementation.
virtual QVariant data(int role) const =0
Returns data associated with the item. Must be implemented in derived class.
QJsonObject exportToJson(const QgsLegendSettings &settings, const QgsRenderContext &context)
Entry point called from QgsLegendRenderer to do the rendering in a JSON object.
@ SimpleLegend
Simple label with icon legend node type.
@ RasterSymbolLegend
Raster symbol legend node type.
@ ImageLegend
Raster image legend node type.
@ DataDefinedSizeLegend
Marker symbol legend node type.
@ WmsLegend
WMS legend node type.
@ SymbolLegend
Vector symbol legend node type.
void checkAllItems()
Checks all checkable items belonging to the same layer as this node.
@ ParentRuleKey
Rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2....
@ NodeType
Type of node. Added in 3.16.
@ RuleKey
Rule key of the node (QString)
void uncheckAllItems()
Unchecks all checkable items belonging to the same layer as this node.
QgsLayerTreeLayer * mLayerNode
QgsLayerTreeModelLegendNode(QgsLayerTreeLayer *nodeL, QObject *parent=nullptr)
Construct the node with pointer to its parent layer node.
virtual void setUserPatchSize(QSizeF size)
Sets the user (overridden) size for the legend node.
void sizeChanged()
Emitted when the size of this node changes.
void dataChanged()
Emitted on internal data change so the layer tree model can forward the signal to views.
QgsRenderContext * createTemporaryRenderContext() const
Returns a temporary context or nullptr if legendMapViewData are not valid.
virtual QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const
Adds a symbol in base64 string within a JSON object with the key "icon".
QgsLayerTreeModel * model() const
Returns pointer to model owning this legend node.
void toggleAllItems()
Toggle all checkable items belonging to the same layer as this node.
QgsLegendPatchShape mPatchShape
virtual QSizeF userPatchSize() const
Returns the user (overridden) size for the legend node.
virtual ItemMetrics draw(const QgsLegendSettings &settings, ItemContext *ctx)
Entry point called from QgsLegendRenderer to do the rendering.
virtual Qt::ItemFlags flags() const
Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled.
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.
virtual void setEmbeddedInParent(bool embedded)
virtual bool setData(const QVariant &value, int role)
Sets some data associated with the item. Default implementation does nothing and returns false.
virtual QSizeF drawSymbolText(const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize) const
Draws label on the right side of the item.
A model representing the layer tree, including layers and groups of layers.
QSet< QgsScreenProperties > targetScreenProperties() const
Returns the target screen properties to use when generating icons.
static int scaleIconSize(int standardSize)
Scales an layer tree model icon size to compensate for display pixel density, making the icon size hi...
const QgsMapSettings * legendFilterMapSettings() const
Returns the current map settings used for the current legend filter (or nullptr if none is enabled)
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer. Properties are stored in a map and saved in project file.
Represents a patch shape for use in map legends.
Stores the appearance and layout settings for legend drawing with QgsLegendRenderer.
bool drawRasterStroke() const
Returns whether a stroke will be drawn around raster symbol items.
QSizeF wmsLegendSize() const
Returns the size (in millimeters) of WMS legend graphics shown in the legend.
double minimumSymbolSize() const
Returns the minimum symbol size (in mm).
double autoWrapLinesAfter() const
Returns the maximum line length (in millimeters) allowed before lines of text in the legend will be a...
double rasterStrokeWidth() const
Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items.
QSizeF symbolSize() const
Returns the default symbol size (in millimeters) used for legend items.
double maximumSymbolSize() const
Returns the maximum symbol size (in mm).
QColor rasterStrokeColor() const
Returns the stroke color for the stroke drawn around raster symbol items.
Q_DECL_DEPRECATED bool useAdvancedEffects() const
QgsLegendStyle style(Qgis::LegendComponent s) const
Returns the style for a legend component.
Q_DECL_DEPRECATED int dpi() const
bool synchronousLegendRequests() const
Returns whether to request legend graphics synchronously.
Q_DECL_DEPRECATED double mmPerMapUnit() const
QStringList evaluateItemText(const QString &text, const QgsExpressionContext &context) const
Splits a string using the wrap char taking into account handling empty wrap char which means no wrapp...
Qt::AlignmentFlag symbolAlignment() const
Returns the alignment for placement of legend symbols.
Q_DECL_DEPRECATED double mapScale() const
Returns the legend map scale.
Qt::Alignment alignment() const
Returns the alignment for the legend component.
QgsTextFormat & textFormat()
Returns the text format used for rendering this legend component.
double margin(Side side) const
Returns the margin (in mm) for the specified side of the component.
Stores information about one class/rule of a vector layer renderer in a unified way that can be used ...
QString parentRuleKey() const
Key of the parent legend node.
int scaleMaxDenom() const
Max scale denominator of the scale range.
void setSymbol(QgsSymbol *s)
Sets the symbol of the item.
int scaleMinDenom() const
Min scale denominator of the scale range.
QgsSymbol * symbol() const
Returns associated symbol. May be nullptr.
QString ruleKey() const
Returns unique identifier of the rule for identification of the item within renderer.
bool isCheckable() const
Returns whether the item is user-checkable - whether renderer supports enabling/disabling it.
QString label() const
Returns text label.
Base class for all map layer types.
void triggerRepaint(bool deferredUpdate=false)
Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
void emitStyleChanged()
Triggers an emission of the styleChanged() signal.
QgsProject * project() const
Returns the parent project if this map layer is added to a project.
Contains configuration for rendering maps.
Perform transforms between map coordinates and device coordinates.
A marker symbol type, for rendering Point and MultiPoint geometries.
Contains settings for how a map layer will be labeled.
QString legendString() const
legendString
static QPixmap labelSettingsPreviewPixmap(const QgsPalLayerSettings &settings, QSize size, const QString &previewText=QString(), int padding=0, const QgsScreenProperties &screen=QgsScreenProperties())
Returns a pixmap preview for label settings.
const QgsTextFormat & format() const
Returns the label text formatting settings, e.g., font settings, buffer settings, etc.
Represents a map layer supporting display of point clouds.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Base class for raster data providers.
virtual QgsImageFetcher * getLegendGraphicFetcher(const QgsMapSettings *mapSettings)
Returns a new image downloader for the raster legend.
Represents a raster layer.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
Raster renderer pipe that applies colors to a raster.
Qt::ItemFlags flags() const override
Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled.
bool setData(const QVariant &value, int role) override
Sets some data associated with the item. Default implementation does nothing and returns false.
QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const override
Adds a symbol in base64 string within a JSON object with the key "icon".
QgsRasterSymbolLegendNode(QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent=nullptr, bool isCheckable=false, const QString &ruleKey=QString(), const QString &parentRuleKey=QString())
Constructor for QgsRasterSymbolLegendNode.
QVariant data(int role) const override
Returns data associated with the item. Must be implemented in derived class.
QSizeF drawSymbol(const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override
Draws symbol on the left side of the item.
Contains information about the context of a rendering operation.
void setForceVectorOutput(bool force)
Sets whether rendering operations should use vector operations instead of any faster raster shortcuts...
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
void setScaleFactor(double factor)
Sets the scaling factor for the render to convert painter units to physical sizes.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QPainter * painter()
Returns the destination QPainter for the render operation.
void setPainterFlagsUsingContext(QPainter *painter=nullptr) const
Sets relevant flags on a destination painter, using the flags and settings currently defined for the ...
QgsExpressionContext & expressionContext()
Gets the expression context.
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
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 fromQPainter(QPainter *painter)
Creates a default render context given a pixel based QPainter destination.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
void setRendererScale(double scale)
Sets the renderer map scale.
Qgis::RenderContextFlags flags() const
Returns combination of flags used for rendering.
Scoped object for saving and restoring a QPainter object's state.
Scoped object for temporary scaling of a QgsRenderContext for pixel based rendering.
Stores properties relating to a screen.
double devicePixelRatio() const
Returns the ratio between physical pixels and device-independent pixels for the screen.
Stores settings for use within QGIS.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
QVariant data(int role) const override
Returns data associated with the item. Must be implemented in derived class.
QgsSimpleLegendNode(QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon=QIcon(), QObject *parent=nullptr, const QString &key=QString())
Constructor for QgsSimpleLegendNode.
static QPixmap symbolPreviewPixmap(const QgsSymbol *symbol, QSize size, int padding=0, QgsRenderContext *customContext=nullptr, bool selected=false, const QgsExpressionContext *expressionContext=nullptr, const QgsLegendPatchShape *shape=nullptr, const QgsScreenProperties &screen=QgsScreenProperties())
Returns a pixmap preview for a color ramp.
static QgsSymbol * restrictedSizeSymbol(const QgsSymbol *s, double minSize, double maxSize, QgsRenderContext *context, double &width, double &height, bool *ok=nullptr)
Creates a new symbol with size restricted to min/max size if original size is out of min/max range.
static double estimateMaxSymbolBleed(QgsSymbol *symbol, const QgsRenderContext &context)
Returns the maximum estimated bleed for the symbol.
static double MAXIMUM_SIZE
QString evaluateLabel(const QgsExpressionContext &context=QgsExpressionContext(), const QString &label=QString())
Evaluates and returns the text label of the current node.
const QgsSymbol * symbol() const
Returns the symbol used by the legend node.
void setPatchShape(const QgsLegendPatchShape &shape)
Sets the symbol patch shape to use when rendering the legend node symbol.
QgsSymbolLegendNode(QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent=nullptr)
Constructor for QgsSymbolLegendNode.
void setIconSize(QSize sz)
Set the icon size.
QgsExpressionContextScope * createSymbolScope() const
Create an expression context scope containing symbol related variables.
QgsLegendPatchShape patchShape() const
Returns the symbol patch shape to use when rendering the legend node symbol.
QSize minimumIconSize() const
Calculates the minimum icon size to prevent cropping.
QSizeF drawSymbol(const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override
Draws symbol on the left side of the item.
void invalidateMapBasedData() override
Notification from model that information from associated map view has changed.
bool setData(const QVariant &value, int role) override
Sets some data associated with the item. Default implementation does nothing and returns false.
Qt::ItemFlags flags() const override
Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled.
void setCustomSymbol(QgsSymbol *symbol)
Sets the node's custom symbol.
void setEmbeddedInParent(bool embedded) override
QgsSymbol * customSymbol() const
Returns the node's custom symbol.
QString symbolLabel() const
Label of the symbol, user defined label will be used, otherwise will default to the label made by QGI...
void setSymbol(QgsSymbol *symbol)
Sets the symbol to be used by the legend node.
static double MINIMUM_SIZE
QVariant data(int role) const override
Returns data associated with the item. Must be implemented in derived class.
QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const override
Adds a symbol in base64 string within a JSON object with the key "icon".
Abstract base class for all rendered symbols.
bool usesMapUnits() const
Returns true if the symbol has any components which use map unit based sizes.
void drawPreviewIcon(QPainter *painter, QSize size, QgsRenderContext *customContext=nullptr, bool selected=false, const QgsExpressionContext *expressionContext=nullptr, const QgsLegendPatchShape *patchShape=nullptr, const QgsScreenProperties &screen=QgsScreenProperties())
Draws an icon of the symbol that occupies an area given by size using the specified painter.
Qgis::SymbolType type() const
Returns the symbol's type.
Contains pre-calculated metrics of a QgsTextDocument.
QSizeF documentSize(Qgis::TextLayoutMode mode, Qgis::TextOrientation orientation) const
Returns the overall size of the document.
double firstLineCapHeight() const
Returns the cap height for the first line of text.
static QgsTextDocumentMetrics calculateMetrics(const QgsTextDocument &document, const QgsTextFormat &format, const QgsRenderContext &context, double scaleFactor=1.0, const QgsTextDocumentRenderContext &documentContext=QgsTextDocumentRenderContext())
Returns precalculated text metrics for a text document, when rendered using the given base format and...
const QgsTextDocument & document() const
Returns the document associated with the calculated metrics.
Encapsulates the context in which a text document is to be rendered.
void setFlags(Qgis::TextRendererFlags flags)
Sets associated text renderer flags.
void setMaximumWidth(double width)
Sets the maximum width (in painter units) for rendered text.
Represents a document consisting of one or more QgsTextBlock objects.
static QgsTextDocument fromTextAndFormat(const QStringList &lines, const QgsTextFormat &format)
Constructor for QgsTextDocument consisting of a set of lines, respecting settings from a text format.
Container for all settings relating to text rendering.
QFont scaledFont(const QgsRenderContext &context, double scaleFactor=1.0, bool *isZeroSize=nullptr) const
Returns a font with the size scaled to match the format's size settings (including units and map unit...
QFont toQFont() const
Returns a QFont matching the relevant settings from this text format.
QColor color() const
Returns the color that text will be rendered in.
static double textWidth(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, QFontMetricsF *fontMetrics=nullptr)
Returns the width of a text based on a given format.
static void drawDocument(const QRectF &rect, const QgsTextFormat &format, const QgsTextDocument &document, const QgsTextDocumentMetrics &metrics, QgsRenderContext &context, Qgis::TextHorizontalAlignment horizontalAlignment=Qgis::TextHorizontalAlignment::Left, Qgis::TextVerticalAlignment verticalAlignment=Qgis::TextVerticalAlignment::Top, double rotation=0, Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Rectangle, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags())
Draws a text document within a rectangle using the specified settings.
static void drawText(const QRectF &rect, double rotation, Qgis::TextHorizontalAlignment alignment, const QStringList &textLines, QgsRenderContext &context, const QgsTextFormat &format, bool drawAsOutlines=true, Qgis::TextVerticalAlignment vAlignment=Qgis::TextVerticalAlignment::Top, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Rectangle)
Draws text within a rectangle using the specified settings.
static QFontMetricsF fontMetrics(QgsRenderContext &context, const QgsTextFormat &format, double scaleFactor=1.0)
Returns the font metrics for the given text format, when rendered in the specified render context.
static double calculateScaleFactorForFormat(const QgsRenderContext &context, const QgsTextFormat &format)
Returns the scale factor used for upscaling font sizes and downscaling destination painter devices.
static double textHeight(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Point, QFontMetricsF *fontMetrics=nullptr, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), double maxLineWidth=0)
Returns the height of a text based on a given format.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
QgsVectorLabelLegendNode(QgsLayerTreeLayer *nodeLayer, const QgsPalLayerSettings &labelSettings, QObject *parent=nullptr)
QgsVectorLabelLegendNode.
QSizeF drawSymbol(const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override
drawSymbol
QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const override
exportSymbolToJson
~QgsVectorLabelLegendNode() override
QVariant data(int role) const override
data Returns data associated with the item
Represents a vector layer which manages a vector based dataset.
QgsExpressionContextScope * createExpressionContextScope() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
long long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
void symbolFeatureCountMapChanged()
Emitted when the feature count for symbols on this layer has been recalculated.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
QImage getLegendGraphicBlocking() const
Fetches the image from the server and returns it.
QSizeF drawSymbol(const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override
Draws symbol on the left side of the item.
void invalidateMapBasedData() override
Notification from model that information from associated map view has changed.
QVariant data(int role) const override
Returns data associated with the item. Must be implemented in derived class.
~QgsWmsLegendNode() override
QgsWmsLegendNode(QgsLayerTreeLayer *nodeLayer, QObject *parent=nullptr)
Constructor for QgsWmsLegendNode.
QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const override
Adds a symbol in base64 string within a JSON object with the key "icon".
#define Q_NOWARN_DEPRECATED_POP
#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< QgsLegendSymbolItem > QgsLegendSymbolList
#define QgsDebugError(str)
Single variable definition for use within a QgsExpressionContextScope.
QPainter * painter
Painter.
double top
Top y-position of legend item.
QgsLegendPatchShape patchShape
The patch shape to render for the node.
QgsScreenProperties screenProperties
Destination screen properties.
double maxSiblingSymbolWidth
Largest symbol width, considering all other sibling legend components associated with the current com...
QSizeF patchSize
Symbol patch size to render for the node.
const QgsTextDocument * textDocument
Optional text document.
double columnLeft
Left side of current legend column.
const QgsTextDocumentMetrics * textDocumentMetrics
Optional text document metrics.
double columnRight
Right side of current legend column.
Q_NOWARN_DEPRECATED_POP QgsRenderContext * context
Render context, if available.