Represents the calculated placement of a map label. More...

#include <qgspallabeling.h>

Public Member Functions
	QgsLabelPosition ()=default
	Constructor for QgsLabelPosition. More...

	QgsLabelPosition (QgsFeatureId id, double r, const QVector< QgsPointXY > &corners, const QgsRectangle &rect, double w, double h, const QString &layer, const QString &labeltext, const QFont &labelfont, bool upside_down, bool diagram=false, bool pinned=false, const QString &providerId=QString(), const QgsGeometry &labelGeometry=QgsGeometry(), bool isUnplaced=false)
	Constructor for QgsLabelPosition. More...

Public Attributes
QVector< QgsPointXY >	cornerPoints

QgsFeatureId	featureId = FID_NULL
	ID of feature associated with this label. More...

double	height = 0
	Heeght of label bounding box, in map units. More...

bool	isDiagram = false
	`true` if label is a diagram. More...

bool	isPinned = false
	`true` if label position has been pinned. More...

bool	isUnplaced = false
	`true` if label position corresponds to an unplaced label. More...

QFont	labelFont
	Font which the label is rendered using. More...

QgsGeometry	labelGeometry
	A polygon geometry representing the label's bounds in map coordinates. More...

QgsRectangle	labelRect

QString	labelText
	String shown in label. More...

QString	layerID
	ID of associated map layer. More...

QString	providerID
	ID of the associated label provider. More...

double	rotation = 0
	Rotation of label, in degrees clockwise. More...

bool	upsideDown = false
	`true` if label is upside down. More...

double	width = 0
	Width of label bounding box, in map units. More...

Detailed Description

Represents the calculated placement of a map label.

Definition at line 87 of file qgspallabeling.h.

Constructor & Destructor Documentation

◆ QgsLabelPosition() [1/2]

QgsLabelPosition::QgsLabelPosition	(	QgsFeatureId	id,
		double	r,
		const QVector< QgsPointXY > &	corners,
		const QgsRectangle &	rect,
		double	w,
		double	h,
		const QString &	layer,
		const QString &	labeltext,
		const QFont &	labelfont,
		bool	upside_down,
		bool	diagram = `false`,
		bool	pinned = `false`,
		const QString &	providerId = `QString()`,
		const QgsGeometry &	labelGeometry = `QgsGeometry()`,
		bool	isUnplaced = `false`
	)

inline

Constructor for QgsLabelPosition.

Parameters

id	associated feature ID
r	label rotation in degrees clockwise
corners	corner points of label bounding box, in map units
rect	label bounding box, in map units
w	width of label, in map units
h	height of label, in map units
layer	ID of associated map layer
labeltext	text rendered for label
labelfont	font used to render label
upside_down	`true` if label is upside down
diagram	`true` if label is a diagram
pinned	`true` if label has pinned placement
providerId	ID of associated label provider
labelGeometry	polygon geometry of label boundary
isUnplaced	set to `true` if label was unplaced (e.g. due to collisions with other labels)

Definition at line 109 of file qgspallabeling.h.

◆ QgsLabelPosition() [2/2]

QgsLabelPosition::QgsLabelPosition ( )

default

Constructor for QgsLabelPosition.

Member Data Documentation

◆ cornerPoints

QVector< QgsPointXY > QgsLabelPosition::cornerPoints

Definition at line 141 of file qgspallabeling.h.

◆ featureId

QgsFeatureId QgsLabelPosition::featureId = FID_NULL

ID of feature associated with this label.

Definition at line 134 of file qgspallabeling.h.

◆ height

double QgsLabelPosition::height = 0

Heeght of label bounding box, in map units.

Definition at line 158 of file qgspallabeling.h.

◆ isDiagram

bool QgsLabelPosition::isDiagram = false

true if label is a diagram.

Definition at line 183 of file qgspallabeling.h.

◆ isPinned

bool QgsLabelPosition::isPinned = false

true if label position has been pinned.

Definition at line 188 of file qgspallabeling.h.

◆ isUnplaced

bool QgsLabelPosition::isUnplaced = false

true if label position corresponds to an unplaced label.

Since: QGIS 3.10

Definition at line 200 of file qgspallabeling.h.

◆ labelFont

QFont QgsLabelPosition::labelFont

Font which the label is rendered using.

Definition at line 173 of file qgspallabeling.h.

◆ labelGeometry

QgsGeometry QgsLabelPosition::labelGeometry

A polygon geometry representing the label's bounds in map coordinates.

Since: QGIS 3.4.9

Definition at line 148 of file qgspallabeling.h.

◆ labelRect

QgsRectangle QgsLabelPosition::labelRect

Definition at line 142 of file qgspallabeling.h.

◆ labelText

QString QgsLabelPosition::labelText

String shown in label.

Definition at line 168 of file qgspallabeling.h.

◆ layerID

QString QgsLabelPosition::layerID

ID of associated map layer.

Definition at line 163 of file qgspallabeling.h.

◆ providerID

QString QgsLabelPosition::providerID

ID of the associated label provider.

Since: QGIS 2.14

Definition at line 194 of file qgspallabeling.h.

◆ rotation

double QgsLabelPosition::rotation = 0

Rotation of label, in degrees clockwise.

Definition at line 139 of file qgspallabeling.h.

◆ upsideDown

bool QgsLabelPosition::upsideDown = false

true if label is upside down.

Definition at line 178 of file qgspallabeling.h.

◆ width

double QgsLabelPosition::width = 0

Width of label bounding box, in map units.

Definition at line 153 of file qgspallabeling.h.

The documentation for this class was generated from the following file:

/build/qgis-3.18.1+99unstable/src/core/labeling/qgspallabeling.h

Public Member Functions

Public Attributes