Class: QgsScaleBarSettings¶

Returns the maximum width (in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.

See also

segmentSizeMode()

See also

setMaximumBarWidth()

See also

minimumBarWidth()

Return type:: float

minimumBarWidth(self) → float[source]¶

Returns the minimum width (in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.

See also

segmentSizeMode()

See also

setMinimumBarWidth()

See also

maximumBarWidth()

Return type:: float

numberOfSegments(self) → int[source]¶

Returns the number of segments included in the scalebar.

See also

setNumberOfSegments()

See also

numberOfSegmentsLeft()

Return type:: int

numberOfSegmentsLeft(self) → int[source]¶

Returns the number of segments included in the left part of the scalebar.

See also

setNumberOfSegmentsLeft()

See also

numberOfSegments()

Return type:: int

numberOfSubdivisions(self) → int[source]¶

Returns the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types).

Note

The number of subdivisions represents the number of subdivision segments, not the number of subdivision lines. E.g. if the number is 1 then NO subdivision lines will be shown.

See also

setNumberOfSubdivisions()

Added in version 3.14.

Return type:: int

numericFormat(self) → QgsNumericFormat | None[source]¶

Returns the numeric format used for numbers in the scalebar.

See also

setNumericFormat()

Added in version 3.12.

Return type:: Optional[QgsNumericFormat]

pen(self) → QPen[source]¶

Returns the pen used for drawing outlines in the scalebar.

See also

setPen()

See also

brush()

Deprecated since version 3.40: Use lineSymbol() instead.

Return type:: QPen

segmentSizeMode(self) → Qgis.ScaleBarSegmentSizeMode[source]¶

Returns the size mode for the scale bar segments.

See also

setSegmentSizeMode()

See also

minimumBarWidth()

See also

maximumBarWidth()

Return type:: Qgis.ScaleBarSegmentSizeMode

setAlignment(self, alignment: Qgis.ScaleBarAlignment)[source]¶

Sets the scalebar alignment.

See also

alignment()

Parameters:: alignment (Qgis.ScaleBarAlignment)

setAlternateFillSymbol(self, symbol: QgsFillSymbol | None)[source]¶

Sets the secondary fill symbol used to render the scalebar (only used for some scalebar types). Ownership of symbol is transferred to the scalebar.

See also

alternateFillSymbol()

See also

setFillSymbol()

Added in version 3.14.

Parameters:: symbol (Optional[QgsFillSymbol])

setBoxContentSpace(self, space: float)[source]¶

Sets the space (margin) between the scalebar box and content in millimeters.

See also

boxContentSpace()

Parameters:: space (float)

setBrush(self, brush: QBrush | QColor | Qt.GlobalColor | QGradient)[source]¶

Sets the primary brush used for filling the scalebar.

See also

brush()

Deprecated since version 3.40: Use setFillSymbol() instead.

Parameters:: brush (Union[QBrush, Union[QColor, Qt.GlobalColor], QGradient])

setBrush2(self, brush: QBrush | QColor | Qt.GlobalColor | QGradient)[source]¶

Sets the secondary brush used for filling the scalebar.

See also

brush()

Deprecated since version 3.40: Use setAlternateFillSymbol() instead.

Parameters:: brush (Union[QBrush, Union[QColor, Qt.GlobalColor], QGradient])

setDivisionLineSymbol(self, symbol: QgsLineSymbol | None)[source]¶

Sets the line symbol used to render the scalebar divisions (only used for some scalebar types). Ownership of symbol is transferred to the scalebar.

See also

divisionLineSymbol()

See also

setLineSymbol()

See also

setSubdivisionLineSymbol()

Added in version 3.14.

Parameters:: symbol (Optional[QgsLineSymbol])

setFillColor(self, color: QColor | Qt.GlobalColor)[source]¶

Sets the color used for fills in the scalebar.

See also

fillColor()

See also

setFillColor2()

Deprecated since version 3.40: Use setFillSymbol() instead.

Parameters:: color (Union[QColor, Qt.GlobalColor])

setFillColor2(self, color: QColor | Qt.GlobalColor)[source]¶

Sets the secondary color used for fills in the scalebar.

See also

fillColor2()

See also

setFillColor2()

Deprecated since version 3.40: Use setAlternateFillSymbol() instead.

Parameters:: color (Union[QColor, Qt.GlobalColor])

setFillSymbol(self, symbol: QgsFillSymbol | None)[source]¶

Sets the primary fill symbol used to render the scalebar (only used for some scalebar types). Ownership of symbol is transferred to the scalebar.

See also

fillSymbol()

See also

setAlternateFillSymbol()

Added in version 3.14.

Parameters:: symbol (Optional[QgsFillSymbol])

setFont(self, font: QFont)[source]¶

Sets the font used for drawing text in the scalebar.

See also

font()

Deprecated since version 3.40: Use setTextFormat() instead.

Parameters:: font (QFont)

setFontColor(self, color: QColor | Qt.GlobalColor)[source]¶

Sets the color used for drawing text in the scalebar.

See also

fontColor()

See also

setFont()

Deprecated since version 3.40: Use textFormat() instead.

Parameters:: color (Union[QColor, Qt.GlobalColor])

setHeight(self, height: float)[source]¶

Sets the scalebar height (in millimeters).

See also

height()

Parameters:: height (float)

setLabelBarSpace(self, space: float)[source]¶

Sets the spacing (in millimeters) between labels and the scalebar.

See also

labelBarSpace()

Parameters:: space (float)

setLabelHorizontalPlacement(self, placement: Qgis.ScaleBarDistanceLabelHorizontalPlacement)[source]¶

Sets the horizontal placement of text labels.

See also

labelHorizontalPlacement()

Added in version 3.10.

Parameters:: placement (Qgis.ScaleBarDistanceLabelHorizontalPlacement)

setLabelVerticalPlacement(self, placement: Qgis.ScaleBarDistanceLabelVerticalPlacement)[source]¶

Sets the vertical placement of text labels.

See also

labelVerticalPlacement()

Added in version 3.10.

Parameters:: placement (Qgis.ScaleBarDistanceLabelVerticalPlacement)

setLineCapStyle(self, style: Qt.PenCapStyle)[source]¶

Sets the cap style used when drawing the lines in the scalebar.

See also

lineCapStyle()

Deprecated since version 3.40: Use setLineSymbol() instead.

Parameters:: style (Qt.PenCapStyle)

setLineColor(self, color: QColor | Qt.GlobalColor)[source]¶

Sets the color used for lines in the scalebar.

See also

lineColor()

Deprecated since version 3.40: Use setLineSymbol() instead.

Parameters:: color (Union[QColor, Qt.GlobalColor])

setLineJoinStyle(self, style: Qt.PenJoinStyle)[source]¶

Sets the join style used when drawing the lines in the scalebar

See also

lineJoinStyle()

Deprecated since version 3.40: Use setLineSymbol() instead.

Parameters:: style (Qt.PenJoinStyle)

setLineSymbol(self, symbol: QgsLineSymbol | None)[source]¶

Sets the line symbol used to render the scalebar (only used for some scalebar types). Ownership of symbol is transferred to the scalebar.

See also

lineSymbol()

See also

setDivisionLineSymbol()

See also

setSubdivisionLineSymbol()

Added in version 3.14.

Parameters:: symbol (Optional[QgsLineSymbol])

setLineWidth(self, width: float)[source]¶

Sets the line width in millimeters for lines in the scalebar.

See also

lineWidth()

Deprecated since version 3.40: Use setLineSymbol() instead.

Parameters:: width (float)

setMapUnitsPerScaleBarUnit(self, units: float)[source]¶

Sets the number of map units per scale bar unit used by the scalebar.

See also

mapUnitsPerScaleBarUnit()

Parameters:: units (float)

setMaximumBarWidth(self, width: float)[source]¶

Sets the maximum width (in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.

See also

minimumBarWidth()

See also

setMinimumBarWidth()

See also

setSegmentSizeMode()

Parameters:: width (float)

setMinimumBarWidth(self, width: float)[source]¶

Sets the minimum width (in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.

See also

minimumBarWidth()

See also

setMaximumBarWidth()

See also

setSegmentSizeMode()

Parameters:: width (float)

setNumberOfSegments(self, segments: int)[source]¶

Sets the number of segments included in the scalebar.

See also

numberOfSegments()

See also

setNumberOfSegmentsLeft()

Parameters:: segments (int)

setNumberOfSegmentsLeft(self, segments: int)[source]¶

Sets the number of segments included in the left part of the scalebar.

See also

numberOfSegmentsLeft()

See also

setNumberOfSegments()

Parameters:: segments (int)

setNumberOfSubdivisions(self, subdivisions: int)[source]¶

Sets the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types).

Note

The number of subdivisions represents the number of subdivision segments, not the number of subdivision lines. E.g. if the number is 1 then NO subdivision lines will be shown.

See also

numberOfSubdivisions()

Added in version 3.14.

Parameters:: subdivisions (int)

setNumericFormat(self, format: QgsNumericFormat | None)[source]¶

Sets the numeric format used for numbers in the scalebar.

Ownership of format is transferred to the settings.

See also

numericFormat()

Added in version 3.12.

Parameters:: format (Optional[QgsNumericFormat])

setPen(self, pen: QPen | QColor | Qt.GlobalColor)[source]¶

Sets the pen used for drawing outlines in the scalebar.

See also

pen()

Deprecated since version 3.40: Use setLineSymbol() instead.

Parameters:: pen (Union[QPen, Union[QColor, Qt.GlobalColor]])

setSegmentSizeMode(self, mode: Qgis.ScaleBarSegmentSizeMode)[source]¶

Sets the size mode for scale bar segments.

See also

segmentSizeMode()

See also

setMinimumBarWidth()

See also

setMaximumBarWidth()

Parameters:: mode (Qgis.ScaleBarSegmentSizeMode)

setSubdivisionLineSymbol(self, symbol: QgsLineSymbol | None)[source]¶

Sets the line symbol used to render the scalebar subdivisions (only used for some scalebar types). Ownership of symbol is transferred to the scalebar.

See also

subdivisionLineSymbol()

See also

setLineSymbol()

See also

setDivisionLineSymbol()

Added in version 3.14.

Parameters:: symbol (Optional[QgsLineSymbol])

setSubdivisionsHeight(self, height: float)[source]¶

Sets the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types).

See also

subdivisionsHeight()

Added in version 3.14.

Parameters:: height (float)

setTextFormat(self, format: QgsTextFormat)[source]¶

Sets the text format used for drawing text in the scalebar.

See also

textFormat()

Added in version 3.2.

Parameters:: format (QgsTextFormat)

setUnitLabel(self, label: str | None)[source]¶

Sets the label for units.

See also

unitLabel()

Parameters:: label (Optional[str])

setUnits(self, units: Qgis.DistanceUnit)[source]¶

Sets the distance units used by the scalebar.

See also

units()

Parameters:: units (Qgis.DistanceUnit)

setUnitsPerSegment(self, units: float)[source]¶

Sets the number of scalebar units per segment.

See also

unitsPerSegment()

Parameters:: units (float)

subdivisionLineSymbol(self) → QgsLineSymbol | None[source]¶

Returns the line symbol used to render the scalebar subdivisions (only used for some scalebar types).

Ownership is not transferred.

See also

setSubdivisionLineSymbol()

See also

lineSymbol()

See also

divisionLineSymbol()

Added in version 3.14.

Return type:: Optional[QgsLineSymbol]

subdivisionsHeight(self) → float[source]¶

Returns the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types).

See also

setSubdivisionsHeight()

Added in version 3.14.