Subgroup: Scale
Class: QgsScaleBarRenderer¶
-
class
qgis.core.
QgsScaleBarRenderer
¶ Bases:
sip.wrapper
Constructor for QgsScaleBarRenderer.
QgsScaleBarRenderer(QgsScaleBarRenderer)
Abstract base class for scale bar renderers.
Scalebar renderer subclasses implement custom drawing logic, with the possibility to implement custom labeling.
New in version 3.0: Methods
calculateBoxSize
Calculates the required box size (in millimeters) for a scalebar using the specified settings
andscaleContext
.draw
Draws the scalebar using the specified settings
andscaleContext
to a destination rendercontext
.drawDefaultLabels
Draws default scalebar labels using the specified settings
andscaleContext
to a destination rendercontext
.firstLabelString
Returns the text used for the first label in the scalebar. firstLabelXOffset
Returns the x-offset (in millimeters) used for the first label in the scalebar. name
Returns the unique name for this style. segmentPositions
Returns a list of positions for each segment within the scalebar. segmentWidths
Returns a list of widths of each segment of the scalebar. Signals
Attributes
-
class
ScaleBarContext
¶ Bases:
sip.wrapper
QgsScaleBarRenderer.ScaleBarContext(QgsScaleBarRenderer.ScaleBarContext)
-
scale
¶
-
segmentWidth
¶
-
size
¶
-
-
calculateBoxSize
(self, settings: QgsScaleBarSettings, scaleContext: QgsScaleBarRenderer.ScaleBarContext) → QSizeF¶ Calculates the required box size (in millimeters) for a scalebar using the specified
settings
andscaleContext
.
-
draw
(self, context: QgsRenderContext, settings: QgsScaleBarSettings, scaleContext: QgsScaleBarRenderer.ScaleBarContext)¶ Draws the scalebar using the specified
settings
andscaleContext
to a destination rendercontext
.
-
drawDefaultLabels
(self, context: QgsRenderContext, settings: QgsScaleBarSettings, scaleContext: QgsScaleBarRenderer.ScaleBarContext)¶ Draws default scalebar labels using the specified
settings
andscaleContext
to a destination rendercontext
.
-
firstLabelString
(self, settings: QgsScaleBarSettings) → str¶ Returns the text used for the first label in the scalebar.
-
firstLabelXOffset
(self, settings: QgsScaleBarSettings) → float¶ Returns the x-offset (in millimeters) used for the first label in the scalebar.
Deprecated since version Use: the version with QgsRenderContext instead.
firstLabelXOffset(self, settings: QgsScaleBarSettings, context: QgsRenderContext) -> float Returns the x-offset (in render context painter units) used for the first label in the scalebar.
New in version 3.2.
-
name
(self) → str¶ Returns the unique name for this style.
-
segmentPositions
(self, scaleContext: QgsScaleBarRenderer.ScaleBarContext, settings: QgsScaleBarSettings) → List[float]¶ Returns a list of positions for each segment within the scalebar.
-
segmentWidths
(self, scaleContext: QgsScaleBarRenderer.ScaleBarContext, settings: QgsScaleBarSettings) → List[float]¶ Returns a list of widths of each segment of the scalebar.
-
class