QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
Public Types | Public Member Functions | List of all members
QgsScaleBarSettings Class Reference

The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer. More...

#include <qgsscalebarsettings.h>

Public Types

enum  Alignment { AlignLeft = 0 , AlignMiddle , AlignRight }
 Scalebar alignment. More...
 
enum  LabelHorizontalPlacement { LabelCenteredEdge = 0 , LabelCenteredSegment }
 Label horizontal placement. More...
 
enum  LabelVerticalPlacement { LabelAboveSegment = 0 , LabelBelowSegment }
 Label vertical placement. More...
 
enum  SegmentSizeMode { SegmentSizeFixed = 0 , SegmentSizeFitWidth = 1 }
 Modes for setting size for scale bar segments. More...
 

Public Member Functions

 QgsScaleBarSettings ()
 Constructor for QgsScaleBarSettings. More...
 
 QgsScaleBarSettings (const QgsScaleBarSettings &other)
 Copy constructor. More...
 
 ~QgsScaleBarSettings ()
 
Alignment alignment () const
 Returns the scalebar alignment. More...
 
QgsFillSymbolalternateFillSymbol () const
 Returns the secondary fill symbol used to render the scalebar (only used for some scalebar types). More...
 
double boxContentSpace () const
 Returns the spacing (margin) between the scalebar box and content in millimeters. More...
 
Q_DECL_DEPRECATED QBrush brush () const
 Returns the primary brush used for filling the scalebar. More...
 
Q_DECL_DEPRECATED QBrush brush2 () const
 Returns the secondary brush for the scalebar. More...
 
QgsLineSymboldivisionLineSymbol () const
 Returns the line symbol used to render the scalebar divisions (only used for some scalebar types). More...
 
Q_DECL_DEPRECATED QColor fillColor () const
 Returns the color used for fills in the scalebar. More...
 
Q_DECL_DEPRECATED QColor fillColor2 () const
 Returns the secondary color used for fills in the scalebar. More...
 
QgsFillSymbolfillSymbol () const
 Returns the primary fill symbol used to render the scalebar (only used for some scalebar types). More...
 
Q_DECL_DEPRECATED QFont font () const
 Returns the font used for drawing text in the scalebar. More...
 
Q_DECL_DEPRECATED QColor fontColor () const
 Returns the color used for drawing text in the scalebar. More...
 
double height () const
 Returns the scalebar height (in millimeters). More...
 
double labelBarSpace () const
 Returns the spacing (in millimeters) between labels and the scalebar. More...
 
LabelHorizontalPlacement labelHorizontalPlacement () const
 Returns the horizontal placement of text labels. More...
 
LabelVerticalPlacement labelVerticalPlacement () const
 Returns the vertical placement of text labels. More...
 
Q_DECL_DEPRECATED Qt::PenCapStyle lineCapStyle () const
 Returns the cap style used for drawing lines in the scalebar. More...
 
Q_DECL_DEPRECATED QColor lineColor () const
 Returns the color used for lines in the scalebar. More...
 
Q_DECL_DEPRECATED Qt::PenJoinStyle lineJoinStyle () const
 Returns the join style used for drawing lines in the scalebar. More...
 
QgsLineSymbollineSymbol () const
 Returns the line symbol used to render the scalebar (only used for some scalebar types). More...
 
Q_DECL_DEPRECATED double lineWidth () const
 Returns the line width in millimeters for lines in the scalebar. More...
 
double mapUnitsPerScaleBarUnit () const
 Returns the number of map units per scale bar unit used by the scalebar. More...
 
double maximumBarWidth () const
 Returns the maximum width (in millimeters) for scale bar segments. More...
 
double minimumBarWidth () const
 Returns the minimum width (in millimeters) for scale bar segments. More...
 
int numberOfSegments () const
 Returns the number of segments included in the scalebar. More...
 
int numberOfSegmentsLeft () const
 Returns the number of segments included in the left part of the scalebar. More...
 
