Class: QgsNumericScaleBarRenderer¶
-
class
qgis.core.
QgsNumericScaleBarRenderer
¶ Bases:
QgsScaleBarRenderer
Constructor for QgsNumericScaleBarRenderer.
QgsNumericScaleBarRenderer(
QgsNumericScaleBarRenderer
)A scale bar style that draws text in the form of ‘1:XXXXX’.
Methods
- param settings
- param context
Draws default scalebar labels using the specified
settings
andscaleContext
to a destination rendercontext
.Returns the text used for the first label in the scalebar.
Returns the x-offset (in millimeters) used for the first label in the scalebar.
- rtype
str
Returns a list of positions for each segment within the scalebar.
Returns a list of widths of each segment of the scalebar.
-
calculateBoxSize
(self, settings: QgsScaleBarSettings, scaleContext: QgsScaleBarRenderer.ScaleBarContext) → QSizeF¶ - Parameters
settings (QgsScaleBarSettings) –
scaleContext (QgsScaleBarRenderer.ScaleBarContext) –
- Return type
QSizeF
-
draw
(self, context: QgsRenderContext, settings: QgsScaleBarSettings, scaleContext: QgsScaleBarRenderer.ScaleBarContext)¶ - Parameters
context (QgsRenderContext) –
settings (QgsScaleBarSettings) –
scaleContext (QgsScaleBarRenderer.ScaleBarContext) –
-
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
, scaleContext: QgsScaleBarRenderer.ScaleBarContext) -> 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¶ - Return type
str
-
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.