Class: QgsLabelingEngineSettings¶
-
class
qgis.core.
QgsLabelingEngineSettings
¶ Bases:
sip.wrapper
Stores global configuration for labeling engine
Methods
Returns the configuration to the defaults
Returns the default text rendering format for the labels.
Gets flags of the labeling engine
Gets number of candidate positions that will be generated for each label feature (default to 8)
Read configuration of the labeling engine from a project
Which search method to use for removal collisions between labels
Sets the default text rendering
format
for the labels.Sets whether a particual flag is enabled
Sets flags of the labeling engine
Sets number of candidate positions that will be generated for each label feature
Used to set which search method to use for removal collisions between labels
Sets the
color
to use when rendering unplaced labels.Test whether a particular flag is enabled
Returns the color to use when rendering unplaced labels.
Write configuration of the labeling engine to a project
Attributes
-
Chain
= 0¶
-
DrawCandidates
= 32¶
-
DrawLabelRectOnly
= 16¶
-
DrawUnplacedLabels
= 64¶
-
Falp
= 4¶
-
class
Flag
¶ Bases:
int
-
class
Flags
¶ Bases:
sip.wrapper
QgsLabelingEngineSettings.Flags(Union[QgsLabelingEngineSettings.Flags, QgsLabelingEngineSettings.Flag]) QgsLabelingEngineSettings.Flags(QgsLabelingEngineSettings.Flags)
-
Popmusic_Chain
= 2¶
-
Popmusic_Tabu
= 1¶
-
Popmusic_Tabu_Chain
= 3¶
-
RenderOutlineLabels
= 8¶
-
class
Search
¶ Bases:
int
-
UseAllLabels
= 2¶
-
UsePartialCandidates
= 4¶
-
clear
(self)¶ Returns the configuration to the defaults
-
defaultTextRenderFormat
(self) → QgsRenderContext.TextRenderFormat¶ Returns the default text rendering format for the labels.
See also
New in version 3.4.3.
- Return type
-
flags
(self) → QgsLabelingEngineSettings.Flags¶ Gets flags of the labeling engine
- Return type
-
numCandidatePositions
(self) → Tuple[int, int, int]¶ Gets number of candidate positions that will be generated for each label feature (default to 8)
- Return type
Tuple[int, int, int]
-
readSettingsFromProject
(self, project: QgsProject)¶ Read configuration of the labeling engine from a project
- Parameters
project (QgsProject) –
-
searchMethod
(self) → QgsLabelingEngineSettings.Search¶ Which search method to use for removal collisions between labels
Deprecated since version QGIS: 3.10 - Chain is always used.
- Return type
-
setDefaultTextRenderFormat
(self, format: QgsRenderContext.TextRenderFormat)¶ Sets the default text rendering
format
for the labels.See also
New in version 3.4.3.
- Parameters
format (QgsRenderContext.TextRenderFormat) –
-
setFlag
(self, f: QgsLabelingEngineSettings.Flag, enabled: bool = True)¶ Sets whether a particual flag is enabled
- Parameters
enabled (bool = True) –
-
setFlags
(self, flags: Union[QgsLabelingEngineSettings.Flags, QgsLabelingEngineSettings.Flag])¶ Sets flags of the labeling engine
- Parameters
flags (Union[QgsLabelingEngineSettings.Flags) –
-
setNumCandidatePositions
(self, candPoint: int, candLine: int, candPolygon: int)¶ Sets number of candidate positions that will be generated for each label feature
- Parameters
candPoint (int) –
candLine (int) –
candPolygon (int) –
-
setSearchMethod
(self, s: QgsLabelingEngineSettings.Search)¶ Used to set which search method to use for removal collisions between labels
Deprecated since version QGIS: 3.10 - Chain is always used.
- Parameters
-
setUnplacedLabelColor
(self, color: Union[QColor, Qt.GlobalColor, QGradient])¶ Sets the
color
to use when rendering unplaced labels.See also
New in version 3.10.
- Parameters
color (Union[QColor) –
-
testFlag
(self, f: QgsLabelingEngineSettings.Flag) → bool¶ Test whether a particular flag is enabled
- Parameters
- Return type
bool
-
unplacedLabelColor
(self) → QColor¶ Returns the color to use when rendering unplaced labels.
See also
New in version 3.10.
- Return type
QColor
-
writeSettingsToProject
(self, project: QgsProject)¶ Write configuration of the labeling engine to a project
- Parameters
project (QgsProject) –
-