QGIS API Documentation
3.2.0-Bonn (bc43194)
|
Stores global configuration for labeling engine. More...
#include <qgslabelingenginesettings.h>
Public Types | |
enum | Flag { UseAllLabels = 1 << 1, UsePartialCandidates = 1 << 2, RenderOutlineLabels = 1 << 3, DrawLabelRectOnly = 1 << 4, DrawCandidates = 1 << 5 } |
Various flags that affect drawing and placement of labels. More... | |
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... | |
Flags | flags () const |
Gets flags of the labeling engine. More... | |
void | numCandidatePositions (int &candPoint, int &candLine, int &candPolygon) const |
Gets number of candidate positions that will be generated for each label feature (default to 8) More... | |
void | readSettingsFromProject (QgsProject *project) |
Read configuration of the labeling engine from a project. More... | |
Search | searchMethod () const |
Which search method to use for removal collisions between labels. More... | |
void | setFlag (Flag f, bool enabled=true) |
Sets whether a particual flag is enabled. More... | |
void | setFlags (Flags flags) |
Sets flags of the labeling engine. More... | |
void | setNumCandidatePositions (int candPoint, int candLine, int candPolygon) |
Sets number of candidate positions that will be generated for each label feature. More... | |
void | setSearchMethod (Search s) |
Sets which search method to use for removal collisions between labels. More... | |
bool | testFlag (Flag f) const |
Test whether a particular flag is enabled. More... | |
void | writeSettingsToProject (QgsProject *project) |
Write configuration of the labeling engine to a project. More... | |
Stores global configuration for labeling engine.
Definition at line 29 of file qgslabelingenginesettings.h.
Various flags that affect drawing and placement of labels.
Definition at line 33 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 47 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 26 of file qgslabelingenginesettings.cpp.
|
inline |
Gets flags of the labeling engine.
Definition at line 64 of file qgslabelingenginesettings.h.
|
inline |
Gets number of candidate positions that will be generated for each label feature (default to 8)
Definition at line 71 of file qgslabelingenginesettings.h.
void QgsLabelingEngineSettings::readSettingsFromProject | ( | QgsProject * | project | ) |
Read configuration of the labeling engine from a project.
Definition at line 31 of file qgslabelingenginesettings.cpp.
|
inline |
Which search method to use for removal collisions between labels.
Definition at line 78 of file qgslabelingenginesettings.h.
|
inline |
Sets whether a particual flag is enabled.
Definition at line 68 of file qgslabelingenginesettings.h.
|
inline |
Sets flags of the labeling engine.
Definition at line 62 of file qgslabelingenginesettings.h.
|
inline |
Sets number of candidate positions that will be generated for each label feature.
Definition at line 73 of file qgslabelingenginesettings.h.
|
inline |
Sets which search method to use for removal collisions between labels.
Definition at line 76 of file qgslabelingenginesettings.h.
|
inline |
Test whether a particular flag is enabled.
Definition at line 66 of file qgslabelingenginesettings.h.
void QgsLabelingEngineSettings::writeSettingsToProject | ( | QgsProject * | project | ) |
Write configuration of the labeling engine to a project.
Definition at line 47 of file qgslabelingenginesettings.cpp.