int numberOfSubdivisions () const
 Returns the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types). More...
 
const QgsNumericFormatnumericFormat () const
 Returns the numeric format used for numbers in the scalebar. More...
 
QgsScaleBarSettingsoperator= (const QgsScaleBarSettings &other)
 
Q_DECL_DEPRECATED QPen pen () const
 Returns the pen used for drawing outlines in the scalebar. More...
 
SegmentSizeMode segmentSizeMode () const
 Returns the size mode for the scale bar segments. More...
 
void setAlignment (Alignment alignment)
 Sets the scalebar alignment. More...
 
void setAlternateFillSymbol (QgsFillSymbol *symbol)
 Sets the secondary fill symbol used to render the scalebar (only used for some scalebar types). More...
 
void setBoxContentSpace (double space)
 Sets the space (margin) between the scalebar box and content in millimeters. More...
 
Q_DECL_DEPRECATED void setBrush (const QBrush &brush)
 Sets the primary brush used for filling the scalebar. More...
 
Q_DECL_DEPRECATED void setBrush2 (const QBrush &brush)
 Sets the secondary brush used for filling the scalebar. More...
 
void setDivisionLineSymbol (QgsLineSymbol *symbol)
 Sets the line symbol used to render the scalebar divisions (only used for some scalebar types). More...
 
Q_DECL_DEPRECATED void setFillColor (const QColor &color)
 Sets the color used for fills in the scalebar. More...
 
Q_DECL_DEPRECATED void setFillColor2 (const QColor &color)
 Sets the secondary color used for fills in the scalebar. More...
 
void setFillSymbol (QgsFillSymbol *symbol)
 Sets the primary fill symbol used to render the scalebar (only used for some scalebar types). More...
 
Q_DECL_DEPRECATED void setFont (const QFont &font)
 Sets the font used for drawing text in the scalebar. More...
 
Q_DECL_DEPRECATED void setFontColor (const QColor &color)
 Sets the color used for drawing text in the scalebar. More...
 
void setHeight (double height)
 Sets the scalebar height (in millimeters). More...
 
void setLabelBarSpace (double space)
 Sets the spacing (in millimeters) between labels and the scalebar. More...
 
void setLabelHorizontalPlacement (LabelHorizontalPlacement placement)
 Sets the horizontal placement of text labels. More...
 
void setLabelVerticalPlacement (LabelVerticalPlacement placement)
 Sets the vertical placement of text labels. More...
 
Q_DECL_DEPRECATED void setLineCapStyle (Qt::PenCapStyle style)
 Sets the cap style used when drawing the lines in the scalebar. More...
 
Q_DECL_DEPRECATED void setLineColor (const QColor &color)
 Sets the color used for lines in the scalebar. More...
 
Q_DECL_DEPRECATED void setLineJoinStyle (Qt::PenJoinStyle style)
 Sets the join style used when drawing the lines in the scalebar. More...
 
void setLineSymbol (QgsLineSymbol *symbol)
 Sets the line symbol used to render the scalebar (only used for some scalebar types). More...
 
Q_DECL_DEPRECATED void setLineWidth (double width)
 Sets the line width in millimeters for lines in the scalebar. More...
 
void setMapUnitsPerScaleBarUnit (double units)
 Sets the number of map units per scale bar unit used by the scalebar. More...
 
void setMaximumBarWidth (double width)
 Sets the maximum width (in millimeters) for scale bar segments. More...
 
void setMinimumBarWidth (double width)
 Sets the minimum width (in millimeters) for scale bar segments. More...
 
void setNumberOfSegments (int segments)
 Sets the number of segments included in the scalebar. More...
 
void setNumberOfSegmentsLeft (int segments)
 Sets the number of segments included in the left part of the scalebar. More...
 
void setNumberOfSubdivisions (int subdivisions)
 Sets the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types). More...
 
