QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Types | Public Member Functions | Public Attributes | List of all members
QgsDiagramSettings Class Reference

Stores the settings for rendering a single diagram. More...

#include <qgsdiagramrendererv2.h>

Public Types

enum  DiagramOrientation { Up, Down, Left, Right }
 Orientation of histogram. More...
enum  LabelPlacementMethod { Height, XHeight }
enum  SizeType { MM, MapUnits }

Public Member Functions

 QgsDiagramSettings ()
QList< QgsLayerTreeModelLegendNode *> legendItems (QgsLayerTreeLayer *nodeLayer) const
 Returns list of legend nodes for the diagram. More...
void readXML (const QDomElement &elem, const QgsVectorLayer *layer)
void writeXML (QDomElement &rendererElem, QDomDocument &doc, const QgsVectorLayer *layer) const

Public Attributes

int angleOffset
QColor backgroundColor
double barWidth
QList< QStringcategoryAttributes
QList< QColorcategoryColors
QList< QStringcategoryLabels
DiagramOrientation diagramOrientation
bool enabled
QFont font
LabelPlacementMethod labelPlacementMethod
QgsMapUnitScale lineSizeScale
 Line unit scale. More...
QgsSymbolV2::OutputUnit lineSizeUnit
 Line unit index. More...
double maxScaleDenominator
double minimumSize
 Scale diagrams smaller than mMinimumSize to mMinimumSize. More...
double minScaleDenominator
QColor penColor
double penWidth
bool scaleBasedVisibility
bool scaleByArea
QSizeF size
QgsMapUnitScale sizeScale
 Diagram size unit scale. More...
QgsSymbolV2::OutputUnit sizeType
 Diagram size unit. More...
int transparency

Detailed Description

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 301 of file qgsdiagramrendererv2.h.

Member Enumeration Documentation

◆ DiagramOrientation

Orientation of histogram.


Definition at line 319 of file qgsdiagramrendererv2.h.

◆ LabelPlacementMethod


Definition at line 312 of file qgsdiagramrendererv2.h.

◆ SizeType

use QgsSymbolV2::OutputUnit instead

Definition at line 306 of file qgsdiagramrendererv2.h.

Constructor & Destructor Documentation

◆ QgsDiagramSettings()

QgsDiagramSettings::QgsDiagramSettings ( )

Definition at line 327 of file qgsdiagramrendererv2.h.

Member Function Documentation

◆ legendItems()

QList< QgsLayerTreeModelLegendNode *> QgsDiagramSettings::legendItems ( QgsLayerTreeLayer nodeLayer) const

Returns list of legend nodes for the diagram.

caller is responsible for deletion of QgsLayerTreeModelLegendNodes
added in 2.10

Definition at line 705 of file qgsdiagramrendererv2.cpp.

◆ readXML()

void QgsDiagramSettings::readXML ( const QDomElement elem,
const QgsVectorLayer layer 

Definition at line 165 of file qgsdiagramrendererv2.cpp.

◆ writeXML()

void QgsDiagramSettings::writeXML ( QDomElement rendererElem,
QDomDocument doc,
const QgsVectorLayer layer 
) const

Definition at line 300 of file qgsdiagramrendererv2.cpp.

Member Data Documentation

◆ angleOffset

int QgsDiagramSettings::angleOffset

Definition at line 378 of file qgsdiagramrendererv2.h.

◆ backgroundColor

QColor QgsDiagramSettings::backgroundColor

Definition at line 370 of file qgsdiagramrendererv2.h.

◆ barWidth

double QgsDiagramSettings::barWidth

Definition at line 375 of file qgsdiagramrendererv2.h.

◆ categoryAttributes

QList< QString > QgsDiagramSettings::categoryAttributes

Definition at line 346 of file qgsdiagramrendererv2.h.

◆ categoryColors

QList< QColor > QgsDiagramSettings::categoryColors

Definition at line 345 of file qgsdiagramrendererv2.h.

◆ categoryLabels

QList< QString > QgsDiagramSettings::categoryLabels
added in 2.10

Definition at line 348 of file qgsdiagramrendererv2.h.

◆ diagramOrientation

DiagramOrientation QgsDiagramSettings::diagramOrientation

Definition at line 374 of file qgsdiagramrendererv2.h.

◆ enabled

bool QgsDiagramSettings::enabled

Definition at line 343 of file qgsdiagramrendererv2.h.

◆ font

QFont QgsDiagramSettings::font

Definition at line 344 of file qgsdiagramrendererv2.h.

◆ labelPlacementMethod

LabelPlacementMethod QgsDiagramSettings::labelPlacementMethod

Definition at line 373 of file qgsdiagramrendererv2.h.

◆ lineSizeScale

QgsMapUnitScale QgsDiagramSettings::lineSizeScale

Line unit scale.

added in 2.16

Definition at line 368 of file qgsdiagramrendererv2.h.

◆ lineSizeUnit

QgsSymbolV2::OutputUnit QgsDiagramSettings::lineSizeUnit

Line unit index.

added in 2.16

Definition at line 363 of file qgsdiagramrendererv2.h.

◆ maxScaleDenominator

double QgsDiagramSettings::maxScaleDenominator

Definition at line 383 of file qgsdiagramrendererv2.h.

◆ minimumSize

double QgsDiagramSettings::minimumSize

Scale diagrams smaller than mMinimumSize to mMinimumSize.

Definition at line 386 of file qgsdiagramrendererv2.h.

◆ minScaleDenominator

double QgsDiagramSettings::minScaleDenominator

Definition at line 382 of file qgsdiagramrendererv2.h.

◆ penColor

QColor QgsDiagramSettings::penColor

Definition at line 371 of file qgsdiagramrendererv2.h.

◆ penWidth

double QgsDiagramSettings::penWidth

Definition at line 372 of file qgsdiagramrendererv2.h.

◆ scaleBasedVisibility

bool QgsDiagramSettings::scaleBasedVisibility

Definition at line 380 of file qgsdiagramrendererv2.h.

◆ scaleByArea

bool QgsDiagramSettings::scaleByArea

Definition at line 377 of file qgsdiagramrendererv2.h.

◆ size

QSizeF QgsDiagramSettings::size

Definition at line 349 of file qgsdiagramrendererv2.h.

◆ sizeScale

QgsMapUnitScale QgsDiagramSettings::sizeScale

Diagram size unit scale.

added in 2.16

Definition at line 358 of file qgsdiagramrendererv2.h.

◆ sizeType

QgsSymbolV2::OutputUnit QgsDiagramSettings::sizeType

Diagram size unit.

Definition at line 353 of file qgsdiagramrendererv2.h.

◆ transparency

int QgsDiagramSettings::transparency

Definition at line 376 of file qgsdiagramrendererv2.h.

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