QGIS API Documentation 3.39.0-Master (e8f1b343c48)
|
Stores the settings for rendering a single diagram. More...
#include <qgsdiagramrenderer.h>
Public Types | |
enum | DiagramOrientation { Up , Down , Left , Right } |
Orientation of histogram. More... | |
enum | Direction { Clockwise , Counterclockwise } |
Angular directions. More... | |
enum | LabelPlacementMethod { Height , XHeight } |
enum | StackedDiagramMode { Horizontal , Vertical } |
Orientation of the stacked diagrams. More... | |
Public Member Functions | |
QgsDiagramSettings () | |
QgsDiagramSettings (const QgsDiagramSettings &other) | |
~QgsDiagramSettings () | |
QgsLineSymbol * | axisLineSymbol () const |
Returns the line symbol to use for rendering axis in diagrams. | |
Direction | direction () const |
Returns the chart's angular direction. | |
QList< QgsLayerTreeModelLegendNode * > | legendItems (QgsLayerTreeLayer *nodeLayer) const |
Returns list of legend nodes for the diagram. | |
QgsDiagramSettings & | operator= (const QgsDiagramSettings &other) |
QgsPaintEffect * | paintEffect () const |
Returns the paint effect to use while rendering diagrams. | |
void | readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext()) |
Reads diagram settings from XML. | |
void | setAxisLineSymbol (QgsLineSymbol *symbol) |
Sets the line symbol to use for rendering axis in diagrams. | |
void | setDirection (Direction direction) |
Sets the chart's angular direction. | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the paint effect to use while rendering diagrams. | |
void | setShowAxis (bool showAxis) |
Sets whether the diagram axis should be shown. | |
void | setSpacing (double spacing) |
Sets the spacing between diagram contents. | |
void | setSpacingMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the content spacing. | |
void | setSpacingUnit (Qgis::RenderUnit unit) |
Sets the unit for the content spacing. | |
void | setStackedDiagramSpacing (double spacing) |
Sets the spacing between subdiagrams in a stacked diagram. | |
void | setStackedDiagramSpacingMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the spacing between subdiagrams in a stacked diagram. | |
void | setStackedDiagramSpacingUnit (Qgis::RenderUnit unit) |
Sets the unit for the spacing between subdiagrams in a stacked diagram. | |
bool | showAxis () const |
Returns true if the diagram axis should be shown. | |
double | spacing () const |
Returns the spacing between diagram contents. | |
const QgsMapUnitScale & | spacingMapUnitScale () const |
Returns the map unit scale for the content spacing. | |
Qgis::RenderUnit | spacingUnit () const |
Returns the units for the content spacing. | |
double | stackedDiagramSpacing () const |
Returns the spacing between subdiagrams in a stacked diagram. | |
const QgsMapUnitScale & | stackedDiagramSpacingMapUnitScale () const |
Returns the map unit scale for the spacing between subdiagrams in a stacked diagram. | |
Qgis::RenderUnit | stackedDiagramSpacingUnit () const |
Returns the units for the spacing between subdiagrams in a stacked diagram. | |
void | writeXml (QDomElement &rendererElem, QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const |
Writes diagram settings to XML. | |
Public Attributes | |
QColor | backgroundColor |
double | barWidth = 5.0 |
QList< QString > | categoryAttributes |
QList< QColor > | categoryColors |
QList< QString > | categoryLabels |
DiagramOrientation | diagramOrientation = QgsDiagramSettings::Up |
bool | enabled = true |
QFont | font |
LabelPlacementMethod | labelPlacementMethod = QgsDiagramSettings::Height |
QgsMapUnitScale | lineSizeScale |
Line unit scale. | |
Qgis::RenderUnit | lineSizeUnit = Qgis::RenderUnit::Millimeters |
Line unit index. | |
double | maximumScale = 0 |
The maximum map scale (i.e. | |
double | minimumScale = 0 |
The minimum map scale (i.e. | |
double | minimumSize = 0.0 |
Scale diagrams smaller than mMinimumSize to mMinimumSize. | |
double | opacity = 1.0 |
Opacity, from 0 (transparent) to 1.0 (opaque) | |
QColor | penColor |
double | penWidth = 0.0 |
double | rotationOffset = 270 |
Rotation offset, in degrees clockwise from horizontal. | |
bool | scaleBasedVisibility = false |
bool | scaleByArea = true |
QSizeF | size |
QgsMapUnitScale | sizeScale |
Diagram size unit scale. | |
Qgis::RenderUnit | sizeType = Qgis::RenderUnit::Millimeters |
Diagram size unit. | |
StackedDiagramMode | stackedDiagramMode = QgsDiagramSettings::Horizontal |
Stores the settings for rendering a single diagram.
QgsDiagramSettings stores the settings related to rendering the individual diagrams themselves, while QgsDiagramLayerSettings stores settings which control how ALL diagrams within a layer are rendered.
Definition at line 362 of file qgsdiagramrenderer.h.
Orientation of histogram.
Enumerator | |
---|---|
Up | |
Down | |
Left | |
Right |
Definition at line 373 of file qgsdiagramrenderer.h.
Angular directions.
Enumerator | |
---|---|
Clockwise | Clockwise orientation. |
Counterclockwise | Counter-clockwise orientation. |
Definition at line 385 of file qgsdiagramrenderer.h.
Enumerator | |
---|---|
Height | |
XHeight |
Definition at line 366 of file qgsdiagramrenderer.h.
Orientation of the stacked diagrams.
Enumerator | |
---|---|
Horizontal | |
Vertical |
Definition at line 395 of file qgsdiagramrenderer.h.
QgsDiagramSettings::QgsDiagramSettings | ( | ) |
Definition at line 1172 of file qgsdiagramrenderer.cpp.
|
default |
QgsDiagramSettings::QgsDiagramSettings | ( | const QgsDiagramSettings & | other | ) |
Definition at line 1179 of file qgsdiagramrenderer.cpp.
QgsLineSymbol * QgsDiagramSettings::axisLineSymbol | ( | ) | const |
Returns the line symbol to use for rendering axis in diagrams.
Definition at line 1140 of file qgsdiagramrenderer.cpp.
QgsDiagramSettings::Direction QgsDiagramSettings::direction | ( | ) | const |
Returns the chart's angular direction.
Definition at line 1257 of file qgsdiagramrenderer.cpp.
QList< QgsLayerTreeModelLegendNode * > QgsDiagramSettings::legendItems | ( | QgsLayerTreeLayer * | nodeLayer | ) | const |
Returns list of legend nodes for the diagram.
Definition at line 1127 of file qgsdiagramrenderer.cpp.
QgsDiagramSettings & QgsDiagramSettings::operator= | ( | const QgsDiagramSettings & | other | ) |
Definition at line 1218 of file qgsdiagramrenderer.cpp.
QgsPaintEffect * QgsDiagramSettings::paintEffect | ( | ) | const |
Returns the paint effect to use while rendering diagrams.
Definition at line 1161 of file qgsdiagramrenderer.cpp.
void QgsDiagramSettings::readXml | ( | const QDomElement & | elem, |
const QgsReadWriteContext & | context = QgsReadWriteContext() |
||
) |
Reads diagram settings from XML.
Definition at line 178 of file qgsdiagramrenderer.cpp.
void QgsDiagramSettings::setAxisLineSymbol | ( | QgsLineSymbol * | symbol | ) |
Sets the line symbol to use for rendering axis in diagrams.
Ownership of symbol is transferred to the settings.
Definition at line 1145 of file qgsdiagramrenderer.cpp.
void QgsDiagramSettings::setDirection | ( | Direction | direction | ) |
Sets the chart's angular direction.
Definition at line 1262 of file qgsdiagramrenderer.cpp.
void QgsDiagramSettings::setPaintEffect | ( | QgsPaintEffect * | effect | ) |
Sets the paint effect to use while rendering diagrams.
Ownership of effect is transferred to the settings.
Definition at line 1166 of file qgsdiagramrenderer.cpp.
void QgsDiagramSettings::setShowAxis | ( | bool | showAxis | ) |
Sets whether the diagram axis should be shown.
Definition at line 1156 of file qgsdiagramrenderer.cpp.
|
inline |
Sets the spacing between diagram contents.
Spacing units are set via setSpacingUnit().
Definition at line 497 of file qgsdiagramrenderer.h.
|
inline |
Sets the map unit scale for the content spacing.
Definition at line 526 of file qgsdiagramrenderer.h.
|
inline |
Sets the unit for the content spacing.
Definition at line 507 of file qgsdiagramrenderer.h.
|
inline |
Sets the spacing between subdiagrams in a stacked diagram.
Spacing units are set via setStackedDiagramSpacingUnit().
Definition at line 562 of file qgsdiagramrenderer.h.
|
inline |
Sets the map unit scale for the spacing between subdiagrams in a stacked diagram.
Definition at line 592 of file qgsdiagramrenderer.h.
|
inline |
Sets the unit for the spacing between subdiagrams in a stacked diagram.
Definition at line 572 of file qgsdiagramrenderer.h.
bool QgsDiagramSettings::showAxis | ( | ) | const |
Returns true
if the diagram axis should be shown.
Definition at line 1151 of file qgsdiagramrenderer.cpp.
|
inline |
Returns the spacing between diagram contents.
Spacing units can be retrieved by calling spacingUnit().
Definition at line 484 of file qgsdiagramrenderer.h.
|
inline |
Returns the map unit scale for the content spacing.
Definition at line 536 of file qgsdiagramrenderer.h.
|
inline |
Returns the units for the content spacing.
Definition at line 516 of file qgsdiagramrenderer.h.
|
inline |
Returns the spacing between subdiagrams in a stacked diagram.
Spacing units can be retrieved by calling stackedDiagramSpacingUnit().
Definition at line 549 of file qgsdiagramrenderer.h.
|
inline |
Returns the map unit scale for the spacing between subdiagrams in a stacked diagram.
Definition at line 602 of file qgsdiagramrenderer.h.
|
inline |
Returns the units for the spacing between subdiagrams in a stacked diagram.
Definition at line 582 of file qgsdiagramrenderer.h.
void QgsDiagramSettings::writeXml | ( | QDomElement & | rendererElem, |
QDomDocument & | doc, | ||
const QgsReadWriteContext & | context = QgsReadWriteContext() |
||
) | const |
Writes diagram settings to XML.
Definition at line 361 of file qgsdiagramrenderer.cpp.
QColor QgsDiagramSettings::backgroundColor |
Definition at line 434 of file qgsdiagramrenderer.h.
double QgsDiagramSettings::barWidth = 5.0 |
Definition at line 440 of file qgsdiagramrenderer.h.
QList< QString > QgsDiagramSettings::categoryAttributes |
Definition at line 410 of file qgsdiagramrenderer.h.
QList< QColor > QgsDiagramSettings::categoryColors |
Definition at line 409 of file qgsdiagramrenderer.h.
QList< QString > QgsDiagramSettings::categoryLabels |
Definition at line 411 of file qgsdiagramrenderer.h.
DiagramOrientation QgsDiagramSettings::diagramOrientation = QgsDiagramSettings::Up |
Definition at line 438 of file qgsdiagramrenderer.h.
bool QgsDiagramSettings::enabled = true |
Definition at line 407 of file qgsdiagramrenderer.h.
QFont QgsDiagramSettings::font |
Definition at line 408 of file qgsdiagramrenderer.h.
LabelPlacementMethod QgsDiagramSettings::labelPlacementMethod = QgsDiagramSettings::Height |
Definition at line 437 of file qgsdiagramrenderer.h.
QgsMapUnitScale QgsDiagramSettings::lineSizeScale |
Line unit scale.
Definition at line 432 of file qgsdiagramrenderer.h.
Qgis::RenderUnit QgsDiagramSettings::lineSizeUnit = Qgis::RenderUnit::Millimeters |
Line unit index.
Definition at line 427 of file qgsdiagramrenderer.h.
double QgsDiagramSettings::maximumScale = 0 |
The maximum map scale (i.e.
most "zoomed in" scale) at which the diagrams will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.
Definition at line 460 of file qgsdiagramrenderer.h.
double QgsDiagramSettings::minimumScale = 0 |
The minimum map scale (i.e.
most "zoomed out" scale) at which the diagrams will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.
Definition at line 468 of file qgsdiagramrenderer.h.
double QgsDiagramSettings::minimumSize = 0.0 |
Scale diagrams smaller than mMinimumSize to mMinimumSize.
Definition at line 471 of file qgsdiagramrenderer.h.
double QgsDiagramSettings::opacity = 1.0 |
Opacity, from 0 (transparent) to 1.0 (opaque)
Definition at line 443 of file qgsdiagramrenderer.h.
QColor QgsDiagramSettings::penColor |
Definition at line 435 of file qgsdiagramrenderer.h.
double QgsDiagramSettings::penWidth = 0.0 |
Definition at line 436 of file qgsdiagramrenderer.h.
double QgsDiagramSettings::rotationOffset = 270 |
Rotation offset, in degrees clockwise from horizontal.
Definition at line 450 of file qgsdiagramrenderer.h.
bool QgsDiagramSettings::scaleBasedVisibility = false |
Definition at line 452 of file qgsdiagramrenderer.h.
bool QgsDiagramSettings::scaleByArea = true |
Definition at line 445 of file qgsdiagramrenderer.h.
QSizeF QgsDiagramSettings::size |
Definition at line 412 of file qgsdiagramrenderer.h.
QgsMapUnitScale QgsDiagramSettings::sizeScale |
Diagram size unit scale.
Definition at line 422 of file qgsdiagramrenderer.h.
Qgis::RenderUnit QgsDiagramSettings::sizeType = Qgis::RenderUnit::Millimeters |
Diagram size unit.
Definition at line 417 of file qgsdiagramrenderer.h.
StackedDiagramMode QgsDiagramSettings::stackedDiagramMode = QgsDiagramSettings::Horizontal |
Definition at line 439 of file qgsdiagramrenderer.h.