void setNumericFormat (QgsNumericFormat *format)
 Sets the numeric format used for numbers in the scalebar. More...
 
Q_DECL_DEPRECATED void setPen (const QPen &pen)
 Sets the pen used for drawing outlines in the scalebar. More...
 
void setSegmentSizeMode (SegmentSizeMode mode)
 Sets the size mode for scale bar segments. More...
 
void setSubdivisionLineSymbol (QgsLineSymbol *symbol)
 Sets the line symbol used to render the scalebar subdivisions (only used for some scalebar types). More...
 
void setSubdivisionsHeight (double height)
 Sets the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types). More...
 
void setTextFormat (const QgsTextFormat &format)
 Sets the text format used for drawing text in the scalebar. More...
 
void setUnitLabel (const QString &label)
 Sets the label for units. More...
 
void setUnits (QgsUnitTypes::DistanceUnit units)
 Sets the distance units used by the scalebar. More...
 
void setUnitsPerSegment (double units)
 Sets the number of scalebar units per segment. More...
 
QgsLineSymbolsubdivisionLineSymbol () const
 Returns the line symbol used to render the scalebar subdivisions (only used for some scalebar types). More...
 
double subdivisionsHeight () const
 Returns the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types). More...
 
QgsTextFormattextFormat ()
 Returns the text format used for drawing text in the scalebar. More...
 
QgsTextFormat textFormat () const
 Returns the text format used for drawing text in the scalebar. More...
 
QString unitLabel () const
 Returns the label for units. More...
 
QgsUnitTypes::DistanceUnit units () const
 Returns the distance units used by the scalebar. More...
 
double unitsPerSegment () const
 Returns the number of scalebar units per segment. More...
 

Detailed Description

The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.

Since
QGIS 3.0

Definition at line 40 of file qgsscalebarsettings.h.

Member Enumeration Documentation

◆ Alignment

Scalebar alignment.

Enumerator
AlignLeft 

Left aligned.

AlignMiddle 

Center aligned.

AlignRight 

Right aligned.

Definition at line 47 of file qgsscalebarsettings.h.

◆ LabelHorizontalPlacement

Label horizontal placement.

Enumerator
LabelCenteredEdge 

Labels are drawn centered relative to segment's edge.

LabelCenteredSegment 

Labels are drawn centered relative to segment.

Definition at line 75 of file qgsscalebarsettings.h.

◆ LabelVerticalPlacement

Label vertical placement.

Enumerator
LabelAboveSegment 

Labels are drawn above the scalebar.

LabelBelowSegment 

Labels are drawn below the scalebar.

Definition at line 66 of file qgsscalebarsettings.h.

◆ SegmentSizeMode

Modes for setting size for scale bar segments.

Enumerator
SegmentSizeFixed 

Scale bar segment size is fixed to a map unit.

SegmentSizeFitWidth 

Scale bar segment size is calculated to fit a size range.

Definition at line 57 of file qgsscalebarsettings.h.

Constructor & Destructor Documentation

◆ QgsScaleBarSettings() [1/2]

QgsScaleBarSettings::QgsScaleBarSettings ( )

Constructor for QgsScaleBarSettings.

Definition at line 25 of file qgsscalebarsettings.cpp.

◆ ~QgsScaleBarSettings()

QgsScaleBarSettings::~QgsScaleBarSettings ( )
default

◆ QgsScaleBarSettings() [2/2]

QgsScaleBarSettings::QgsScaleBarSettings ( const QgsScaleBarSettings other)

Copy constructor.

Definition at line 59 of file qgsscalebarsettings.cpp.

Member Function Documentation

◆ alignment()

Alignment QgsScaleBarSettings::alignment ( ) const
inline

Returns the scalebar alignment.

See also
setAlignment()

Definition at line 614 of file qgsscalebarsettings.h.

◆ alternateFillSymbol()

QgsFillSymbol * QgsScaleBarSettings::alternateFillSymbol ( ) const

