QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Types | Public Member Functions | List of all members
QgsLabelingEngineSettings Class Reference

Stores global configuration for labeling engine. More...

#include <qgslabelingenginesettings.h>

Public Types

enum  Search {
  Chain , Popmusic_Tabu , Popmusic_Chain , Popmusic_Tabu_Chain ,
  Falp
}
 Search methods in the PAL library to remove colliding labels (methods have different processing speed and number of labels placed) More...
 

Public Member Functions

 QgsLabelingEngineSettings ()
 
void clear ()
 Returns the configuration to the defaults. More...
 
Qgis::TextRenderFormat defaultTextRenderFormat () const
 Returns the default text rendering format for the labels. More...
 
Qgis::LabelingFlags flags () const
 Gets flags of the labeling engine. More...
 
double maximumLineCandidatesPerCm () const
 Returns the maximum number of line label candidate positions per centimeter. More...
 
double maximumPolygonCandidatesPerCmSquared () const
 Returns the maximum number of polygon label candidate positions per centimeter squared. More...
 
Q_DECL_DEPRECATED void numCandidatePositions (int &candPoint, int &candLine, int &candPolygon) const
 Gets number of candidate positions that will be generated for each label feature. More...
 
Qgis::LabelPlacementEngineVersion placementVersion () const
 Returns the placement engine version, which dictates how the label placement problem is solved. More...
 
void readSettingsFromProject (QgsProject *project)
 Read configuration of the labeling engine from a project. More...
 
Q_DECL_DEPRECATED Search searchMethod () const
 Which search method to use for removal collisions between labels. More...
 
void setDefaultTextRenderFormat (Qgis::TextRenderFormat format)
 Sets the default text rendering format for the labels. More...
 
void setFlag (Qgis::LabelingFlag f, bool enabled=true)
 Sets whether a particual flag is enabled. More...
 
void setFlags (Qgis::LabelingFlags flags)
 Sets flags of the labeling engine. More...
 
void setMaximumLineCandidatesPerCm (double candidates)
 Sets the maximum number of line label candidates per centimeter. More...
 
void setMaximumPolygonCandidatesPerCmSquared (double candidates)
 Sets the maximum number of polygon label candidates per centimeter squared. More...
 
Q_DECL_DEPRECATED void setNumCandidatePositions (int candPoint, int candLine, int candPolygon)
 Sets the number of candidate positions that will be generated for each label feature. More...
 
void setPlacementVersion (Qgis::LabelPlacementEngineVersion version)
 Sets the placement engine version, which dictates how the label placement problem is solved. More...
 
Q_DECL_DEPRECATED void setSearchMethod (Search s)
 Used to set which search method to use for removal collisions between labels. More...
 
void setUnplacedLabelColor (const QColor &color)
 Sets the color to use when rendering unplaced labels. More...
 
bool testFlag (Qgis::LabelingFlag f) const
 Test whether a particular flag is enabled. More...
 
QColor unplacedLabelColor () const
 Returns the color to use when rendering unplaced labels. More...
 
void writeSettingsToProject (QgsProject *project)
 Write configuration of the labeling engine to a project. More...
 

Detailed Description

Stores global configuration for labeling engine.

Since
QGIS 3.0

Definition at line 30 of file qgslabelingenginesettings.h.

Member Enumeration Documentation

◆ Search

Search methods in the PAL library to remove colliding labels (methods have different processing speed and number of labels placed)

Enumerator
Chain 
Popmusic_Tabu 
Popmusic_Chain 
Popmusic_Tabu_Chain 
Falp 

Definition at line 40 of file qgslabelingenginesettings.h.

Constructor & Destructor Documentation

◆ QgsLabelingEngineSettings()

QgsLabelingEngineSettings::QgsLabelingEngineSettings ( )

Definition at line 21 of file qgslabelingenginesettings.cpp.

Member Function Documentation

◆ clear()

void QgsLabelingEngineSettings::clear ( )

Returns the configuration to the defaults.

Definition at line 25 of file qgslabelingenginesettings.cpp.

◆ defaultTextRenderFormat()

Qgis::TextRenderFormat QgsLabelingEngineSettings::defaultTextRenderFormat ( ) const
inline

Returns the default text rendering format for the labels.

See also
setDefaultTextRenderFormat()
Since
QGIS 3.4.3

Definition at line 144 of file qgslabelingenginesettings.h.

◆ flags()

Qgis::LabelingFlags QgsLabelingEngineSettings::flags ( ) const
inline

Gets flags of the labeling engine.

Definition at line 57 of file qgslabelingenginesettings.h.

◆ maximumLineCandidatesPerCm()

double QgsLabelingEngineSettings::maximumLineCandidatesPerCm ( ) const
inline

Returns the maximum number of line label candidate positions per centimeter.

See also
setMaximumLineCandidatesPerCm()
Since
QGIS 3.12

Definition at line 69 of file qgslabelingenginesettings.h.

◆ maximumPolygonCandidatesPerCmSquared()

double QgsLabelingEngineSettings::maximumPolygonCandidatesPerCmSquared ( ) const
inline

Returns the maximum number of polygon label candidate positions per centimeter squared.

See also
setMaximumPolygonCandidatesPerCmSquared()
Since
QGIS 3.12

