Subgroup: Scale
Class: QgsScaleBarSettings¶
-
class
qgis.core.
QgsScaleBarSettings
¶ Bases:
sip.wrapper
Constructor for QgsScaleBarSettings.
QgsScaleBarSettings(QgsScaleBarSettings)
The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.
New in version 3.0: Methods
alignment
Returns the scalebar alignment. boxContentSpace
Returns the spacing (margin) between the scalebar box and content in millimeters. brush
Returns the primary brush used for filling the scalebar. brush2
Returns the secondary brush for the scalebar. fillColor
Returns the color used for fills in the scalebar. fillColor2
Returns the secondary color used for fills in the scalebar. font
Returns the font used for drawing text in the scalebar. fontColor
Returns the color used for drawing text in the scalebar. height
Returns the scalebar height (in millimeters). labelBarSpace
Returns the spacing (in millimeters) between labels and the scalebar. lineCapStyle
Returns the cap style used for drawing lines in the scalebar. lineColor
Returns the color used for lines in the scalebar. lineJoinStyle
Returns the join style used for drawing lines in the scalebar. lineWidth
Returns the line width in millimeters for lines in the scalebar. mapUnitsPerScaleBarUnit
Returns the number of map units per scale bar unit used by the scalebar. maximumBarWidth
Returns the maximum width (in millimeters) for scale bar segments. minimumBarWidth
Returns the minimum width (in millimeters) for scale bar segments. numberOfSegments
Returns the number of segments included in the scalebar. numberOfSegmentsLeft
Returns the number of segments included in the left part of the scalebar. pen
Returns the pen used for drawing outlines in the scalebar. segmentSizeMode
Returns the size mode for the scale bar segments. setAlignment
Sets the scalebar alignment
.setBoxContentSpace
Sets the space
(margin) between the scalebar box and content in millimeters.setBrush
Sets the primary brush used for filling the scalebar. setBrush2
Sets the secondary brush used for filling the scalebar. setFillColor
Sets the color
used for fills in the scalebar.setFillColor2
Sets the secondary color
used for fills in the scalebar.setFont
Sets the font
used for drawing text in the scalebar.setFontColor
Sets the color
used for drawing text in the scalebar.setHeight
Sets the scalebar height
(in millimeters).setLabelBarSpace
Sets the spacing (in millimeters) between labels and the scalebar. setLineCapStyle
Sets the cap style
used when drawing the lines in the scalebar.setLineColor
Sets the color
used for lines in the scalebar.setLineJoinStyle
Sets the join style
used when drawing the lines in the scalebarsetLineWidth
Sets the line width
in millimeters for lines in the scalebar.setMapUnitsPerScaleBarUnit
Sets the number of map units
per scale bar unit used by the scalebar.setMaximumBarWidth
Sets the maximum width
(in millimeters) for scale bar segments.setMinimumBarWidth
Sets the minimum width
(in millimeters) for scale bar segments.setNumberOfSegments
Sets the number of segments
included in the scalebar.setNumberOfSegmentsLeft
Sets the number of segments
included in the left part of the scalebar.setPen
Sets the pen used for drawing outlines in the scalebar. setSegmentSizeMode
Sets the size mode
for scale bar segments.setTextFormat
Sets the text format
used for drawing text in the scalebar.setUnitLabel
Sets the label
for units.setUnits
Sets the distance units
used by the scalebar.setUnitsPerSegment
Sets the number of scalebar units
per segment.textFormat
Returns the text format used for drawing text in the scalebar. unitLabel
Returns the label for units. units
Returns the distance units used by the scalebar. unitsPerSegment
Returns the number of scalebar units per segment. Signals
Attributes
AlignLeft
AlignMiddle
AlignRight
SegmentSizeFitWidth
SegmentSizeFixed
-
AlignLeft
= 0¶
-
AlignMiddle
= 1¶
-
AlignRight
= 2¶
-
class
Alignment
¶ Bases:
int
-
SegmentSizeFitWidth
= 1¶
-
SegmentSizeFixed
= 0¶
-
class
SegmentSizeMode
¶ Bases:
int
-
alignment
(self) → QgsScaleBarSettings.Alignment¶ Returns the scalebar alignment.
See also
-
boxContentSpace
(self) → float¶ Returns the spacing (margin) between the scalebar box and content in millimeters.
See also
-
brush
(self) → QBrush¶ Returns the primary brush used for filling the scalebar.
See also
See also
See also
-
brush2
(self) → QBrush¶ Returns the secondary brush for the scalebar. This is used for alternating color style scalebars, such as single and double box styles.
See also
See also
-
fillColor
(self) → QColor¶ Returns the color used for fills in the scalebar.
See also
See also
-
fillColor2
(self) → QColor¶ Returns the secondary color used for fills in the scalebar.
See also
See also
-
font
(self) → QFont¶ Returns the font used for drawing text in the scalebar.
See also
Deprecated since version use: textFormat() instead
-
fontColor
(self) → QColor¶ Returns the color used for drawing text in the scalebar.
See also
See also
Deprecated since version use: textFormat() instead
-
height
(self) → float¶ Returns the scalebar height (in millimeters).
See also
-
labelBarSpace
(self) → float¶ Returns the spacing (in millimeters) between labels and the scalebar.
See also
-
lineCapStyle
(self) → Qt.PenCapStyle¶ Returns the cap style used for drawing lines in the scalebar.
See also
-
lineColor
(self) → QColor¶ Returns the color used for lines in the scalebar.
See also
-
lineJoinStyle
(self) → Qt.PenJoinStyle¶ Returns the join style used for drawing lines in the scalebar.
See also
-
lineWidth
(self) → float¶ Returns the line width in millimeters for lines in the scalebar.
See also
-
mapUnitsPerScaleBarUnit
(self) → float¶ Returns the number of map units per scale bar unit used by the scalebar.
See also
-
maximumBarWidth
(self) → float¶ Returns the maximum width (in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
See also
See also
See also
-
minimumBarWidth
(self) → float¶ Returns the minimum width (in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
See also
See also
See also
-
numberOfSegments
(self) → int¶ Returns the number of segments included in the scalebar.
See also
See also
-
numberOfSegmentsLeft
(self) → int¶ Returns the number of segments included in the left part of the scalebar.
See also
See also
-
pen
(self) → QPen¶ Returns the pen used for drawing outlines in the scalebar.
See also
See also
-
segmentSizeMode
(self) → QgsScaleBarSettings.SegmentSizeMode¶ Returns the size mode for the scale bar segments.
See also
See also
See also
-
setAlignment
(self, alignment: QgsScaleBarSettings.Alignment)¶ Sets the scalebar
alignment
.See also
-
setBoxContentSpace
(self, space: float)¶ Sets the
space
(margin) between the scalebar box and content in millimeters.See also
-
setBrush
(self, brush: Union[QBrush, QColor, Qt.GlobalColor, QGradient])¶ Sets the primary brush used for filling the scalebar.
See also
-
setBrush2
(self, brush: Union[QBrush, QColor, Qt.GlobalColor, QGradient])¶ Sets the secondary brush used for filling the scalebar.
See also
-
setFillColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the
color
used for fills in the scalebar.See also
See also
-
setFillColor2
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the secondary
color
used for fills in the scalebar.See also
See also
-
setFont
(self, font: QFont)¶ Sets the
font
used for drawing text in the scalebar.See also
Deprecated since version use: setTextFormat() instead
-
setFontColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the
color
used for drawing text in the scalebar.See also
See also
Deprecated since version use: textFormat() instead
-
setLabelBarSpace
(self, space: float)¶ Sets the spacing (in millimeters) between labels and the scalebar.
See also
-
setLineCapStyle
(self, style: Qt.PenCapStyle)¶ Sets the cap
style
used when drawing the lines in the scalebar.See also
-
setLineColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the
color
used for lines in the scalebar.See also
-
setLineJoinStyle
(self, style: Qt.PenJoinStyle)¶ Sets the join
style
used when drawing the lines in the scalebarSee also
-
setLineWidth
(self, width: float)¶ Sets the line
width
in millimeters for lines in the scalebar.See also
-
setMapUnitsPerScaleBarUnit
(self, units: float)¶ Sets the number of map
units
per scale bar unit used by the scalebar.See also
-
setMaximumBarWidth
(self, width: float)¶ Sets the maximum
width
(in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.See also
See also
See also
-
setMinimumBarWidth
(self, width: float)¶ Sets the minimum
width
(in millimeters) for scale bar segments. This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.See also
See also
See also
-
setNumberOfSegments
(self, segments: int)¶ Sets the number of
segments
included in the scalebar.See also
See also
-
setNumberOfSegmentsLeft
(self, segments: int)¶ Sets the number of
segments
included in the left part of the scalebar.See also
See also
-
setPen
(self, pen: Union[QPen, QColor, Qt.GlobalColor])¶ Sets the pen used for drawing outlines in the scalebar.
See also
-
setSegmentSizeMode
(self, mode: QgsScaleBarSettings.SegmentSizeMode)¶ Sets the size
mode
for scale bar segments.See also
See also
See also
-
setTextFormat
(self, format: QgsTextFormat)¶ Sets the text
format
used for drawing text in the scalebar.See also
New in version 3.2.
-
setUnitLabel
(self, label: str)¶ Sets the
label
for units.See also
-
setUnits
(self, units: QgsUnitTypes.DistanceUnit)¶ Sets the distance
units
used by the scalebar.See also
-
setUnitsPerSegment
(self, units: float)¶ Sets the number of scalebar
units
per segment.See also
-
textFormat
(self) → QgsTextFormat¶ Returns the text format used for drawing text in the scalebar.
See also
New in version 3.2.
-
unitLabel
(self) → str¶ Returns the label for units.
See also
-
units
(self) → QgsUnitTypes.DistanceUnit¶ Returns the distance units used by the scalebar.
See also
-
unitsPerSegment
(self) → float¶ Returns the number of scalebar units per segment.
See also
-