Returns the secondary fill symbol used to render the scalebar (only used for some scalebar types).

Ownership is not transferred.

See also
setAlternateFillSymbol()
fillSymbol()
Since
QGIS 3.14

Definition at line 231 of file qgsscalebarsettings.cpp.

◆ boxContentSpace()

double QgsScaleBarSettings::boxContentSpace ( ) const
inline

Returns the spacing (margin) between the scalebar box and content in millimeters.

See also
setBoxContentSpace()

Definition at line 602 of file qgsscalebarsettings.h.

◆ brush()

QBrush QgsScaleBarSettings::brush ( ) const

Returns the primary brush used for filling the scalebar.

See also
setBrush()
brush2()
pen()
Deprecated:
use fillSymbol() instead

Definition at line 241 of file qgsscalebarsettings.cpp.

◆ brush2()

QBrush QgsScaleBarSettings::brush2 ( ) const

Returns the secondary brush for the scalebar.

This is used for alternating color style scalebars, such as single and double box styles.

See also
setBrush2()
brush()
Deprecated:
use alternateFillSymbol() instead

Definition at line 262 of file qgsscalebarsettings.cpp.

◆ divisionLineSymbol()

QgsLineSymbol * QgsScaleBarSettings::divisionLineSymbol ( ) const

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

Ownership is not transferred.

See also
setDivisionLineSymbol()
lineSymbol()
subdivisionLineSymbol()
Since
QGIS 3.14

Definition at line 201 of file qgsscalebarsettings.cpp.

◆ fillColor()

QColor QgsScaleBarSettings::fillColor ( ) const

Returns the color used for fills in the scalebar.

See also
setFillColor()
fillColor2()
Deprecated:
use fillSymbol() instead.

Definition at line 117 of file qgsscalebarsettings.cpp.

◆ fillColor2()

QColor QgsScaleBarSettings::fillColor2 ( ) const

Returns the secondary color used for fills in the scalebar.

See also
setFillColor2()
fillColor()
Deprecated:
use alternateFillSymbol() instead

Definition at line 127 of file qgsscalebarsettings.cpp.

◆ fillSymbol()

QgsFillSymbol * QgsScaleBarSettings::fillSymbol ( ) const

Returns the primary fill symbol used to render the scalebar (only used for some scalebar types).

Ownership is not transferred.

See also
setFillSymbol()
alternateFillSymbol()
Since
QGIS 3.14

Definition at line 221 of file qgsscalebarsettings.cpp.

◆ font()

Q_DECL_DEPRECATED QFont QgsScaleBarSettings::font ( ) const
inline

Returns the font used for drawing text in the scalebar.

See also
setFont()
Deprecated:
use textFormat() instead

Definition at line 289 of file qgsscalebarsettings.h.

◆ fontColor()

Q_DECL_DEPRECATED QColor QgsScaleBarSettings::fontColor ( ) const
inline

Returns the color used for drawing text in the scalebar.

See also
setFontColor()
font()
Deprecated:
use textFormat() instead

Definition at line 317 of file qgsscalebarsettings.h.

◆ height()

double QgsScaleBarSettings::height ( ) const
inline

Returns the scalebar height (in millimeters).

See also
setHeight()

Definition at line 550 of file qgsscalebarsettings.h.

◆ labelBarSpace()

double QgsScaleBarSettings::labelBarSpace ( ) const
inline

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

See also
setLabelBarSpace()

Definition at line 562 of file qgsscalebarsettings.h.

◆ labelHorizontalPlacement()

LabelHorizontalPlacement QgsScaleBarSettings::labelHorizontalPlacement ( ) const
inline

Returns the horizontal placement of text labels.

See also
setLabelHorizontalPlacement()
Since
QGIS 3.10

Definition at line 589 of file qgsscalebarsettings.h.

◆ labelVerticalPlacement()

LabelVerticalPlacement QgsScaleBarSettings::labelVerticalPlacement ( ) const
inline

