QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
Class that stores computed placement from labeling engine. More...
#include <qgslabelingresults.h>
Public Member Functions | |
QgsLabelingResults () | |
QgsLabelingResults (const QgsLabelingResults &)=delete | |
QgsLabelingResults cannot be copied. More... | |
~QgsLabelingResults () | |
QList< QgsLabelPosition > | allLabels () const |
Returns a list of all labels generated by the labeling run. More... | |
QList< QgsCalloutPosition > | calloutsWithinRectangle (const QgsRectangle &rectangle) const |
Returns a list of callouts with origins or destinations inside the given rectangle. More... | |
QList< QgsLabelPosition > | groupedLabelPositions (long long groupId) const |
Returns a list of all label positions sharing the same group ID (i.e. More... | |
QList< QgsLabelPosition > | labelsAtPosition (const QgsPointXY &p) const |
Returns the details of any labels placed at the specified point (in map coordinates). More... | |
QList< QgsLabelPosition > | labelsWithinRect (const QgsRectangle &r) const |
Returns the details of any labels placed within the specified rectangle (in map coordinates). More... | |
QgsLabelingResults & | operator= (const QgsLabelingResults &rh)=delete |
QgsLabelingResults cannot be copied. More... | |
void | setMapSettings (const QgsMapSettings &settings) |
Sets the map settings associated with the labeling run. More... | |
Friends | |
class | QgsPalLabeling |
class | QgsVectorLayerDiagramProvider |
class | QgsVectorLayerLabelProvider |
Class that stores computed placement from labeling engine.
Definition at line 34 of file qgslabelingresults.h.
QgsLabelingResults::QgsLabelingResults | ( | ) |
Definition at line 21 of file qgslabelingresults.cpp.
|
default |
|
delete |
QgsLabelingResults cannot be copied.
QList< QgsLabelPosition > QgsLabelingResults::allLabels | ( | ) | const |
Returns a list of all labels generated by the labeling run.
Definition at line 29 of file qgslabelingresults.cpp.
QList< QgsCalloutPosition > QgsLabelingResults::calloutsWithinRectangle | ( | const QgsRectangle & | rectangle | ) | const |
Returns a list of callouts with origins or destinations inside the given rectangle.
The rectangle is specified in map coordinates.
Definition at line 83 of file qgslabelingresults.cpp.
QList< QgsLabelPosition > QgsLabelingResults::groupedLabelPositions | ( | long long | groupId | ) | const |
Returns a list of all label positions sharing the same group ID (i.e.
positions for individual characters in a curved label).
Definition at line 70 of file qgslabelingresults.cpp.
QList< QgsLabelPosition > QgsLabelingResults::labelsAtPosition | ( | const QgsPointXY & | p | ) | const |
Returns the details of any labels placed at the specified point (in map coordinates).
Definition at line 34 of file qgslabelingresults.cpp.
QList< QgsLabelPosition > QgsLabelingResults::labelsWithinRect | ( | const QgsRectangle & | r | ) | const |
Returns the details of any labels placed within the specified rectangle (in map coordinates).
Definition at line 52 of file qgslabelingresults.cpp.
|
delete |
QgsLabelingResults cannot be copied.
void QgsLabelingResults::setMapSettings | ( | const QgsMapSettings & | settings | ) |
Sets the map settings associated with the labeling run.
Definition at line 99 of file qgslabelingresults.cpp.
|
friend |
Definition at line 91 of file qgslabelingresults.h.
|
friend |
Definition at line 93 of file qgslabelingresults.h.
|
friend |
Definition at line 92 of file qgslabelingresults.h.