QGIS API Documentation  3.17.0-Master (3b262f2a79)
Public Attributes | List of all members
QgsScaleBarRenderer::ScaleBarContext Struct Reference

Contains parameters regarding scalebar calculations. More...

#include <qgsscalebarrenderer.h>

Public Attributes

Flags flags
 Scalebar renderer flags. More...
double scale { 1.0 }
 Scale denominator. More...
double segmentWidth { 0.0 }
 The width, in millimeters, of each individual segment drawn. More...
QSizeF size
 Destination size for scalebar. More...

Detailed Description

Contains parameters regarding scalebar calculations.

The need to attribute the parameters vary depending on the targeted scalebar.

Definition at line 70 of file qgsscalebarrenderer.h.

Member Data Documentation

◆ flags

Flags QgsScaleBarRenderer::ScaleBarContext::flags

Scalebar renderer flags.

Definition at line 90 of file qgsscalebarrenderer.h.

◆ scale

double QgsScaleBarRenderer::ScaleBarContext::scale { 1.0 }

Scale denominator.

Definition at line 87 of file qgsscalebarrenderer.h.

◆ segmentWidth

double QgsScaleBarRenderer::ScaleBarContext::segmentWidth { 0.0 }

The width, in millimeters, of each individual segment drawn.

The number of map units per segment needs to be set via QgsScaleBarSettings::setUnitsPerSegment.

Definition at line 77 of file qgsscalebarrenderer.h.

◆ size

QSizeF QgsScaleBarRenderer::ScaleBarContext::size

Destination size for scalebar.

This is used for scalebars which alter their appearance or alignment based on the desired scalebar size (e.g. correctly aligning text in a numeric scale bar).

Definition at line 84 of file qgsscalebarrenderer.h.

The documentation for this struct was generated from the following file: