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.
Methods
Calculates the required box size (in millimeters) for a scalebar using the specified
settings
andscaleContext
.Draws the scalebar using the specified
settings
andscaleContext
to a destination rendercontext
.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.
Returns the unique name for this style.
Returns a list of positions for each segment within the scalebar.
Returns a list of widths of each segment of the scalebar.
-
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
.- Parameters
settings (QgsScaleBarSettings) –
scaleContext (QgsScaleBarRenderer.ScaleBarContext) –
- Return type
QSizeF
-
draw
(self, context: QgsRenderContext, settings: QgsScaleBarSettings, scaleContext: QgsScaleBarRenderer.ScaleBarContext)¶ Draws the scalebar using the specified
settings
andscaleContext
to a destination rendercontext
.- 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
.- Parameters
context (QgsRenderContext) –
settings (QgsScaleBarSettings) –
scaleContext (QgsScaleBarRenderer.ScaleBarContext) –
-
firstLabelString
(self, settings: QgsScaleBarSettings) → str¶ Returns the text used for the first label in the scalebar.
- Parameters
settings (QgsScaleBarSettings) –
- Return type
str
-
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.
- Parameters
settings (QgsScaleBarSettings) –
- Return type
float
-
name
(self) → str¶ Returns the unique name for this style.
- Return type
str
-
segmentPositions
(self, scaleContext: QgsScaleBarRenderer.ScaleBarContext, settings: QgsScaleBarSettings) → List[float]¶ Returns a list of positions for each segment within the scalebar.
- Parameters
scaleContext (QgsScaleBarRenderer.ScaleBarContext) –
settings (QgsScaleBarSettings) –
- Return type
List[float]
-
segmentWidths
(self, scaleContext: QgsScaleBarRenderer.ScaleBarContext, settings: QgsScaleBarSettings) → List[float]¶ Returns a list of widths of each segment of the scalebar.
- Parameters
scaleContext (QgsScaleBarRenderer.ScaleBarContext) –
settings (QgsScaleBarSettings) –
- Return type
List[float]
-
class