Returns the vertical placement of text labels.

See also
setLabelVerticalPlacement()
Since
QGIS 3.10

Definition at line 575 of file qgsscalebarsettings.h.

◆ lineCapStyle()

Qt::PenCapStyle QgsScaleBarSettings::lineCapStyle ( ) const

Returns the cap style used for drawing lines in the scalebar.

See also
setLineCapStyle()
Deprecated:
use lineSymbol() instead

Definition at line 303 of file qgsscalebarsettings.cpp.

◆ lineColor()

QColor QgsScaleBarSettings::lineColor ( ) const

Returns the color used for lines in the scalebar.

See also
setLineColor()
Deprecated:
use lineSymbol() instead.

Definition at line 137 of file qgsscalebarsettings.cpp.

◆ lineJoinStyle()

Qt::PenJoinStyle QgsScaleBarSettings::lineJoinStyle ( ) const

Returns the join style used for drawing lines in the scalebar.

See also
setLineJoinStyle()
Deprecated:
use lineSymbol() instead

Definition at line 283 of file qgsscalebarsettings.cpp.

◆ lineSymbol()

QgsLineSymbol * QgsScaleBarSettings::lineSymbol ( ) const

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

Ownership is not transferred.

See also
setLineSymbol()
divisionLineSymbol()
subdivisionLineSymbol()
Since
QGIS 3.14

Definition at line 191 of file qgsscalebarsettings.cpp.

◆ lineWidth()

double QgsScaleBarSettings::lineWidth ( ) const

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

See also
setLineWidth()
Deprecated:
use lineSymbol() instead.

Definition at line 150 of file qgsscalebarsettings.cpp.

◆ mapUnitsPerScaleBarUnit()

double QgsScaleBarSettings::mapUnitsPerScaleBarUnit ( ) const
inline

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

See also
setMapUnitsPerScaleBarUnit()

Definition at line 243 of file qgsscalebarsettings.h.

◆ maximumBarWidth()

double QgsScaleBarSettings::maximumBarWidth ( ) const
inline

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()
setMaximumBarWidth()
minimumBarWidth()

Definition at line 215 of file qgsscalebarsettings.h.

◆ minimumBarWidth()

double QgsScaleBarSettings::minimumBarWidth ( ) const
inline

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()
setMinimumBarWidth()
maximumBarWidth()

Definition at line 195 of file qgsscalebarsettings.h.

◆ numberOfSegments()

int QgsScaleBarSettings::numberOfSegments ( ) const
inline

Returns the number of segments included in the scalebar.

See also
setNumberOfSegments()
numberOfSegmentsLeft()

Definition at line 100 of file qgsscalebarsettings.h.

◆ numberOfSegmentsLeft()

int QgsScaleBarSettings::numberOfSegmentsLeft ( ) const
inline

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

See also
setNumberOfSegmentsLeft()
numberOfSegments()

Definition at line 114 of file qgsscalebarsettings.h.

◆ numberOfSubdivisions()

int QgsScaleBarSettings::numberOfSubdivisions ( ) const
inline

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()
Since
QGIS 3.14

Definition at line 132 of file qgsscalebarsettings.h.

◆ numericFormat()

const QgsNumericFormat * QgsScaleBarSettings::numericFormat ( ) const

Returns the numeric format used for numbers in the scalebar.

See also
setNumericFormat()
Since
QGIS 3.12

Definition at line 323 of file qgsscalebarsettings.cpp.

◆ operator=()

QgsScaleBarSettings & QgsScaleBarSettings::operator= ( const QgsScaleBarSettings other)

Definition at line 88 of file qgsscalebarsettings.cpp.

◆ pen()

QPen QgsScaleBarSettings::pen ( ) const

Returns the pen used for drawing outlines in the scalebar.

See also
setPen()
brush()
Deprecated:
use lineSymbol() instead.

Definition at line 164 of file qgsscalebarsettings.cpp.

