QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
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. | |
Qgis::TextRenderFormat | defaultTextRenderFormat () const |
Returns the default text rendering format for the labels. | |
Qgis::LabelingFlags | flags () const |
Gets flags of the labeling engine. | |
double | maximumLineCandidatesPerCm () const |
Returns the maximum number of line label candidate positions per centimeter. | |
double | maximumPolygonCandidatesPerCmSquared () const |
Returns the maximum number of polygon label candidate positions per centimeter squared. | |
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. | |
Qgis::LabelPlacementEngineVersion | placementVersion () const |
Returns the placement engine version, which dictates how the label placement problem is solved. | |
void | readSettingsFromProject (QgsProject *project) |
Read configuration of the labeling engine from a project. | |
Q_DECL_DEPRECATED Search | searchMethod () const |
Which search method to use for removal collisions between labels. | |
void | setDefaultTextRenderFormat (Qgis::TextRenderFormat format) |
Sets the default text rendering format for the labels. | |
void | setFlag (Qgis::LabelingFlag f, bool enabled=true) |
Sets whether a particual flag is enabled. | |
void | setFlags (Qgis::LabelingFlags flags) |
Sets flags of the labeling engine. | |
void | setMaximumLineCandidatesPerCm (double candidates) |
Sets the maximum number of line label candidates per centimeter. | |
void | setMaximumPolygonCandidatesPerCmSquared (double candidates) |
Sets the maximum number of polygon label candidates per centimeter squared. | |
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. | |
void | setPlacementVersion (Qgis::LabelPlacementEngineVersion version) |
Sets the placement engine version, which dictates how the label placement problem is solved. | |
Q_DECL_DEPRECATED void | setSearchMethod (Search s) |
Used to set which search method to use for removal collisions between labels. | |
void | setUnplacedLabelColor (const QColor &color) |
Sets the color to use when rendering unplaced labels. | |
bool | testFlag (Qgis::LabelingFlag f) const |
Test whether a particular flag is enabled. | |
QColor | unplacedLabelColor () const |
Returns the color to use when rendering unplaced labels. | |
void | writeSettingsToProject (QgsProject *project) |
Write configuration of the labeling engine to a project. | |
Stores global configuration for labeling engine.
Definition at line 29 of file qgslabelingenginesettings.h.
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 39 of file qgslabelingenginesettings.h.
QgsLabelingEngineSettings::QgsLabelingEngineSettings | ( | ) |
Definition at line 21 of file qgslabelingenginesettings.cpp.
void QgsLabelingEngineSettings::clear | ( | ) |
Returns the configuration to the defaults.
Definition at line 25 of file qgslabelingenginesettings.cpp.
|
inline |
Returns the default text rendering format for the labels.
Definition at line 143 of file qgslabelingenginesettings.h.
|
inline |
Gets flags of the labeling engine.
Definition at line 56 of file qgslabelingenginesettings.h.
|
inline |
Returns the maximum number of line label candidate positions per centimeter.
Definition at line 68 of file qgslabelingenginesettings.h.
|
inline |
Returns the maximum number of polygon label candidate positions per centimeter squared.
Definition at line 84 of file qgslabelingenginesettings.h.
|
inline |
Gets number of candidate positions that will be generated for each label feature.
Definition at line 98 of file qgslabelingenginesettings.h.
Qgis::LabelPlacementEngineVersion QgsLabelingEngineSettings::placementVersion | ( | ) | const |
Returns the placement engine version, which dictates how the label placement problem is solved.
Definition at line 89 of file qgslabelingenginesettings.cpp.
void QgsLabelingEngineSettings::readSettingsFromProject | ( | QgsProject * | project | ) |
Read configuration of the labeling engine from a project.
Definition at line 30 of file qgslabelingenginesettings.cpp.
|
inline |
Which search method to use for removal collisions between labels.
Definition at line 126 of file qgslabelingenginesettings.h.
|
inline |
Sets the default text rendering format for the labels.
Definition at line 154 of file qgslabelingenginesettings.h.
|
inline |
Sets whether a particual flag is enabled.
Definition at line 60 of file qgslabelingenginesettings.h.
|
inline |
Sets flags of the labeling engine.
Definition at line 54 of file qgslabelingenginesettings.h.
|
inline |
Sets the maximum number of line label candidates per centimeter.
Definition at line 76 of file qgslabelingenginesettings.h.
|
inline |
Sets the maximum number of polygon label candidates per centimeter squared.
Definition at line 92 of file qgslabelingenginesettings.h.
|
inline |
Sets the number of candidate positions that will be generated for each label feature.
Definition at line 109 of file qgslabelingenginesettings.h.
void QgsLabelingEngineSettings::setPlacementVersion | ( | Qgis::LabelPlacementEngineVersion | version | ) |
Sets the placement engine version, which dictates how the label placement problem is solved.
Definition at line 94 of file qgslabelingenginesettings.cpp.
|
inline |
Used to set which search method to use for removal collisions between labels.
Definition at line 120 of file qgslabelingenginesettings.h.
void QgsLabelingEngineSettings::setUnplacedLabelColor | ( | const QColor & | color | ) |
Sets the color to use when rendering unplaced labels.
Definition at line 84 of file qgslabelingenginesettings.cpp.
|
inline |
Test whether a particular flag is enabled.
Definition at line 58 of file qgslabelingenginesettings.h.
QColor QgsLabelingEngineSettings::unplacedLabelColor | ( | ) | const |
Returns the color to use when rendering unplaced labels.
Definition at line 79 of file qgslabelingenginesettings.cpp.
void QgsLabelingEngineSettings::writeSettingsToProject | ( | QgsProject * | project | ) |
Write configuration of the labeling engine to a project.
Definition at line 59 of file qgslabelingenginesettings.cpp.