QGIS API Documentation
3.12.1-București (121cc00ff0)
|
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... | |
double | boxContentSpace () const |
Returns the spacing (margin) between the scalebar box and content in millimeters. More... | |
QBrush | brush () const |
Returns the primary brush used for filling the scalebar. More... | |
QBrush | brush2 () const |
Returns the secondary brush for the scalebar. More... | |
QColor | fillColor () const |
Returns the color used for fills in the scalebar. More... | |
QColor | fillColor2 () const |
Returns the secondary color used for fills in the scalebar. 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... | |
Qt::PenCapStyle | lineCapStyle () const |
Returns the cap style used for drawing lines in the scalebar. More... | |
QColor | lineColor () const |
Returns the color used for lines in the scalebar. More... | |
Qt::PenJoinStyle | lineJoinStyle () const |
Returns the join style used for drawing lines in the scalebar. More... | |
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... | |
const QgsNumericFormat * | numericFormat () const |
Returns the numeric format used for numbers in the scalebar. More... | |
QgsScaleBarSettings & | operator= (const QgsScaleBarSettings &other) |
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 | setBoxContentSpace (double space) |
Sets the space (margin) between the scalebar box and content in millimeters. More... | |
void | setBrush (const QBrush &brush) |
Sets the primary brush used for filling the scalebar. More... | |
void | setBrush2 (const QBrush &brush) |
Sets the secondary brush used for filling the scalebar. More... | |
void | setFillColor (const QColor &color) |
Sets the color used for fills in the scalebar. More... | |
void | setFillColor2 (const QColor &color) |
Sets the secondary color used for fills in the scalebar. 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... | |
void | setLineCapStyle (Qt::PenCapStyle style) |
Sets the cap style used when drawing the lines in the scalebar. More... | |
void | setLineColor (const QColor &color) |
Sets the color used for lines in the scalebar. More... | |
void | setLineJoinStyle (Qt::PenJoinStyle style) |
Sets the join style used when drawing the lines in the scalebar. More... | |
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 | setNumericFormat (QgsNumericFormat *format) |
Sets the numeric format used for numbers in the scalebar. More... | |
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 | 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... | |
QgsTextFormat & | textFormat () |
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... | |
The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.
Definition at line 39 of file qgsscalebarsettings.h.
Scalebar alignment.
Enumerator | |
---|---|
AlignLeft | Left aligned. |
AlignMiddle | Center aligned. |
AlignRight | Right aligned. |
Definition at line 46 of file qgsscalebarsettings.h.
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 74 of file qgsscalebarsettings.h.
Label vertical placement.
Enumerator | |
---|---|
LabelAboveSegment | Labels are drawn above the scalebar. |
LabelBelowSegment | Labels are drawn below the scalebar. |
Definition at line 65 of file qgsscalebarsettings.h.
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 56 of file qgsscalebarsettings.h.
QgsScaleBarSettings::QgsScaleBarSettings | ( | ) |
Constructor for QgsScaleBarSettings.
Definition at line 22 of file qgsscalebarsettings.cpp.
|
default |
QgsScaleBarSettings::QgsScaleBarSettings | ( | const QgsScaleBarSettings & | other | ) |
Copy constructor.
Definition at line 42 of file qgsscalebarsettings.cpp.
|
inline |
Returns the scalebar alignment.
Definition at line 451 of file qgsscalebarsettings.h.
|
inline |
Returns the spacing (margin) between the scalebar box and content in millimeters.
Definition at line 439 of file qgsscalebarsettings.h.
|
inline |
Returns the primary brush used for filling the scalebar.
Definition at line 361 of file qgsscalebarsettings.h.
|
inline |
Returns the secondary brush for the scalebar.
This is used for alternating color style scalebars, such as single and double box styles.
Definition at line 375 of file qgsscalebarsettings.h.
|
inline |
Returns the color used for fills in the scalebar.
Definition at line 295 of file qgsscalebarsettings.h.
|
inline |
Returns the secondary color used for fills in the scalebar.
Definition at line 309 of file qgsscalebarsettings.h.
|
inline |
Returns the font used for drawing text in the scalebar.
Definition at line 252 of file qgsscalebarsettings.h.
|
inline |
Returns the color used for drawing text in the scalebar.
Definition at line 280 of file qgsscalebarsettings.h.
|
inline |
Returns the scalebar height (in millimeters).
Definition at line 387 of file qgsscalebarsettings.h.
|
inline |
Returns the spacing (in millimeters) between labels and the scalebar.
Definition at line 399 of file qgsscalebarsettings.h.
|
inline |
Returns the horizontal placement of text labels.
Definition at line 426 of file qgsscalebarsettings.h.
|
inline |
Returns the vertical placement of text labels.
Definition at line 412 of file qgsscalebarsettings.h.
|
inline |
Returns the cap style used for drawing lines in the scalebar.
Definition at line 475 of file qgsscalebarsettings.h.
|
inline |
Returns the color used for lines in the scalebar.
Definition at line 322 of file qgsscalebarsettings.h.
|
inline |
Returns the join style used for drawing lines in the scalebar.
Definition at line 463 of file qgsscalebarsettings.h.
|
inline |
Returns the line width in millimeters for lines in the scalebar.
Definition at line 334 of file qgsscalebarsettings.h.
|
inline |
Returns the number of map units per scale bar unit used by the scalebar.
Definition at line 206 of file qgsscalebarsettings.h.
|
inline |
Returns the maximum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 178 of file qgsscalebarsettings.h.
|
inline |
Returns the minimum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 158 of file qgsscalebarsettings.h.
|
inline |
Returns the number of segments included in the scalebar.
Definition at line 99 of file qgsscalebarsettings.h.
|
inline |
Returns the number of segments included in the left part of the scalebar.
Definition at line 113 of file qgsscalebarsettings.h.
const QgsNumericFormat * QgsScaleBarSettings::numericFormat | ( | ) | const |
Returns the numeric format used for numbers in the scalebar.
Definition at line 104 of file qgsscalebarsettings.cpp.
QgsScaleBarSettings & QgsScaleBarSettings::operator= | ( | const QgsScaleBarSettings & | other | ) |
Definition at line 73 of file qgsscalebarsettings.cpp.
|
inline |
Returns the pen used for drawing outlines in the scalebar.
Definition at line 347 of file qgsscalebarsettings.h.
|
inline |
Returns the size mode for the scale bar segments.
Definition at line 140 of file qgsscalebarsettings.h.
|
inline |
Sets the scalebar alignment.
Definition at line 457 of file qgsscalebarsettings.h.
|
inline |
Sets the space (margin) between the scalebar box and content in millimeters.
Definition at line 445 of file qgsscalebarsettings.h.
|
inline |
Sets the primary brush used for filling the scalebar.
Definition at line 367 of file qgsscalebarsettings.h.
|
inline |
Sets the secondary brush used for filling the scalebar.
Definition at line 381 of file qgsscalebarsettings.h.
|
inline |
Sets the color used for fills in the scalebar.
Definition at line 302 of file qgsscalebarsettings.h.
|
inline |
Sets the secondary color used for fills in the scalebar.
Definition at line 316 of file qgsscalebarsettings.h.
|
inline |
Sets the font used for drawing text in the scalebar.
Definition at line 259 of file qgsscalebarsettings.h.
|
inline |
Sets the color used for drawing text in the scalebar.
Definition at line 288 of file qgsscalebarsettings.h.
|
inline |
Sets the scalebar height (in millimeters).
Definition at line 393 of file qgsscalebarsettings.h.
|
inline |
Sets the spacing (in millimeters) between labels and the scalebar.
Definition at line 405 of file qgsscalebarsettings.h.
|
inline |
Sets the horizontal placement of text labels.
Definition at line 433 of file qgsscalebarsettings.h.
|
inline |
Sets the vertical placement of text labels.
Definition at line 419 of file qgsscalebarsettings.h.
|
inline |
Sets the cap style used when drawing the lines in the scalebar.
Definition at line 481 of file qgsscalebarsettings.h.
|
inline |
Sets the color used for lines in the scalebar.
Definition at line 328 of file qgsscalebarsettings.h.
|
inline |
Sets the join style used when drawing the lines in the scalebar.
Definition at line 469 of file qgsscalebarsettings.h.
|
inline |
Sets the line width in millimeters for lines in the scalebar.
Definition at line 340 of file qgsscalebarsettings.h.
|
inline |
Sets the number of map units per scale bar unit used by the scalebar.
Definition at line 212 of file qgsscalebarsettings.h.
|
inline |
Sets the maximum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 188 of file qgsscalebarsettings.h.
|
inline |
Sets the minimum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 168 of file qgsscalebarsettings.h.
|
inline |
Sets the number of segments included in the scalebar.
Definition at line 106 of file qgsscalebarsettings.h.
|
inline |
Sets the number of segments included in the left part of the scalebar.
Definition at line 120 of file qgsscalebarsettings.h.
void QgsScaleBarSettings::setNumericFormat | ( | QgsNumericFormat * | format | ) |
Sets the numeric format used for numbers in the scalebar.
Ownership of format is transferred to the settings.
Definition at line 109 of file qgsscalebarsettings.cpp.
|
inline |
Sets the pen used for drawing outlines in the scalebar.
Definition at line 353 of file qgsscalebarsettings.h.
|
inline |
Sets the size mode for scale bar segments.
Definition at line 148 of file qgsscalebarsettings.h.
|
inline |
Sets the text format used for drawing text in the scalebar.
Definition at line 245 of file qgsscalebarsettings.h.
|
inline |
|
inline |
Sets the distance units used by the scalebar.
Definition at line 200 of file qgsscalebarsettings.h.
|
inline |
Sets the number of scalebar units per segment.
Definition at line 132 of file qgsscalebarsettings.h.
|
inline |
Returns the text format used for drawing text in the scalebar.
Definition at line 231 of file qgsscalebarsettings.h.
|
inline |
Returns the text format used for drawing text in the scalebar.
Definition at line 238 of file qgsscalebarsettings.h.
|
inline |
Returns the label for units.
Definition at line 218 of file qgsscalebarsettings.h.
|
inline |
Returns the distance units used by the scalebar.
Definition at line 194 of file qgsscalebarsettings.h.
|
inline |
Returns the number of scalebar units per segment.
Definition at line 126 of file qgsscalebarsettings.h.