18 #include "qgssettings.h"
79 const auto constOrder = order;
80 for (
int id : constOrder )
81 orderStr << QString::number(
id );
82 QString
str = orderStr.isEmpty() ? QStringLiteral(
"empty" ) : orderStr.join( QLatin1Char(
',' ) );
91 int numNodes = lst.count();
100 QgsDebugMsg( QStringLiteral(
"Legend node order manipulation is invalid without existing legend" ) );
104 int numNodes = _originalLegendNodeCount( nodeLayer );
107 order.reserve( numNodes );
108 for (
int i = 0; i < numNodes; ++i )
115 QString orderStr = nodeLayer->
customProperty( QStringLiteral(
"legend/node-order" ) ).toString();
117 if ( orderStr.isEmpty() )
118 return _makeNodeOrder( nodeLayer );
120 if ( orderStr == QLatin1String(
"empty" ) )
123 int numNodes = _originalLegendNodeCount( nodeLayer );
126 const auto constSplit = orderStr.split(
',' );
127 for (
const QString &item : constSplit )
130 int id = item.toInt( &ok );
131 if ( !ok || id < 0 || id >= numNodes )
132 return _makeNodeOrder( nodeLayer );
142 return nodeLayer->
customProperties().contains( QStringLiteral(
"legend/node-order" ) );
147 nodeLayer->
setCustomProperty(
"legend/label-" + QString::number( originalIndex ), newLabel );
152 return nodeLayer->
customProperty(
"legend/label-" + QString::number( originalIndex ) ).toString();
157 return nodeLayer->
customProperties().contains(
"legend/label-" + QString::number( originalIndex ) );
162 QDomDocument patchDoc;
163 QDomElement patchElem = patchDoc.createElement( QStringLiteral(
"patch" ) );
165 patchDoc.appendChild( patchElem );
166 nodeLayer->
setCustomProperty(
"legend/patch-shape-" + QString::number( originalIndex ), patchDoc.toString() );
171 QString patchDef = nodeLayer->
customProperty(
"legend/patch-shape-" + QString::number( originalIndex ) ).toString();
172 if ( patchDef.isEmpty() )
175 QDomDocument doc( QStringLiteral(
"patch" ) );
176 doc.setContent( patchDef );
184 if ( size.isValid() )
192 const QString size = nodeLayer->
customProperty(
"legend/symbol-size-" + QString::number( originalIndex ) ).toString();
193 if ( size.isEmpty() )
207 doc.appendChild( elem );
208 nodeLayer->
setCustomProperty(
"legend/custom-symbol-" + QString::number( originalIndex ), doc.toString() );
216 const QString symbolDef = nodeLayer->
customProperty(
"legend/custom-symbol-" + QString::number( originalIndex ) ).toString();
217 if ( symbolDef.isEmpty() )
221 doc.setContent( symbolDef );
222 const QDomElement elem = doc.documentElement();
237 QDomElement elem = doc.createElement( QStringLiteral(
"rampSettings" ) );
238 settings->
writeXml( doc, elem, rwContext );
239 doc.appendChild( elem );
240 nodeLayer->
setCustomProperty(
"legend/custom-ramp-settings-" + QString::number( originalIndex ), doc.toString() );
243 nodeLayer->
removeCustomProperty(
"legend/custom-ramp-settings-" + QString::number( originalIndex ) );
248 const QString settingsDef = nodeLayer->
customProperty(
"legend/custom-ramp-settings-" + QString::number( originalIndex ) ).toString();
249 if ( settingsDef.isEmpty() )
253 doc.setContent( settingsDef );
254 const QDomElement elem = doc.documentElement();
260 settings.
readXml( elem, rwContext );
266 if ( columnBreakBeforeNode )
267 nodeLayer->
setCustomProperty(
"legend/column-break-" + QString::number( originalIndex ), QStringLiteral(
"1" ) );
274 return nodeLayer->
customProperty(
"legend/column-break-" + QString::number( originalIndex ) ).toInt();
281 const auto constNodes = nodes;
285 if ( !userLabel.isNull() )
291 symbolNode->setPatchShape( shape );
300 colorRampNode->setSettings( *settings );
305 if ( userSize.isValid() )
321 QList<QgsLayerTreeModelLegendNode *> newOrder;
322 QSet<int> usedIndices;
323 const auto constOrder = order;
324 for (
int idx : constOrder )
326 if ( usedIndices.contains( idx ) )
328 QgsDebugMsg( QStringLiteral(
"invalid node order. ignoring." ) );
332 newOrder << nodes[idx];
337 for (
int i = 0; i < nodes.count(); ++i )
339 if ( !usedIndices.contains( i ) )
360 QList<QgsLayerTreeModelLegendNode *> nodes;
366 if ( nodeLayer->
customProperty( QStringLiteral(
"showFeatureCount" ), 0 ).toBool() )
369 QgsSettings settings;
378 if (
auto *lDataDefinedSizeLegendSettings = i.dataDefinedSizeLegendSettings() )
383 if ( mTextOnSymbolEnabled && mTextOnSymbolContent.contains( i.ruleKey() ) )
385 legendNode->setTextOnSymbolLabel( mTextOnSymbolContent.value( i.ruleKey() ) );
386 legendNode->setTextOnSymbolTextFormat( mTextOnSymbolTextFormat );
392 if ( nodes.count() == 1 && nodes[0]->data( Qt::EditRole ).toString().isEmpty() )
411 for (
int i = 0; i < pList.size(); ++i )
416 if ( ruleBasedLabeling && ruleBasedLabeling->
rootRule() )
426 nodes.append( node );
437 mTextOnSymbolEnabled =
false;
439 mTextOnSymbolContent.clear();
441 mShowLabelLegend = elem.attribute( QStringLiteral(
"showLabelLegend" ), QStringLiteral(
"0" ) ).compare( QStringLiteral(
"1" ), Qt::CaseInsensitive ) == 0;
443 QDomElement tosElem = elem.firstChildElement( QStringLiteral(
"text-on-symbol" ) );
444 if ( !tosElem.isNull() )
446 mTextOnSymbolEnabled =
true;
447 QDomElement tosFormatElem = tosElem.firstChildElement( QStringLiteral(
"text-style" ) );
448 mTextOnSymbolTextFormat.
readXml( tosFormatElem, context );
449 QDomElement tosContentElem = tosElem.firstChildElement( QStringLiteral(
"content" ) );
450 QDomElement tosContentItemElem = tosContentElem.firstChildElement( QStringLiteral(
"item" ) );
451 while ( !tosContentItemElem.isNull() )
453 mTextOnSymbolContent.insert( tosContentItemElem.attribute( QStringLiteral(
"key" ) ), tosContentItemElem.attribute( QStringLiteral(
"value" ) ) );
454 tosContentItemElem = tosContentItemElem.nextSiblingElement( QStringLiteral(
"item" ) );
461 QDomElement elem = doc.createElement( QStringLiteral(
"legend" ) );
462 elem.setAttribute( QStringLiteral(
"type" ), QStringLiteral(
"default-vector" ) );
463 elem.setAttribute( QStringLiteral(
"showLabelLegend" ), mShowLabelLegend );
465 if ( mTextOnSymbolEnabled )
467 QDomElement tosElem = doc.createElement( QStringLiteral(
"text-on-symbol" ) );
468 QDomElement tosFormatElem = mTextOnSymbolTextFormat.
writeXml( doc, context );
469 tosElem.appendChild( tosFormatElem );
470 QDomElement tosContentElem = doc.createElement( QStringLiteral(
"content" ) );
471 for (
auto it = mTextOnSymbolContent.constBegin(); it != mTextOnSymbolContent.constEnd(); ++it )
473 QDomElement tosContentItemElem = doc.createElement( QStringLiteral(
"item" ) );
474 tosContentItemElem.setAttribute( QStringLiteral(
"key" ), it.key() );
475 tosContentItemElem.setAttribute( QStringLiteral(
"value" ), it.value() );
476 tosContentElem.appendChild( tosContentItemElem );
478 tosElem.appendChild( tosContentElem );
479 elem.appendChild( tosElem );
497 QList<QgsLayerTreeModelLegendNode *> nodes;
520 QList<QgsLayerTreeModelLegendNode *> nodes;
532 if ( indexScalar > -1 && indexVector > -1 && indexScalar != indexVector )
534 else if ( indexScalar > -1 )
536 else if ( indexVector > -1 )
546 if ( indexScalar > -1 )
572 for (
const QPair< QString, QColor > &item : items )
598 return QList<QgsLayerTreeModelLegendNode *>();
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
virtual QStringList subProviders() const
Gets list of sub-providers within the layer's labeling.
virtual QgsPalLayerSettings settings(const QString &providerId=QString()) const =0
Gets associated label settings.
Settings for a color ramp legend node.
bool useContinuousLegend() const
Returns true if a continuous gradient legend will be used.
void readXml(const QDomElement &element, const QgsReadWriteContext &context)
Reads settings from an XML element.
void writeXml(QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context) const
Writes settings to an XML element.
A legend node which renders a color ramp.
A ramp shader will color a raster pixel based on a list of values ranges in a ramp.
QList< QgsColorRampShader::ColorRampItem > colorRampItemList() const
Returns the custom colormap.
void legendSymbologyItems(QList< QPair< QString, QColor > > &symbolItems) const override
Returns legend symbology items if provided by renderer.
const QgsColorRampLegendNodeSettings * legendSettings() const
Returns the color ramp shader legend settings.
Type colorRampType() const
Returns the color ramp type.
QgsColorRamp * createColorRamp() const
Creates a gradient color ramp from shader settings.
@ Interpolated
Interpolates the color between two class breaks linearly.
@ Discrete
Assigns the color of the higher class for every pixel between two class breaks.
@ Exact
Assigns the color of the exact matching value in the color ramp item list.
Produces legend node with a marker symbol.
Default legend implementation for mesh layers.
QgsDefaultMeshLayerLegend(QgsMeshLayer *ml)
Creates an instance for the given mesh layer.
QList< QgsLayerTreeModelLegendNode * > createLayerTreeModelLegendNodes(QgsLayerTreeLayer *nodeLayer) override
Returns list of legend nodes to be used for a particular layer tree layer node.
Default legend implementation for point cloud layers.
QList< QgsLayerTreeModelLegendNode * > createLayerTreeModelLegendNodes(QgsLayerTreeLayer *nodeLayer) override
Returns list of legend nodes to be used for a particular layer tree layer node.
QgsDefaultPointCloudLayerLegend(QgsPointCloudLayer *layer)
Creates an instance for the given point cloud layer.
Default legend implementation for raster layers.
QgsDefaultRasterLayerLegend(QgsRasterLayer *rl)
QList< QgsLayerTreeModelLegendNode * > createLayerTreeModelLegendNodes(QgsLayerTreeLayer *nodeLayer) override
Returns list of legend nodes to be used for a particular layer tree layer node.
Default legend implementation for vector layers.
QList< QgsLayerTreeModelLegendNode * > createLayerTreeModelLegendNodes(QgsLayerTreeLayer *nodeLayer) override
Returns list of legend nodes to be used for a particular layer tree layer node.
QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const override
Writes configuration to a DOM element, to be used later with readXml()
void readXml(const QDomElement &elem, const QgsReadWriteContext &context) override
Reads configuration from a DOM element previously written by writeXml()
QgsDefaultVectorLayerLegend(QgsVectorLayer *vl)
virtual QList< QgsLayerTreeModelLegendNode * > legendItems(QgsLayerTreeLayer *nodeLayer) const
Returns list of legend nodes for the diagram.
virtual QgsLegendSymbolList legendSymbolItems() const
Returns a list of symbology items for the legend.
virtual QString legendClassificationAttribute() const
If supported by the renderer, return classification attribute for the use in legend.
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 void setColumnBreak(bool breakBeforeNode)
Sets whether a forced column break should occur before the node.
virtual void setUserPatchSize(QSizeF size)
Sets the user (overridden) size for the legend node.
virtual void setEmbeddedInParent(bool embedded)
virtual void setUserLabel(const QString &userLabel)
void setCustomProperty(const QString &key, const QVariant &value)
Sets a custom property for the node. Properties are stored in a map and saved in project file.
void removeCustomProperty(const QString &key)
Remove a custom property from layer. Properties are stored in a map and saved in project file.
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.
QStringList customProperties() const
Returns list of keys stored in custom properties.
Represents a patch shape for use in map legends.
void readXml(const QDomElement &element, const QgsReadWriteContext &context)
Read settings from a DOM element.
void writeXml(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) const
Write settings into a DOM element.
The class stores information about one class/rule of a vector layer renderer in a unified way that ca...
static void setLegendNodeOrder(QgsLayerTreeLayer *nodeLayer, const QList< int > &order)
static void setLegendNodeColorRampSettings(QgsLayerTreeLayer *nodeLayer, int originalIndex, const QgsColorRampLegendNodeSettings *settings)
Sets a custom legend color ramp settings for the legend node belonging to nodeLayer at the specified ...
static void setLegendNodeCustomSymbol(QgsLayerTreeLayer *nodeLayer, int originalIndex, const QgsSymbol *symbol)
Sets a custom legend symbol for the legend node belonging to nodeLayer at the specified originalIndex...
static QString legendNodeUserLabel(QgsLayerTreeLayer *nodeLayer, int originalIndex)
static QSizeF legendNodeSymbolSize(QgsLayerTreeLayer *nodeLayer, int originalIndex)
Returns the legend node symbol size for the legend node belonging to nodeLayer at the specified origi...
static bool hasLegendNodeUserLabel(QgsLayerTreeLayer *nodeLayer, int originalIndex)
static bool legendNodeColumnBreak(QgsLayerTreeLayer *nodeLayer, int originalIndex)
Returns whether a forced column break should occur before the node.
static bool hasLegendNodeOrder(QgsLayerTreeLayer *nodeLayer)
static void setLegendNodeUserLabel(QgsLayerTreeLayer *nodeLayer, int originalIndex, const QString &newLabel)
static void setLegendNodeSymbolSize(QgsLayerTreeLayer *nodeLayer, int originalIndex, QSizeF size)
Sets the legend symbol size for the legend node belonging to nodeLayer at the specified originalIndex...
static QgsColorRampLegendNodeSettings * legendNodeColorRampSettings(QgsLayerTreeLayer *nodeLayer, int originalIndex)
Returns the custom legend color ramp settings for the legend node belonging to nodeLayer at the speci...
static void setLegendNodeColumnBreak(QgsLayerTreeLayer *nodeLayer, int originalIndex, bool columnBreakBeforeNode)
Sets whether a forced column break should occur before the node.
static void setLegendNodePatchShape(QgsLayerTreeLayer *nodeLayer, int originalIndex, const QgsLegendPatchShape &shape)
Sets the legend patch shape for the legend node belonging to nodeLayer at the specified originalIndex...
static QgsSymbol * legendNodeCustomSymbol(QgsLayerTreeLayer *nodeLayer, int originalIndex)
Returns the custom legend symbol for the legend node belonging to nodeLayer at the specified original...
static QList< int > legendNodeOrder(QgsLayerTreeLayer *nodeLayer)
static void applyLayerNodeProperties(QgsLayerTreeLayer *nodeLayer, QList< QgsLayerTreeModelLegendNode * > &nodes)
update according to layer node's custom properties (order of items, user labels for items)
static QgsLegendPatchShape legendNodePatchShape(QgsLayerTreeLayer *nodeLayer, int originalIndex)
Returns the legend patch shape for the legend node belonging to nodeLayer at the specified originalIn...
The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Reads configuration from a DOM element previously written by writeXml()
static QgsMapLayerLegend * defaultMeshLegend(QgsMeshLayer *ml)
Create new legend implementation for mesh layer.
virtual QList< QgsLayerTreeModelLegendNode * > createLayerTreeModelLegendNodes(QgsLayerTreeLayer *nodeLayer)=0
Returns list of legend nodes to be used for a particular layer tree layer node.
static QgsMapLayerLegend * defaultPointCloudLegend(QgsPointCloudLayer *layer)
Create new legend implementation for a point cloud layer.
QgsMapLayerLegend(QObject *parent=nullptr)
Constructor for QgsMapLayerLegend.
virtual QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Writes configuration to a DOM element, to be used later with readXml()
static QgsMapLayerLegend * defaultRasterLegend(QgsRasterLayer *rl)
Create new legend implementation for raster layer.
static QgsMapLayerLegend * defaultVectorLegend(QgsVectorLayer *vl)
Create new legend implementation for vector layer.
void itemsChanged()
Emitted when existing items/nodes got invalid and should be replaced by new ones.
QgsMapLayerLegend * legend() const
Can be nullptr.
void rendererChanged()
Signal emitted when renderer is changed.
void nameChanged()
Emitted when the name has been changed.
Base class for providing data for QgsMeshLayer.
virtual QgsMeshDatasetGroupMetadata datasetGroupMetadata(int groupIndex) const =0
Returns dataset group metadata.
Represents a mesh layer supporting display of data on structured or unstructured meshes.
QgsMeshRendererSettings rendererSettings() const
Returns renderer settings.
QgsMeshDataProvider * dataProvider() override
Returns the layer's data provider, it may be nullptr.
Represents a mesh renderer settings for scalar datasets.
QgsColorRampShader colorRampShader() const
Returns color ramp shader function.
Represents all mesh renderer settings.
QgsMeshRendererScalarSettings scalarSettings(int groupIndex) const
Returns renderer settings.
int activeVectorDatasetGroup() const
Returns the active vector dataset group.
int activeScalarDatasetGroup() const
Returns the active scalar dataset group.
Contains settings for how a map layer will be labeled.
Represents a map layer supporting display of point clouds.
QgsPointCloudRenderer * renderer()
Returns the 2D renderer for the point cloud.
Abstract base class for 2d point cloud renderers.
virtual QList< QgsLayerTreeModelLegendNode * > createLegendNodes(QgsLayerTreeLayer *nodeLayer)
Creates a set of legend nodes representing the renderer.
static QgsProject * instance()
Returns the QgsProject singleton instance.
virtual bool supportsLegendGraphic() const
Returns whether the provider supplies a legend graphic.
Represents a raster layer.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
QgsRasterRenderer * renderer() const
Returns the raster's renderer.
virtual QList< QgsLayerTreeModelLegendNode * > createLegendNodes(QgsLayerTreeLayer *nodeLayer)
Creates a set of legend nodes representing the renderer.
double maximumValue() const
Returns the minimum value for the raster shader.
double minimumValue() const
Returns the maximum value for the raster shader.
Implementation of legend node interface for displaying raster legend entries.
The class is used as a container of context for various read/write operations on other objects.
void setPathResolver(const QgsPathResolver &resolver)
Sets up path resolver for conversion between relative and absolute paths.
A child rule for QgsRuleBasedLabeling.
const QgsRuleBasedLabeling::Rule * findRuleByKey(const QString &key) const
Try to find a rule given its unique key.
QString description() const
A human readable description for this rule.
Rule based labeling for a vector layer.
QgsRuleBasedLabeling::Rule * rootRule()
Implementation of legend node interface for displaying arbitrary label with icon.
static QString encodeSize(QSizeF size)
Encodes a QSizeF to a string.
static QgsSymbol * loadSymbol(const QDomElement &element, const QgsReadWriteContext &context)
Attempts to load a symbol from a DOM element.
static QDomElement saveSymbol(const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
static QSizeF decodeSize(const QString &string)
Decodes a QSizeF from a string.
Implementation of legend node interface for displaying preview of vector symbols and their labels and...
Abstract base class for all rendered symbols.
Container for all settings relating to text rendering.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Write settings into a DOM element.
Produces legend node for a labeling text symbol.
Represents a vector layer which manages a vector based data sets.
bool labelsEnabled() const
Returns whether the layer contains labels which are enabled and should be drawn.
QgsVectorLayerFeatureCounter * countSymbolFeatures(bool storeSymbolFids=false)
Count features for symbols.
bool diagramsEnabled() const
Returns whether the layer contains diagrams which are enabled and should be drawn.
const QgsAbstractVectorLayerLabeling * labeling() const
Access to const labeling configuration.
const QgsDiagramRenderer * diagramRenderer() const
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
Implementation of legend node interface for displaying WMS legend entries.
QgsLayerTreeModelLegendNode * legendNode(const QString &rule, QgsLayerTreeModel &model)
QList< QPair< QString, QColor > > QgsLegendColorList