◆ segmentSizeMode()

SegmentSizeMode QgsScaleBarSettings::segmentSizeMode ( ) const
inline

Returns the size mode for the scale bar segments.

See also
setSegmentSizeMode()
minimumBarWidth()
maximumBarWidth()

Definition at line 177 of file qgsscalebarsettings.h.

◆ setAlignment()

void QgsScaleBarSettings::setAlignment ( Alignment  alignment)
inline

Sets the scalebar alignment.

See also
alignment()

Definition at line 620 of file qgsscalebarsettings.h.

◆ setAlternateFillSymbol()

void QgsScaleBarSettings::setAlternateFillSymbol ( QgsFillSymbol symbol)

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()
setFillSymbol()
Since
QGIS 3.14

Definition at line 236 of file qgsscalebarsettings.cpp.

◆ setBoxContentSpace()

void QgsScaleBarSettings::setBoxContentSpace ( double  space)
inline

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

See also
boxContentSpace()

Definition at line 608 of file qgsscalebarsettings.h.

◆ setBrush()

void QgsScaleBarSettings::setBrush ( const QBrush &  brush)

Sets the primary brush used for filling the scalebar.

See also
brush()
Deprecated:
use setFillSymbol() instead

Definition at line 253 of file qgsscalebarsettings.cpp.

◆ setBrush2()

void QgsScaleBarSettings::setBrush2 ( const QBrush &  brush)

Sets the secondary brush used for filling the scalebar.

See also
brush()
Deprecated:
use setAlternateFillSymbol() instead

Definition at line 274 of file qgsscalebarsettings.cpp.

◆ setDivisionLineSymbol()

void QgsScaleBarSettings::setDivisionLineSymbol ( QgsLineSymbol symbol)

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()
setLineSymbol()
setSubdivisionLineSymbol()
Since
QGIS 3.14

Definition at line 206 of file qgsscalebarsettings.cpp.

◆ setFillColor()

void QgsScaleBarSettings::setFillColor ( const QColor &  color)

Sets the color used for fills in the scalebar.

See also
fillColor()
setFillColor2()
Deprecated:
use setFillSymbol() instead.

Definition at line 122 of file qgsscalebarsettings.cpp.

◆ setFillColor2()

void QgsScaleBarSettings::setFillColor2 ( const QColor &  color)

Sets the secondary color used for fills in the scalebar.

See also
fillColor2()
setFillColor2()
Deprecated:
use setAlternateFillSymbol() instead.

Definition at line 132 of file qgsscalebarsettings.cpp.

◆ setFillSymbol()

void QgsScaleBarSettings::setFillSymbol ( QgsFillSymbol symbol)

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()
setAlternateFillSymbol()
Since
QGIS 3.14

Definition at line 226 of file qgsscalebarsettings.cpp.

◆ setFont()

Q_DECL_DEPRECATED void QgsScaleBarSettings::setFont ( const QFont &  font)
inline

Sets the font used for drawing text in the scalebar.

See also
font()
Deprecated:
use setTextFormat() instead

Definition at line 296 of file qgsscalebarsettings.h.

◆ setFontColor()

Q_DECL_DEPRECATED void QgsScaleBarSettings::setFontColor ( const QColor &  color)
inline

Sets the color used for drawing text in the scalebar.

See also
fontColor()
setFont()
Deprecated:
use textFormat() instead

Definition at line 325 of file qgsscalebarsettings.h.

◆ setHeight()

void QgsScaleBarSettings::setHeight ( double  height)
inline

Sets the scalebar height (in millimeters).

See also
height()

Definition at line 556 of file qgsscalebarsettings.h.

◆ setLabelBarSpace()

void QgsScaleBarSettings::setLabelBarSpace ( double  space)
inline

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

See also
labelBarSpace()

Definition at line 568 of file qgsscalebarsettings.h.

◆ setLabelHorizontalPlacement()

