QGIS API Documentation  2.99.0-Master (5169e0d)
Public Types | Public Member Functions | Public Attributes | List of all members
QgsDiagramSettings Class Reference

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  LabelPlacementMethod { Height, XHeight }
 

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< QString > categoryAttributes
 
QList< QColor > categoryColors
 
QList< QString > categoryLabels
 
DiagramOrientation diagramOrientation
 
bool enabled
 
QFont font
 
LabelPlacementMethod labelPlacementMethod
 
QgsMapUnitScale lineSizeScale
 Line unit scale. More...
 
QgsUnitTypes::RenderUnit 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...
 
QgsUnitTypes::RenderUnit 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 344 of file qgsdiagramrenderer.h.

Member Enumeration Documentation

◆ DiagramOrientation

Orientation of histogram.

Enumerator
Up 
Down 
Left 
Right 

Definition at line 355 of file qgsdiagramrenderer.h.

◆ LabelPlacementMethod

Enumerator
Height 
XHeight 

Definition at line 348 of file qgsdiagramrenderer.h.

Constructor & Destructor Documentation

◆ QgsDiagramSettings()

QgsDiagramSettings::QgsDiagramSettings ( )
inline

Definition at line 363 of file qgsdiagramrenderer.h.

Member Function Documentation

◆ legendItems()

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

Returns list of legend nodes for the diagram.

Note
caller is responsible for deletion of QgsLayerTreeModelLegendNodes
Since
QGIS 2.10

Definition at line 735 of file qgsdiagramrenderer.cpp.

◆ readXml()

void QgsDiagramSettings::readXml ( const QDomElement &  elem,
const QgsVectorLayer layer 
)

Definition at line 186 of file qgsdiagramrenderer.cpp.

◆ writeXml()

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

Definition at line 321 of file qgsdiagramrenderer.cpp.

Member Data Documentation

◆ angleOffset

int QgsDiagramSettings::angleOffset

Definition at line 414 of file qgsdiagramrenderer.h.

◆ backgroundColor

QColor QgsDiagramSettings::backgroundColor

Definition at line 406 of file qgsdiagramrenderer.h.

◆ barWidth

double QgsDiagramSettings::barWidth

Definition at line 411 of file qgsdiagramrenderer.h.

◆ categoryAttributes

QList< QString > QgsDiagramSettings::categoryAttributes

Definition at line 382 of file qgsdiagramrenderer.h.

◆ categoryColors

QList< QColor > QgsDiagramSettings::categoryColors

Definition at line 381 of file qgsdiagramrenderer.h.

◆ categoryLabels

QList< QString > QgsDiagramSettings::categoryLabels
Since
QGIS 2.10

Definition at line 384 of file qgsdiagramrenderer.h.

◆ diagramOrientation

DiagramOrientation QgsDiagramSettings::diagramOrientation

Definition at line 410 of file qgsdiagramrenderer.h.

◆ enabled

bool QgsDiagramSettings::enabled

Definition at line 379 of file qgsdiagramrenderer.h.

◆ font

QFont QgsDiagramSettings::font

Definition at line 380 of file qgsdiagramrenderer.h.

◆ labelPlacementMethod

LabelPlacementMethod QgsDiagramSettings::labelPlacementMethod

Definition at line 409 of file qgsdiagramrenderer.h.

◆ lineSizeScale

QgsMapUnitScale QgsDiagramSettings::lineSizeScale

Line unit scale.

Since
QGIS 2.16

Definition at line 404 of file qgsdiagramrenderer.h.

◆ lineSizeUnit

QgsUnitTypes::RenderUnit QgsDiagramSettings::lineSizeUnit

Line unit index.

Since
QGIS 2.16

Definition at line 399 of file qgsdiagramrenderer.h.

◆ maxScaleDenominator

double QgsDiagramSettings::maxScaleDenominator

Definition at line 419 of file qgsdiagramrenderer.h.

◆ minimumSize

double QgsDiagramSettings::minimumSize

Scale diagrams smaller than mMinimumSize to mMinimumSize.

Definition at line 422 of file qgsdiagramrenderer.h.

◆ minScaleDenominator

double QgsDiagramSettings::minScaleDenominator

Definition at line 418 of file qgsdiagramrenderer.h.

◆ penColor

QColor QgsDiagramSettings::penColor

Definition at line 407 of file qgsdiagramrenderer.h.

◆ penWidth

double QgsDiagramSettings::penWidth

Definition at line 408 of file qgsdiagramrenderer.h.

◆ scaleBasedVisibility

bool QgsDiagramSettings::scaleBasedVisibility

Definition at line 416 of file qgsdiagramrenderer.h.

◆ scaleByArea

bool QgsDiagramSettings::scaleByArea

Definition at line 413 of file qgsdiagramrenderer.h.

◆ size

QSizeF QgsDiagramSettings::size

Definition at line 385 of file qgsdiagramrenderer.h.

◆ sizeScale

QgsMapUnitScale QgsDiagramSettings::sizeScale

Diagram size unit scale.

Since
QGIS 2.16

Definition at line 394 of file qgsdiagramrenderer.h.

◆ sizeType

QgsUnitTypes::RenderUnit QgsDiagramSettings::sizeType

Diagram size unit.

Definition at line 389 of file qgsdiagramrenderer.h.

◆ transparency

int QgsDiagramSettings::transparency

Definition at line 412 of file qgsdiagramrenderer.h.


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