QGIS API Documentation 3.43.0-Master (2366440f66a)
qgsvectorlayerlabeling.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectorlayerlabeling.cpp
3 ---------------------
4 begin : September 2015
5 copyright : (C) 2015 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
16
17#include "qgspallabeling.h"
19#include "qgsvectorlayer.h"
20#include "qgssymbollayerutils.h"
21#include "qgssymbollayer.h"
23#include "qgis.h"
25#include "qgsmarkersymbol.h"
26#include "qgssldexportcontext.h"
27
29{
30 const QString type = element.attribute( QStringLiteral( "type" ) );
31 if ( type == QLatin1String( "rule-based" ) )
32 {
33 return QgsRuleBasedLabeling::create( element, context );
34 }
35 else if ( type == QLatin1String( "simple" ) )
36 {
37 return QgsVectorLayerSimpleLabeling::create( element, context );
38 }
39 else
40 {
41 return nullptr;
42 }
43}
44
45void QgsAbstractVectorLayerLabeling::toSld( QDomNode &parent, const QVariantMap &props ) const
46{
47 QgsSldExportContext context;
48 context.setExtraProperties( props );
49 toSld( parent, context );
50}
51
53{
54 context.pushError( QObject::tr( "%1 labeling cannot be exported to SLD" ).arg( type() ) );
55 return false;
56}
57
62
88
90{
91 return new QgsVectorLayerLabelProvider( layer, QString(), false, mSettings.get() );
92}
93
95 : mSettings( new QgsPalLayerSettings( settings ) )
96{
97
98}
99
101{
102 return QStringLiteral( "simple" );
103}
104
109
110QDomElement QgsVectorLayerSimpleLabeling::save( QDomDocument &doc, const QgsReadWriteContext &context ) const
111{
112 QDomElement elem = doc.createElement( QStringLiteral( "labeling" ) );
113 elem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "simple" ) );
114 elem.appendChild( mSettings->writeXml( doc, context ) );
115 return elem;
116}
117
119{
120 Q_UNUSED( providerId )
121 return *mSettings;
122}
123
125{
126 if ( mSettings )
127 {
128 QgsStyleLabelSettingsEntity entity( *mSettings );
129 if ( !visitor->visit( &entity ) )
130 return false;
131 }
132 return true;
133}
134
136{
137 return mSettings->containsAdvancedEffects();
138}
139
140QgsVectorLayerSimpleLabeling *QgsVectorLayerSimpleLabeling::create( const QDomElement &element, const QgsReadWriteContext &context ) // cppcheck-suppress duplInheritedMember
141{
142 const QDomElement settingsElem = element.firstChildElement( QStringLiteral( "settings" ) );
143 if ( !settingsElem.isNull() )
144 {
146 settings.readXml( settingsElem, context );
148 }
149
151}
152
154{
155 double quadOffsetX = 0.5, quadOffsetY = 0.5;
156
157 // adjust quadrant offset of labels
158 switch ( quadrantPosition )
159 {
161 quadOffsetX = 1;
162 quadOffsetY = 0;
163 break;
165 quadOffsetX = 0.5;
166 quadOffsetY = 0;
167 break;
169 quadOffsetX = 0;
170 quadOffsetY = 0;
171 break;
173 quadOffsetX = 1;
174 quadOffsetY = 0.5;
175 break;
177 quadOffsetX = 0;
178 quadOffsetY = 0.5;
179 break;
181 quadOffsetX = 1;
182 quadOffsetY = 1;
183 break;
185 quadOffsetX = 0.5;
186 quadOffsetY = 1;
187 break;
189 quadOffsetX = 0;
190 quadOffsetY = 1.0;
191 break;
193 break;
194 }
195
196 return QPointF( quadOffsetX, quadOffsetY );
197}
198
199/*
200 * This is not a generic function encoder, just enough to encode the label case control functions
201 */
202void appendSimpleFunction( QDomDocument &doc, QDomElement &parent, const QString &name, const QString &attribute )
203{
204 QDomElement function = doc.createElement( QStringLiteral( "ogc:Function" ) );
205 function.setAttribute( QStringLiteral( "name" ), name );
206 parent.appendChild( function );
207 QDomElement property = doc.createElement( QStringLiteral( "ogc:PropertyName" ) );
208 property.appendChild( doc.createTextNode( attribute ) );
209 function.appendChild( property );
210}
211
212std::unique_ptr<QgsMarkerSymbolLayer> backgroundToMarkerLayer( const QgsTextBackgroundSettings &settings )
213{
214 std::unique_ptr<QgsMarkerSymbolLayer> layer;
215 switch ( settings.type() )
216 {
218 {
220 svg->setStrokeWidth( settings.strokeWidth() );
221 svg->setStrokeWidthUnit( settings.strokeWidthUnit() );
222 layer.reset( svg );
223 break;
224 }
226 {
227 // just grab the first layer and hope for the best
228 if ( settings.markerSymbol() && settings.markerSymbol()->symbolLayerCount() > 0 )
229 {
230 layer.reset( static_cast< QgsMarkerSymbolLayer * >( settings.markerSymbol()->symbolLayer( 0 )->clone() ) );
231 break;
232 }
233 [[fallthrough]]; // not set, just go with the default
234 }
239 {
241 // default value
243 switch ( settings.type() )
244 {
248 break;
252 break;
255 break;
256 }
257
258 marker->setShape( shape );
259 marker->setStrokeWidth( settings.strokeWidth() );
260 marker->setStrokeWidthUnit( settings.strokeWidthUnit() );
261 layer.reset( marker );
262 }
263 }
264 layer->setEnabled( true );
265 // a marker does not have a size x and y, just a size (and it should be at least one)
266 const QSizeF size = settings.size();
267 layer->setSize( std::max( 1., std::max( size.width(), size.height() ) ) );
268 layer->setSizeUnit( settings.sizeUnit() );
269 // fill and stroke
270 QColor fillColor = settings.fillColor();
271 QColor strokeColor = settings.strokeColor();
272 if ( settings.opacity() < 1 )
273 {
274 const int alpha = std::round( settings.opacity() * 255 );
275 fillColor.setAlpha( alpha );
276 strokeColor.setAlpha( alpha );
277 }
278 layer->setFillColor( fillColor );
279 layer->setStrokeColor( strokeColor );
280 // rotation
282 {
283 layer->setAngle( settings.rotation() );
284 }
285 // offset
286 layer->setOffset( settings.offset() );
287 layer->setOffsetUnit( settings.offsetUnit() );
288
289 return layer;
290}
291
292void QgsAbstractVectorLayerLabeling::writeTextSymbolizer( QDomNode &parent, QgsPalLayerSettings &settings, const QVariantMap &props ) const
293{
294 QgsSldExportContext context;
295 context.setExtraProperties( props );
296 writeTextSymbolizer( parent, settings, context );
297}
298
300{
301 QDomDocument doc = parent.ownerDocument();
302
303 // text symbolizer
304 QDomElement textSymbolizerElement = doc.createElement( QStringLiteral( "se:TextSymbolizer" ) );
305 parent.appendChild( textSymbolizerElement );
306
307 // label
308 QgsTextFormat format = settings.format();
309 const QFont font = format.font();
310 QDomElement labelElement = doc.createElement( QStringLiteral( "se:Label" ) );
311 textSymbolizerElement.appendChild( labelElement );
313 {
314 context.pushError( QObject::tr( "Cannot export label expression %1 to SLD" ).arg( settings.getLabelExpression()->dump() ) );
315 labelElement.appendChild( doc.createTextNode( "Placeholder" ) );
316 }
317 else
318 {
319 Qgis::Capitalization capitalization = format.capitalization();
320 if ( capitalization == Qgis::Capitalization::MixedCase && font.capitalization() != QFont::MixedCase )
321 capitalization = static_cast< Qgis::Capitalization >( font.capitalization() );
322 if ( capitalization == Qgis::Capitalization::AllUppercase )
323 {
324 appendSimpleFunction( doc, labelElement, QStringLiteral( "strToUpperCase" ), settings.fieldName );
325 }
326 else if ( capitalization == Qgis::Capitalization::AllLowercase )
327 {
328 appendSimpleFunction( doc, labelElement, QStringLiteral( "strToLowerCase" ), settings.fieldName );
329 }
330 else if ( capitalization == Qgis::Capitalization::ForceFirstLetterToCapital )
331 {
332 appendSimpleFunction( doc, labelElement, QStringLiteral( "strCapitalize" ), settings.fieldName );
333 }
334 else
335 {
336 QDomElement propertyNameElement = doc.createElement( QStringLiteral( "ogc:PropertyName" ) );
337 propertyNameElement.appendChild( doc.createTextNode( settings.fieldName ) );
338 labelElement.appendChild( propertyNameElement );
339 }
340 }
341
342 // font
343 QDomElement fontElement = doc.createElement( QStringLiteral( "se:Font" ) );
344 textSymbolizerElement.appendChild( fontElement );
345 fontElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "font-family" ), font.family() ) );
346 const QVariantMap props = context.extraProperties();
347 const double fontSize = QgsSymbolLayerUtils::rescaleUom( format.size(), format.sizeUnit(), props );
348 fontElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "font-size" ), QString::number( fontSize ) ) );
349 if ( format.font().italic() )
350 {
351 fontElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "font-style" ), QStringLiteral( "italic" ) ) );
352 }
353 if ( format.font().bold() )
354 {
355 fontElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "font-weight" ), QStringLiteral( "bold" ) ) );
356 }
357
358 // label placement
359 QDomElement labelPlacement = doc.createElement( QStringLiteral( "se:LabelPlacement" ) );
360 textSymbolizerElement.appendChild( labelPlacement );
361 double maxDisplacement = 0;
362 double repeatDistance = 0;
363 switch ( settings.placement )
364 {
366 {
367 QDomElement pointPlacement = doc.createElement( "se:PointPlacement" );
368 labelPlacement.appendChild( pointPlacement );
369 // anchor point
370 const QPointF anchor = quadOffsetToSldAnchor( settings.pointSettings().quadrant() );
371 QgsSymbolLayerUtils::createAnchorPointElement( doc, pointPlacement, anchor );
372 // displacement
373 if ( settings.xOffset != 0 || settings.yOffset != 0 )
374 {
375 const Qgis::RenderUnit offsetUnit = settings.offsetUnits;
376 const double dx = QgsSymbolLayerUtils::rescaleUom( settings.xOffset, offsetUnit, props );
377 const double dy = QgsSymbolLayerUtils::rescaleUom( settings.yOffset, offsetUnit, props );
378 QgsSymbolLayerUtils::createDisplacementElement( doc, pointPlacement, QPointF( dx, dy ) );
379 }
380 // rotation
381 if ( settings.angleOffset != 0 )
382 {
383 QDomElement rotation = doc.createElement( "se:Rotation" );
384 pointPlacement.appendChild( rotation );
385 rotation.appendChild( doc.createTextNode( QString::number( settings.angleOffset ) ) );
386 }
387 }
388 break;
391 {
392 QDomElement pointPlacement = doc.createElement( "se:PointPlacement" );
393 labelPlacement.appendChild( pointPlacement );
394
395 // SLD cannot do either, but let's do a best effort setting the distance using
396 // anchor point and displacement
397 QgsSymbolLayerUtils::createAnchorPointElement( doc, pointPlacement, QPointF( 0, 0.5 ) );
398 const Qgis::RenderUnit distUnit = settings.distUnits;
399 const double radius = QgsSymbolLayerUtils::rescaleUom( settings.dist, distUnit, props );
400 const double offset = std::sqrt( radius * radius / 2 ); // make it start top/right
401 maxDisplacement = radius + 1; // lock the distance
402 QgsSymbolLayerUtils::createDisplacementElement( doc, pointPlacement, QPointF( offset, offset ) );
403 }
404 break;
408 {
409 // still a point placement (for "free" it's a fallback, there is no SLD equivalent)
410 QDomElement pointPlacement = doc.createElement( "se:PointPlacement" );
411 labelPlacement.appendChild( pointPlacement );
412 QgsSymbolLayerUtils::createAnchorPointElement( doc, pointPlacement, QPointF( 0.5, 0.5 ) );
413 const Qgis::RenderUnit distUnit = settings.distUnits;
414 const double dist = QgsSymbolLayerUtils::rescaleUom( settings.dist, distUnit, props );
415 QgsSymbolLayerUtils::createDisplacementElement( doc, pointPlacement, QPointF( 0, dist ) );
416 break;
417 }
421 {
422 QDomElement linePlacement = doc.createElement( "se:LinePlacement" );
423 labelPlacement.appendChild( linePlacement );
424
425 // perpendicular distance if required
426 if ( settings.dist > 0 )
427 {
428 const Qgis::RenderUnit distUnit = settings.distUnits;
429 const double dist = QgsSymbolLayerUtils::rescaleUom( settings.dist, distUnit, props );
430 QDomElement perpendicular = doc.createElement( "se:PerpendicularOffset" );
431 linePlacement.appendChild( perpendicular );
432 perpendicular.appendChild( doc.createTextNode( qgsDoubleToString( dist, 2 ) ) );
433 }
434
435 // repeat distance if required
436 if ( settings.repeatDistance > 0 )
437 {
438 QDomElement repeat = doc.createElement( "se:Repeat" );
439 linePlacement.appendChild( repeat );
440 repeat.appendChild( doc.createTextNode( QStringLiteral( "true" ) ) );
441 QDomElement gap = doc.createElement( "se:Gap" );
442 linePlacement.appendChild( gap );
444 gap.appendChild( doc.createTextNode( qgsDoubleToString( repeatDistance, 2 ) ) );
445 }
446
447 // always generalized
448 QDomElement generalize = doc.createElement( "se:GeneralizeLine" );
449 linePlacement.appendChild( generalize );
450 generalize.appendChild( doc.createTextNode( QStringLiteral( "true" ) ) );
451 }
452 break;
453 }
454
455 // halo
456 const QgsTextBufferSettings buffer = format.buffer();
457 if ( buffer.enabled() )
458 {
459 QDomElement haloElement = doc.createElement( QStringLiteral( "se:Halo" ) );
460 textSymbolizerElement.appendChild( haloElement );
461
462 QDomElement radiusElement = doc.createElement( QStringLiteral( "se:Radius" ) );
463 haloElement.appendChild( radiusElement );
464 // the SLD uses a radius, which is actually half of the link thickness the buffer size specifies
465 const double radius = QgsSymbolLayerUtils::rescaleUom( buffer.size(), buffer.sizeUnit(), props ) / 2;
466 radiusElement.appendChild( doc.createTextNode( qgsDoubleToString( radius ) ) );
467
468 QDomElement fillElement = doc.createElement( QStringLiteral( "se:Fill" ) );
469 haloElement.appendChild( fillElement );
470 fillElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "fill" ), buffer.color().name() ) );
471 if ( buffer.opacity() != 1 )
472 {
473 fillElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "fill-opacity" ), QString::number( buffer.opacity() ) ) );
474 }
475 }
476
477 // fill
478 QDomElement fillElement = doc.createElement( QStringLiteral( "se:Fill" ) );
479 textSymbolizerElement.appendChild( fillElement );
480 fillElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "fill" ), format.color().name() ) );
481 if ( format.opacity() != 1 )
482 {
483 fillElement.appendChild( QgsSymbolLayerUtils::createSvgParameterElement( doc, QStringLiteral( "fill-opacity" ), QString::number( format.opacity() ) ) );
484 }
485
486 // background graphic (not supported by SE 1.1, but supported by the GeoTools ecosystem as an extension)
487 const QgsTextBackgroundSettings background = format.background();
488 if ( background.enabled() )
489 {
490 std::unique_ptr<QgsMarkerSymbolLayer> layer = backgroundToMarkerLayer( background );
491 layer->writeSldMarker( doc, textSymbolizerElement, context );
492 }
493
494 // priority and zIndex, the default values are 0 and 5 in qgis (and between 0 and 10),
495 // in the GeoTools ecosystem there is a single priority value set at 1000 by default
496 if ( settings.priority != 5 || settings.zIndex > 0 )
497 {
498 QDomElement priorityElement = doc.createElement( QStringLiteral( "se:Priority" ) );
499 textSymbolizerElement.appendChild( priorityElement );
500 int priority = 500 + 1000 * settings.zIndex + ( settings.priority - 5 ) * 100;
501 if ( settings.priority == 0 && settings.zIndex > 0 )
502 {
503 // small adjustment to make sure labels in z index n+1 are all above level n despite the priority value
504 priority += 1;
505 }
506 priorityElement.appendChild( doc.createTextNode( QString::number( priority ) ) );
507 }
508
509 // vendor options for text appearance
510 if ( font.underline() )
511 {
512 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "underlineText" ), QStringLiteral( "true" ) );
513 textSymbolizerElement.appendChild( vo );
514 }
515 if ( font.strikeOut() )
516 {
517 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "strikethroughText" ), QStringLiteral( "true" ) );
518 textSymbolizerElement.appendChild( vo );
519 }
520 // vendor options for text positioning
521 if ( maxDisplacement > 0 )
522 {
523 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "maxDisplacement" ), qgsDoubleToString( maxDisplacement, 2 ) );
524 textSymbolizerElement.appendChild( vo );
525 }
526
527 switch ( settings.placement )
528 {
531 {
532 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "followLine" ), QStringLiteral( "true" ) );
533 textSymbolizerElement.appendChild( vo );
535 {
536 // SLD has no notion for this, the GeoTools ecosystem can only do a single angle
537 const double angle = std::min( std::fabs( settings.maxCurvedCharAngleIn ), std::fabs( settings.maxCurvedCharAngleOut ) );
538 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "maxAngleDelta" ), qgsDoubleToString( angle ) );
539 textSymbolizerElement.appendChild( vo );
540 }
541 break;
542 }
543
551 break;
552 }
553
554 if ( repeatDistance > 0 )
555 {
556 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "repeat" ), qgsDoubleToString( repeatDistance, 2 ) );
557 textSymbolizerElement.appendChild( vo );
558 }
559 // miscellaneous options
561 {
563 break;
566 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "conflictResolution" ), QStringLiteral( "false" ) );
567 textSymbolizerElement.appendChild( vo );
568 break;
569 }
571 {
572 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "forceLeftToRight" ), QStringLiteral( "false" ) );
573 textSymbolizerElement.appendChild( vo );
574 }
576 {
577 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "group" ), QStringLiteral( "yes" ) );
578 textSymbolizerElement.appendChild( vo );
580 {
581 const QDomElement vo = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "labelAllGroup" ), QStringLiteral( "true" ) );
582 textSymbolizerElement.appendChild( vo );
583 }
584 }
585 // background symbol resize handling
586 if ( background.enabled() )
587 {
588 // enable resizing if needed
589 switch ( background.sizeType() )
590 {
592 {
593 QString resizeType;
595 {
596 resizeType = QStringLiteral( "stretch" );
597 }
598 else
599 {
600 resizeType = QStringLiteral( "proportional" );
601 }
602 const QDomElement voResize = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "graphic-resize" ), resizeType );
603 textSymbolizerElement.appendChild( voResize );
604
605 // now hadle margin
606 const QSizeF size = background.size();
607 if ( size.width() > 0 || size.height() > 0 )
608 {
609 double x = QgsSymbolLayerUtils::rescaleUom( size.width(), background.sizeUnit(), props );
610 double y = QgsSymbolLayerUtils::rescaleUom( size.height(), background.sizeUnit(), props );
611 // in case of ellipse qgis pads the size generously to make sure the text is inside the ellipse
612 // the following seems to do the trick and keep visual output similar
613 if ( background.type() == QgsTextBackgroundSettings::ShapeEllipse )
614 {
615 x += fontSize / 2;
616 y += fontSize;
617 }
618 const QString resizeSpec = QString( "%1 %2" ).arg( qgsDoubleToString( x, 2 ), qgsDoubleToString( y, 2 ) );
619 const QDomElement voMargin = QgsSymbolLayerUtils::createVendorOptionElement( doc, QStringLiteral( "graphic-margin" ), resizeSpec );
620 textSymbolizerElement.appendChild( voMargin );
621 }
622 break;
623 }
626 // nothing to do here
627 break;
628 }
629 }
630 return true;
631}
632
633void QgsVectorLayerSimpleLabeling::toSld( QDomNode &parent, const QVariantMap &props ) const
634{
635 QgsSldExportContext context;
636 context.setExtraProperties( props );
637 toSld( parent, context );
638}
639
640bool QgsVectorLayerSimpleLabeling::toSld( QDomNode &parent, QgsSldExportContext &context ) const
641{
642 if ( mSettings->drawLabels )
643 {
644 QDomDocument doc = parent.ownerDocument();
645
646 QDomElement ruleElement = doc.createElement( QStringLiteral( "se:Rule" ) );
647 parent.appendChild( ruleElement );
648
649 // scale dependencies
650 if ( mSettings->scaleVisibility )
651 {
652 QVariantMap scaleProps = QVariantMap();
653 // tricky here, the max scale is expressed as its denominator, but it's still the max scale
654 // in other words, the smallest scale denominator....
655 scaleProps.insert( "scaleMinDenom", qgsDoubleToString( mSettings->maximumScale ) );
656 scaleProps.insert( "scaleMaxDenom", qgsDoubleToString( mSettings->minimumScale ) );
657 QgsSymbolLayerUtils::applyScaleDependency( doc, ruleElement, scaleProps );
658 }
659
660 writeTextSymbolizer( ruleElement, *mSettings, context );
661 }
662 return true;
663}
664
666{
667 QgsTextFormat format { mSettings->format() };
668 format.multiplyOpacity( opacityFactor );
669 mSettings->setFormat( format );
670}
671
672void QgsVectorLayerSimpleLabeling::setSettings( QgsPalLayerSettings *settings, const QString &providerId )
673{
674 Q_UNUSED( providerId )
675
676 if ( mSettings.get() == settings )
677 return;
678
679 mSettings.reset( settings );
680}
@ 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.
Definition qgis.h:2974
Capitalization
String capitalization options.
Definition qgis.h:3257
@ 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.
Definition qgis.h:1219
@ Polygon
Polygons.
@ Unknown
Unknown types.
@ Null
No geometry.
RenderUnit
Rendering size units.
Definition qgis.h:5029
@ 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.
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.
Definition qgsstyle.h:1490
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 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.
Definition qgssymbol.h:353
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).
@ ShapeSquare
Square - buffered sizes only.
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.
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.
Definition qgis.h:6219
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)