void QgsScaleBarSettings::setLabelHorizontalPlacement ( LabelHorizontalPlacement  placement)
inline

Sets the horizontal placement of text labels.

See also
labelHorizontalPlacement()
Since
QGIS 3.10

Definition at line 596 of file qgsscalebarsettings.h.

◆ setLabelVerticalPlacement()

void QgsScaleBarSettings::setLabelVerticalPlacement ( LabelVerticalPlacement  placement)
inline

Sets the vertical placement of text labels.

See also
labelVerticalPlacement()
Since
QGIS 3.10

Definition at line 582 of file qgsscalebarsettings.h.

◆ setLineCapStyle()

void QgsScaleBarSettings::setLineCapStyle ( Qt::PenCapStyle  style)

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

See also
lineCapStyle()
Deprecated:
use setLineSymbol() instead

Definition at line 312 of file qgsscalebarsettings.cpp.

◆ setLineColor()

void QgsScaleBarSettings::setLineColor ( const QColor &  color)

Sets the color used for lines in the scalebar.

See also
lineColor()
Deprecated:
use setLineSymbol() instead.

Definition at line 142 of file qgsscalebarsettings.cpp.

◆ setLineJoinStyle()

void QgsScaleBarSettings::setLineJoinStyle ( Qt::PenJoinStyle  style)

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

See also
lineJoinStyle()
Deprecated:
use setLineSymbol() instead

Definition at line 292 of file qgsscalebarsettings.cpp.

◆ setLineSymbol()

void QgsScaleBarSettings::setLineSymbol ( QgsLineSymbol symbol)

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()
setDivisionLineSymbol()
setSubdivisionLineSymbol()
Since
QGIS 3.14

Definition at line 196 of file qgsscalebarsettings.cpp.

◆ setLineWidth()

void QgsScaleBarSettings::setLineWidth ( double  width)

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

See also
lineWidth()
Deprecated:
use setLineSymbol() instead.

Definition at line 155 of file qgsscalebarsettings.cpp.

◆ setMapUnitsPerScaleBarUnit()

void QgsScaleBarSettings::setMapUnitsPerScaleBarUnit ( double  units)
inline

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

See also
mapUnitsPerScaleBarUnit()

Definition at line 249 of file qgsscalebarsettings.h.

◆ setMaximumBarWidth()

void QgsScaleBarSettings::setMaximumBarWidth ( double  width)
inline

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()
setMinimumBarWidth()
setSegmentSizeMode()

Definition at line 225 of file qgsscalebarsettings.h.

◆ setMinimumBarWidth()

void QgsScaleBarSettings::setMinimumBarWidth ( double  width)
inline

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()
setMaximumBarWidth()
setSegmentSizeMode()

Definition at line 205 of file qgsscalebarsettings.h.

◆ setNumberOfSegments()

void QgsScaleBarSettings::setNumberOfSegments ( int  segments)
inline

Sets the number of segments included in the scalebar.

See also
numberOfSegments()
setNumberOfSegmentsLeft()

Definition at line 107 of file qgsscalebarsettings.h.

◆ setNumberOfSegmentsLeft()

void QgsScaleBarSettings::setNumberOfSegmentsLeft ( int  segments)
inline

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

See also
numberOfSegmentsLeft()
setNumberOfSegments()

Definition at line 121 of file qgsscalebarsettings.h.

◆ setNumberOfSubdivisions()

void QgsScaleBarSettings::setNumberOfSubdivisions ( int  subdivisions)
inline

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()
Since
QGIS 3.14

Definition at line 143 of file qgsscalebarsettings.h.

◆ setNumericFormat()

void QgsScaleBarSettings::setNumericFormat ( QgsNumericFormat format)

Sets the numeric format used for numbers in the scalebar.

Ownership of format is transferred to the settings.

See also
numericFormat()
Since
QGIS 3.12

Definition at line 328 of file qgsscalebarsettings.cpp.

