30 const QString
type = element.attribute( QStringLiteral(
"type" ) );
31 if (
type == QLatin1String(
"rule-based" ) )
35 else if (
type == QLatin1String(
"simple" ) )
49 toSld( parent, context );
54 context.
pushError( QObject::tr(
"%1 labeling cannot be exported to SLD" ).arg(
type() ) );
102 return QStringLiteral(
"simple" );
112 QDomElement elem = doc.createElement( QStringLiteral(
"labeling" ) );
113 elem.setAttribute( QStringLiteral(
"type" ), QStringLiteral(
"simple" ) );
114 elem.appendChild( mSettings->writeXml( doc, context ) );
120 Q_UNUSED( providerId )
129 if ( !visitor->
visit( &entity ) )
137 return mSettings->containsAdvancedEffects();
146 || mSettings->format().hasNonDefaultCompositionMode();
151 const QDomElement settingsElem = element.firstChildElement( QStringLiteral(
"settings" ) );
152 if ( !settingsElem.isNull() )
164 double quadOffsetX = 0.5, quadOffsetY = 0.5;
167 switch ( quadrantPosition )
205 return QPointF( quadOffsetX, quadOffsetY );
211void appendSimpleFunction( QDomDocument &doc, QDomElement &parent,
const QString &name,
const QString &attribute )
213 QDomElement function = doc.createElement( QStringLiteral(
"ogc:Function" ) );
214 function.setAttribute( QStringLiteral(
"name" ), name );
215 parent.appendChild( function );
216 QDomElement
property = doc.createElement( QStringLiteral(
"ogc:PropertyName" ) );
217 property.appendChild( doc.createTextNode( attribute ) );
218 function.appendChild( property );
211void appendSimpleFunction( QDomDocument &doc, QDomElement &parent,
const QString &name,
const QString &attribute ) {
…}
223 std::unique_ptr<QgsMarkerSymbolLayer> layer;
224 switch ( settings.
type() )
252 switch ( settings.
type() )
270 layer.reset( marker );
273 layer->setEnabled(
true );
275 const QSizeF size = settings.
size();
276 layer->setSize( std::max( 1., std::max( size.width(), size.height() ) ) );
277 layer->setSizeUnit( settings.
sizeUnit() );
283 const int alpha = std::round( settings.
opacity() * 255 );
284 fillColor.setAlpha( alpha );
285 strokeColor.setAlpha( alpha );
287 layer->setFillColor( fillColor );
288 layer->setStrokeColor( strokeColor );
292 layer->setAngle( settings.
rotation() );
295 layer->setOffset( settings.
offset() );
296 layer->setOffsetUnit( settings.
offsetUnit() );
310 QDomDocument doc = parent.ownerDocument();
313 QDomElement textSymbolizerElement = doc.createElement( QStringLiteral(
"se:TextSymbolizer" ) );
314 parent.appendChild( textSymbolizerElement );
318 const QFont font = format.
font();
319 QDomElement labelElement = doc.createElement( QStringLiteral(
"se:Label" ) );
320 textSymbolizerElement.appendChild( labelElement );
324 labelElement.appendChild( doc.createTextNode(
"Placeholder" ) );
345 QDomElement propertyNameElement = doc.createElement( QStringLiteral(
"ogc:PropertyName" ) );
347 labelElement.appendChild( propertyNameElement );
352 QDomElement fontElement = doc.createElement( QStringLiteral(
"se:Font" ) );
353 textSymbolizerElement.appendChild( fontElement );
358 if ( format.
font().italic() )
362 if ( format.
font().bold() )
368 QDomElement labelPlacement = doc.createElement( QStringLiteral(
"se:LabelPlacement" ) );
369 textSymbolizerElement.appendChild( labelPlacement );
370 double maxDisplacement = 0;
371 double repeatDistance = 0;
376 QDomElement pointPlacement = doc.createElement(
"se:PointPlacement" );
377 labelPlacement.appendChild( pointPlacement );
392 QDomElement rotation = doc.createElement(
"se:Rotation" );
393 pointPlacement.appendChild( rotation );
401 QDomElement pointPlacement = doc.createElement(
"se:PointPlacement" );
402 labelPlacement.appendChild( pointPlacement );
409 const double offset = std::sqrt( radius * radius / 2 );
410 maxDisplacement = radius + 1;
419 QDomElement pointPlacement = doc.createElement(
"se:PointPlacement" );
420 labelPlacement.appendChild( pointPlacement );
431 QDomElement linePlacement = doc.createElement(
"se:LinePlacement" );
432 labelPlacement.appendChild( linePlacement );
439 QDomElement perpendicular = doc.createElement(
"se:PerpendicularOffset" );
440 linePlacement.appendChild( perpendicular );
447 QDomElement repeat = doc.createElement(
"se:Repeat" );
448 linePlacement.appendChild( repeat );
449 repeat.appendChild( doc.createTextNode( QStringLiteral(
"true" ) ) );
450 QDomElement gap = doc.createElement(
"se:Gap" );
451 linePlacement.appendChild( gap );
457 QDomElement generalize = doc.createElement(
"se:GeneralizeLine" );
458 linePlacement.appendChild( generalize );
459 generalize.appendChild( doc.createTextNode( QStringLiteral(
"true" ) ) );
468 QDomElement haloElement = doc.createElement( QStringLiteral(
"se:Halo" ) );
469 textSymbolizerElement.appendChild( haloElement );
471 QDomElement radiusElement = doc.createElement( QStringLiteral(
"se:Radius" ) );
472 haloElement.appendChild( radiusElement );
477 QDomElement fillElement = doc.createElement( QStringLiteral(
"se:Fill" ) );
478 haloElement.appendChild( fillElement );
487 QDomElement fillElement = doc.createElement( QStringLiteral(
"se:Fill" ) );
488 textSymbolizerElement.appendChild( fillElement );
500 layer->writeSldMarker( doc, textSymbolizerElement, context );
507 QDomElement priorityElement = doc.createElement( QStringLiteral(
"se:Priority" ) );
508 textSymbolizerElement.appendChild( priorityElement );
515 priorityElement.appendChild( doc.createTextNode( QString::number( priority ) ) );
519 if ( font.underline() )
522 textSymbolizerElement.appendChild( vo );
524 if ( font.strikeOut() )
527 textSymbolizerElement.appendChild( vo );
530 if ( maxDisplacement > 0 )
533 textSymbolizerElement.appendChild( vo );
542 textSymbolizerElement.appendChild( vo );
548 textSymbolizerElement.appendChild( vo );
563 if ( repeatDistance > 0 )
566 textSymbolizerElement.appendChild( vo );
576 textSymbolizerElement.appendChild( vo );
582 textSymbolizerElement.appendChild( vo );
587 textSymbolizerElement.appendChild( vo );
591 textSymbolizerElement.appendChild( vo );
605 resizeType = QStringLiteral(
"stretch" );
609 resizeType = QStringLiteral(
"proportional" );
612 textSymbolizerElement.appendChild( voResize );
615 const QSizeF size = background.
size();
616 if ( size.width() > 0 || size.height() > 0 )
629 textSymbolizerElement.appendChild( voMargin );
646 toSld( parent, context );
651 if ( mSettings->drawLabels )
653 QDomDocument doc = parent.ownerDocument();
655 QDomElement ruleElement = doc.createElement( QStringLiteral(
"se:Rule" ) );
656 parent.appendChild( ruleElement );
659 if ( mSettings->scaleVisibility )
661 QVariantMap scaleProps = QVariantMap();
664 scaleProps.insert(
"scaleMinDenom",
qgsDoubleToString( mSettings->maximumScale ) );
665 scaleProps.insert(
"scaleMaxDenom",
qgsDoubleToString( mSettings->minimumScale ) );
677 format.multiplyOpacity( opacityFactor );
678 mSettings->setFormat( format );
683 Q_UNUSED( providerId )
@ FromSymbolBounds
Offset distance applies from rendered symbol bounds.
@ OverPoint
Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point....
@ Curved
Arranges candidates following the curvature of a line feature. Applies to line layers only.
@ 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'...
@ Free
Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the pol...
@ OrderedPositionsAroundPoint
Candidates are placed in predefined positions around a point. Preference is given to positions with g...
@ Horizontal
Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only...
@ PerimeterCurved
Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
@ OutsidePolygons
Candidates are placed outside of polygon boundaries. Applies to polygon layers only.
MarkerShape
Marker shapes.
Capitalization
String capitalization options.
@ MixedCase
Mixed case, ie no change.
@ AllLowercase
Convert all characters to lowercase.
@ ForceFirstLetterToCapital
Convert just the first letter of each word to uppercase, leave the rest untouched.
@ AllUppercase
Convert all characters to uppercase.
LabelQuadrantPosition
Label quadrant positions.
RenderUnit
Rendering size units.
@ AllowOverlapAtNoCost
Labels may freely overlap other labels, at no cost.
@ AllowOverlapIfRequired
Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise ...
@ PreventOverlap
Do not allow labels to overlap other labels.
@ AlwaysAllowUpsideDown
Show upside down for all labels, including dynamic ones.
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the labeling...
virtual Q_DECL_DEPRECATED void toSld(QDomNode &parent, const QVariantMap &props) const
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings.
virtual Q_DECL_DEPRECATED void writeTextSymbolizer(QDomNode &parent, QgsPalLayerSettings &settings, const QVariantMap &props) const
Writes a TextSymbolizer element contents based on the provided labeling settings.
static QgsAbstractVectorLayerLabeling * create(const QDomElement &element, const QgsReadWriteContext &context)
Try to create instance of an implementation based on the XML data.
virtual QgsPalLayerSettings settings(const QString &providerId=QString()) const =0
Gets associated label settings.
static QgsPalLayerSettings defaultSettingsForLayer(const QgsVectorLayer *layer)
Returns the default layer settings to use for the specified vector layer.
virtual QString type() const =0
Unique type string of the labeling configuration implementation.
QString dump() const
Returns an expression string, constructed from the internal abstract syntax tree.
bool mergeLines() const
Returns true if connected line features with identical label text should be merged prior to generatin...
Qgis::LabelOverlapHandling overlapHandling() const
Returns the technique used to handle overlapping labels.
Qgis::LabelQuadrantPosition quadrant() const
Returns the quadrant in which to offset labels from the point.
QgsProject * project() const
Returns the parent project if this map layer is added to a project.
Abstract base class for marker symbol layers.
Contains settings for how a map layer will be labeled.
double yOffset
Vertical offset of label.
const QgsLabelPlacementSettings & placementSettings() const
Returns the label placement settings.
double maxCurvedCharAngleIn
Maximum angle between inside curved label characters (valid range 20.0 to 60.0).
void setFormat(const QgsTextFormat &format)
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
double zIndex
Z-Index of label, where labels with a higher z-index are rendered on top of labels with a lower z-ind...
Qgis::LabelOffsetType offsetType
Offset type for layer (only applies in certain placement modes)
double xOffset
Horizontal offset of label.
Qgis::LabelPlacement placement
Label placement mode.
QgsExpression * getLabelExpression()
Returns the QgsExpression for this label settings.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
double repeatDistance
Distance for repeating labels for a single feature.
int priority
Label priority.
bool labelPerPart
true if every part of a multi-part feature should be labeled.
double angleOffset
Label rotation, in degrees clockwise.
double maxCurvedCharAngleOut
Maximum angle between outside curved label characters (valid range -20.0 to -95.0)
Qgis::RenderUnit offsetUnits
Units for offsets of label.
bool isExpression
true if this label is made from a expression string, e.g., FieldName || 'mm'
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.
Qgis::RenderUnit distUnits
Units the distance from feature to the label.
@ FontBlendMode
Text blend mode.
Qgis::RenderUnit repeatDistanceUnit
Units for repeating labels for a single feature.
Qgis::UpsideDownLabelHandling upsidedownLabels
Controls whether upside down labels are displayed and how they are handled.
QString fieldName
Name of field (or an expression) to use for label text.
const QgsTextFormat & format() const
Returns the label text formatting settings, e.g., font settings, buffer settings, etc.
const QgsLabelPointSettings & pointSettings() const
Returns the label point settings, which contain settings related to how the label engine places and f...
A container for the context for various read/write operations on objects.
static QgsRuleBasedLabeling * create(const QDomElement &element, const QgsReadWriteContext &context)
Create the instance from a DOM element with saved configuration.
void setShape(Qgis::MarkerShape shape)
Sets the rendered marker shape.
Simple marker symbol layer, consisting of a rendered shape with solid fill color and a stroke.
void setStrokeWidthUnit(Qgis::RenderUnit u)
Sets the unit for the width of the marker's stroke.
void setStrokeWidth(double w)
Sets the width of the marker's stroke.
Holds SLD export options and other information related to SLD export of a QGIS layer style.
void setExtraProperties(const QVariantMap &properties)
Sets the open ended set of properties that can drive/inform the SLD encoding.
QVariantMap extraProperties() const
Returns the open ended set of properties that can drive/inform the SLD encoding.
void pushError(const QString &error)
Pushes a error message generated during the conversion.
An interface for classes which can visit style entity (e.g.
virtual bool visit(const QgsStyleEntityVisitorInterface::StyleLeaf &entity)
Called when the visitor will visit a style entity.
A label settings entity for QgsStyle databases.
static QgsTextFormat defaultTextFormatForProject(QgsProject *project, QgsStyle::TextFormatContext context=QgsStyle::TextFormatContext::Labeling)
Returns the default text format to use for new text based objects for the specified project,...
A marker symbol layer which renders an SVG graphic.
void setStrokeWidth(double w)
void setStrokeWidthUnit(Qgis::RenderUnit unit)
Sets the units for the stroke width.
static void createAnchorPointElement(QDomDocument &doc, QDomElement &element, QPointF anchor)
Creates a SE 1.1 anchor point element as a child of the specified element.
static void applyScaleDependency(QDomDocument &doc, QDomElement &ruleElem, QVariantMap &props)
Checks if the properties contain scaleMinDenom and scaleMaxDenom, if available, they are added into t...
static double rescaleUom(double size, Qgis::RenderUnit unit, const QVariantMap &props)
Rescales the given size based on the uomScale found in the props, if any is found,...
static QDomElement createVendorOptionElement(QDomDocument &doc, const QString &name, const QString &value)
static void createDisplacementElement(QDomDocument &doc, QDomElement &element, QPointF offset)
static QDomElement createSvgParameterElement(QDomDocument &doc, const QString &name, const QString &value)
virtual QgsSymbolLayer * clone() const =0
Shall be reimplemented by subclasses to create a deep copy of the instance.
QgsSymbolLayer * symbolLayer(int layer)
Returns the symbol layer at the specified index.
int symbolLayerCount() const
Returns the total number of symbol layers contained in the symbol.
Container for settings relating to a text background object.
RotationType rotationType() const
Returns the method used for rotating the background shape.
QString svgFile() const
Returns the absolute path to the background SVG file, if set.
QSizeF size() const
Returns the size of the background shape.
@ SizePercent
Shape size is determined by percent of text size.
@ SizeBuffer
Shape size is determined by adding a buffer margin around text.
bool enabled() const
Returns whether the background is enabled.
double opacity() const
Returns the background shape's opacity.
double rotation() const
Returns the rotation for the background shape, in degrees clockwise.
QColor fillColor() const
Returns the color used for filing the background shape.
SizeType sizeType() const
Returns the method used to determine the size of the background shape (e.g., fixed size or buffer aro...
Qgis::RenderUnit strokeWidthUnit() const
Returns the units used for the shape's stroke width.
ShapeType type() const
Returns the type of background shape (e.g., square, ellipse, SVG).
double strokeWidth() const
Returns the width of the shape's stroke (stroke).
@ ShapeMarkerSymbol
Marker symbol.
@ ShapeSquare
Square - buffered sizes only.
@ ShapeRectangle
Rectangle.
Qgis::RenderUnit offsetUnit() const
Returns the units used for the shape's offset.
QColor strokeColor() const
Returns the color used for outlining the background shape.
Qgis::RenderUnit sizeUnit() const
Returns the units used for the shape's size.
@ RotationFixed
Shape rotation is a fixed angle.
QgsMarkerSymbol * markerSymbol() const
Returns the marker symbol to be rendered in the background.
QPointF offset() const
Returns the offset used for drawing the background shape.
Container for settings relating to a text buffer.
Qgis::RenderUnit sizeUnit() const
Returns the units for the buffer size.
double size() const
Returns the size of the buffer.
bool enabled() const
Returns whether the buffer is enabled.
double opacity() const
Returns the buffer opacity.
QColor color() const
Returns the color of the buffer.
Container for all settings relating to text rendering.
Qgis::Capitalization capitalization() const
Returns the text capitalization style.
QgsTextBackgroundSettings & background()
Returns a reference to the text background settings.
Qgis::RenderUnit sizeUnit() const
Returns the units for the size of rendered text.
double opacity() const
Returns the text's opacity.
double size() const
Returns the size for rendered text.
QColor color() const
Returns the color that text will be rendered in.
QFont font() const
Returns the font used for rendering text.
QgsTextBufferSettings & buffer()
Returns a reference to the text buffer settings.
Implements a label provider for vector layers.
Basic implementation of the labeling interface.
QString type() const override
Unique type string of the labeling configuration implementation.
void multiplyOpacity(double opacityFactor) override
Multiply opacity by opacityFactor.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified symbology visitor, causing it to visit all symbols associated with the labeling...
QgsPalLayerSettings settings(const QString &providerId=QString()) const override
Gets associated label settings.
QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) const override
Returns labeling configuration as XML element.
bool requiresAdvancedEffects() const override
Returns true if drawing labels requires advanced effects like composition modes, which could prevent ...
QgsVectorLayerSimpleLabeling(const QgsPalLayerSettings &settings)
Constructs simple labeling configuration with given initial settings.
void setSettings(QgsPalLayerSettings *settings, const QString &providerId=QString()) override
Set pal settings (takes ownership).
QgsVectorLayerLabelProvider * provider(QgsVectorLayer *layer) const override
static QgsVectorLayerSimpleLabeling * create(const QDomElement &element, const QgsReadWriteContext &context)
Create the instance from a DOM element with saved configuration.
QgsAbstractVectorLayerLabeling * clone() const override
Returns a new copy of the object.
Q_DECL_DEPRECATED void toSld(QDomNode &parent, const QVariantMap &props) const override
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings.
bool hasNonDefaultCompositionMode() const override
Returns true the labeling requires a non-default composition mode.
Represents a vector layer which manages a vector based dataset.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
QString displayField() const
This is a shorthand for accessing the displayExpression if it is a simple field.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
std::unique_ptr< QgsMarkerSymbolLayer > backgroundToMarkerLayer(const QgsTextBackgroundSettings &settings)
void appendSimpleFunction(QDomDocument &doc, QDomElement &parent, const QString &name, const QString &attribute)
QPointF quadOffsetToSldAnchor(Qgis::LabelQuadrantPosition quadrantPosition)