A class to query the labeling structure at a given point (small wrapper around pal RTree class) More...

#include <qgslabelsearchtree.h>

Public Member Functions
	QgsLabelSearchTree ()
	Constructor for QgsLabelSearchTree. More...

	QgsLabelSearchTree (const QgsLabelSearchTree &rh)=delete
	QgsLabelSearchTree cannot be copied. More...

	~QgsLabelSearchTree ()

QList< QgsLabelPosition >	allLabels () const
	Returns a list of all labels generated by the labeling run. More...

QList< const QgsCalloutPosition * >	calloutsInRectangle (const QgsRectangle &rectangle) const
	Returns the list of callouts with origins or destinations inside the given rectangle. More...

Q_DECL_DEPRECATED void	clear ()
	Removes and deletes all the entries. More...

bool	insertCallout (const QgsCalloutPosition &position)
	Inserts a rendered callout position. More...

bool	insertLabel (pal::LabelPosition *labelPos, QgsFeatureId featureId, const QString &layerName, const QString &labeltext, const QFont &labelfont, bool diagram=false, bool pinned=false, const QString &providerId=QString(), bool isUnplaced=false)
	Inserts label position. More...

void	label (const QgsPointXY &p, QList< QgsLabelPosition * > &posList) const
	Returns label position(s) at a given point. More...

void	labelsInRect (const QgsRectangle &r, QList< QgsLabelPosition * > &posList) const
	Returns label position(s) in given rectangle. More...

QgsLabelSearchTree &	operator= (const QgsLabelSearchTree &rh)=delete
	QgsLabelSearchTree cannot be copied. More...

void	setMapSettings (const QgsMapSettings &settings)
	Sets the map settings associated with the labeling run. More...

Detailed Description

A class to query the labeling structure at a given point (small wrapper around pal RTree class)

Definition at line 46 of file qgslabelsearchtree.h.

Constructor & Destructor Documentation

◆ QgsLabelSearchTree() [1/2]

QgsLabelSearchTree::QgsLabelSearchTree ( )

default

Constructor for QgsLabelSearchTree.

◆ ~QgsLabelSearchTree()

QgsLabelSearchTree::~QgsLabelSearchTree ( )

default

◆ QgsLabelSearchTree() [2/2]

QgsLabelSearchTree::QgsLabelSearchTree ( const QgsLabelSearchTree & rh )

delete

QgsLabelSearchTree cannot be copied.

Member Function Documentation

◆ allLabels()

QList< QgsLabelPosition > QgsLabelSearchTree::allLabels ( ) const

Returns a list of all labels generated by the labeling run.

Since: QGIS 3.20

Definition at line 45 of file qgslabelsearchtree.cpp.

◆ calloutsInRectangle()

QList< const QgsCalloutPosition * > QgsLabelSearchTree::calloutsInRectangle ( const QgsRectangle & rectangle ) const

Returns the list of callouts with origins or destinations inside the given rectangle.

The rectangle is specified in map coordinates.

QgsLabelSearchTree keeps ownership, don't delete the returned objects.

Since: QGIS 3.20

Definition at line 129 of file qgslabelsearchtree.cpp.

◆ clear()

void QgsLabelSearchTree::clear ( )

Removes and deletes all the entries.

Deprecated:: has no effect since QGIS 3.12

Definition at line 163 of file qgslabelsearchtree.cpp.

◆ insertCallout()

bool QgsLabelSearchTree::insertCallout ( const QgsCalloutPosition & position )

Inserts a rendered callout position.

Returns: true in case of success

Note: not available in Python bindings

Since: QGIS 3.20

Definition at line 114 of file qgslabelsearchtree.cpp.

◆ insertLabel()

bool QgsLabelSearchTree::insertLabel	(	pal::LabelPosition *	labelPos,
		QgsFeatureId	featureId,
		const QString &	layerName,
		const QString &	labeltext,
		const QFont &	labelfont,
		bool	diagram = `false`,
		bool	pinned = `false`,
		const QString &	providerId = `QString()`,
		bool	isUnplaced = `false`
	)

Inserts label position.

Does not take ownership of labelPos

Returns: true in case of success

Note: not available in Python bindings

Definition at line 76 of file qgslabelsearchtree.cpp.

◆ label()

void QgsLabelSearchTree::label	(	const QgsPointXY &	p,
		QList< QgsLabelPosition * > &	posList
	)		const

Returns label position(s) at a given point.

QgsLabelSearchTree keeps ownership, don't delete the LabelPositions

Note: not available in Python bindings

Definition at line 22 of file qgslabelsearchtree.cpp.

◆ labelsInRect()

void QgsLabelSearchTree::labelsInRect	(	const QgsRectangle &	r,
		QList< QgsLabelPosition * > &	posList
	)		const

Returns label position(s) in given rectangle.

QgsLabelSearchTree keeps ownership, don't delete the LabelPositions

Note: not available in Python bindings

Definition at line 56 of file qgslabelsearchtree.cpp.

◆ operator=()

QgsLabelSearchTree& QgsLabelSearchTree::operator= ( const QgsLabelSearchTree & rh )