Definition at line 85 of file qgslabelingenginesettings.h.

◆ numCandidatePositions()

Q_DECL_DEPRECATED void QgsLabelingEngineSettings::numCandidatePositions ( int &  candPoint,
int &  candLine,
int &  candPolygon 
) const
inline

Gets number of candidate positions that will be generated for each label feature.

Deprecated:
since QGIS 3.12 use maximumPolygonCandidatesPerCmSquared() and maximumLineCandidatesPerCm() instead.

Definition at line 99 of file qgslabelingenginesettings.h.

◆ placementVersion()

Qgis::LabelPlacementEngineVersion QgsLabelingEngineSettings::placementVersion ( ) const

Returns the placement engine version, which dictates how the label placement problem is solved.

See also
setPlacementVersion()
Since
QGIS 3.10.2

Definition at line 89 of file qgslabelingenginesettings.cpp.

◆ readSettingsFromProject()

void QgsLabelingEngineSettings::readSettingsFromProject ( QgsProject project)

Read configuration of the labeling engine from a project.

Definition at line 30 of file qgslabelingenginesettings.cpp.

◆ searchMethod()

Q_DECL_DEPRECATED Search QgsLabelingEngineSettings::searchMethod ( ) const
inline

Which search method to use for removal collisions between labels.

Deprecated:
since QGIS 3.10 - Chain is always used.

Definition at line 127 of file qgslabelingenginesettings.h.

◆ setDefaultTextRenderFormat()

void QgsLabelingEngineSettings::setDefaultTextRenderFormat ( Qgis::TextRenderFormat  format)
inline

Sets the default text rendering format for the labels.

See also
defaultTextRenderFormat()
Since
QGIS 3.4.3

Definition at line 155 of file qgslabelingenginesettings.h.

◆ setFlag()

void QgsLabelingEngineSettings::setFlag ( Qgis::LabelingFlag  f,
bool  enabled = true 
)
inline

Sets whether a particual flag is enabled.

Definition at line 61 of file qgslabelingenginesettings.h.

◆ setFlags()

void QgsLabelingEngineSettings::setFlags ( Qgis::LabelingFlags  flags)
inline

Sets flags of the labeling engine.

Definition at line 55 of file qgslabelingenginesettings.h.

◆ setMaximumLineCandidatesPerCm()

void QgsLabelingEngineSettings::setMaximumLineCandidatesPerCm ( double  candidates)
inline

Sets the maximum number of line label candidates per centimeter.

See also
maximumLineCandidatesPerCm()
Since
QGIS 3.12

Definition at line 77 of file qgslabelingenginesettings.h.

◆ setMaximumPolygonCandidatesPerCmSquared()

void QgsLabelingEngineSettings::setMaximumPolygonCandidatesPerCmSquared ( double  candidates)
inline

Sets the maximum number of polygon label candidates per centimeter squared.

See also
maximumPolygonCandidatesPerCmSquared()
Since
QGIS 3.12

Definition at line 93 of file qgslabelingenginesettings.h.

◆ setNumCandidatePositions()

Q_DECL_DEPRECATED void QgsLabelingEngineSettings::setNumCandidatePositions ( int  candPoint,
int  candLine,
int  candPolygon 
)
inline

Sets the number of candidate positions that will be generated for each label feature.

Deprecated:
since QGIS 3.12 use setMaximumPolygonCandidatesPerCmSquared() and setMaximumLineCandidatesPerCm() instead.

Definition at line 110 of file qgslabelingenginesettings.h.

◆ setPlacementVersion()

void QgsLabelingEngineSettings::setPlacementVersion ( Qgis::LabelPlacementEngineVersion  version)

Sets the placement engine version, which dictates how the label placement problem is solved.

See also
placementVersion()
Since
QGIS 3.10.2

Definition at line 94 of file qgslabelingenginesettings.cpp.

◆ setSearchMethod()

Q_DECL_DEPRECATED void QgsLabelingEngineSettings::setSearchMethod ( Search  s)
inline

Used to set which search method to use for removal collisions between labels.

Deprecated:
since QGIS 3.10 - Chain is always used.

Definition at line 121 of file qgslabelingenginesettings.h.

◆ setUnplacedLabelColor()

void QgsLabelingEngineSettings::setUnplacedLabelColor ( const QColor &  color)

Sets the color to use when rendering unplaced labels.

See also
unplacedLabelColor()
Since
QGIS 3.10

Definition at line 84 of file qgslabelingenginesettings.cpp.

◆ testFlag()

bool QgsLabelingEngineSettings::testFlag ( Qgis::LabelingFlag  f) const
inline

Test whether a particular flag is enabled.

Definition at line 59 of file qgslabelingenginesettings.h.

◆ unplacedLabelColor()

QColor QgsLabelingEngineSettings::unplacedLabelColor ( ) const

Returns the color to use when rendering unplaced labels.

See also
setUnplacedLabelColor()
Since
QGIS 3.10

Definition at line 79 of file qgslabelingenginesettings.cpp.

◆ writeSettingsToProject()

void QgsLabelingEngineSettings::writeSettingsToProject ( QgsProject project)

Write configuration of the labeling engine to a project.

Definition at line 59 of file qgslabelingenginesettings.cpp.


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