◆ setPen()

void QgsScaleBarSettings::setPen ( const QPen &  pen)

Sets the pen used for drawing outlines in the scalebar.

See also
pen()
Deprecated:
use setLineSymbol() instead.

Definition at line 176 of file qgsscalebarsettings.cpp.

◆ setSegmentSizeMode()

void QgsScaleBarSettings::setSegmentSizeMode ( SegmentSizeMode  mode)
inline

Sets the size mode for scale bar segments.

See also
segmentSizeMode()
setMinimumBarWidth()
setMaximumBarWidth()

Definition at line 185 of file qgsscalebarsettings.h.

◆ setSubdivisionLineSymbol()

void QgsScaleBarSettings::setSubdivisionLineSymbol ( QgsLineSymbol symbol)

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()
setLineSymbol()
setDivisionLineSymbol()
Since
QGIS 3.14

Definition at line 216 of file qgsscalebarsettings.cpp.

◆ setSubdivisionsHeight()

void QgsScaleBarSettings::setSubdivisionsHeight ( double  height)
inline

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()
Since
QGIS 3.14

Definition at line 157 of file qgsscalebarsettings.h.

◆ setTextFormat()

void QgsScaleBarSettings::setTextFormat ( const QgsTextFormat format)
inline

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

See also
textFormat()
Since
QGIS 3.2

Definition at line 282 of file qgsscalebarsettings.h.

◆ setUnitLabel()

void QgsScaleBarSettings::setUnitLabel ( const QString &  label)
inline

Sets the label for units.

See also
unitLabel()

Definition at line 261 of file qgsscalebarsettings.h.

◆ setUnits()

void QgsScaleBarSettings::setUnits ( QgsUnitTypes::DistanceUnit  units)
inline

Sets the distance units used by the scalebar.

See also
units()

Definition at line 237 of file qgsscalebarsettings.h.

◆ setUnitsPerSegment()

void QgsScaleBarSettings::setUnitsPerSegment ( double  units)
inline

Sets the number of scalebar units per segment.

See also
unitsPerSegment()

Definition at line 169 of file qgsscalebarsettings.h.

◆ subdivisionLineSymbol()

QgsLineSymbol * QgsScaleBarSettings::subdivisionLineSymbol ( ) const

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

Ownership is not transferred.

See also
setSubdivisionLineSymbol()
lineSymbol()
divisionLineSymbol()
Since
QGIS 3.14

Definition at line 211 of file qgsscalebarsettings.cpp.

◆ subdivisionsHeight()

double QgsScaleBarSettings::subdivisionsHeight ( ) const
inline

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()
Since
QGIS 3.14

Definition at line 150 of file qgsscalebarsettings.h.

◆ textFormat() [1/2]

QgsTextFormat& QgsScaleBarSettings::textFormat ( )
inline

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

See also
setTextFormat()
Since
QGIS 3.2

Definition at line 268 of file qgsscalebarsettings.h.

◆ textFormat() [2/2]

QgsTextFormat QgsScaleBarSettings::textFormat ( ) const
inline

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

See also
setTextFormat()
Since
QGIS 3.2

Definition at line 275 of file qgsscalebarsettings.h.

◆ unitLabel()

QString QgsScaleBarSettings::unitLabel ( ) const
inline

Returns the label for units.

See also
setUnitLabel()

Definition at line 255 of file qgsscalebarsettings.h.

◆ units()

QgsUnitTypes::DistanceUnit QgsScaleBarSettings::units ( ) const
inline

Returns the distance units used by the scalebar.

See also
setUnits()

Definition at line 231 of file qgsscalebarsettings.h.

◆ unitsPerSegment()

double QgsScaleBarSettings::unitsPerSegment ( ) const
inline

Returns the number of scalebar units per segment.

See also
setUnitsPerSegment()

Definition at line 163 of file qgsscalebarsettings.h.


The documentation for this class was generated from the following files: