QGIS API Documentation  2.15.0-Master (94d88e6)
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

Orientation of histogram.

Enumerator
Up 
Down 
Left 
Right 

Definition at line 319 of file qgsdiagramrendererv2.h.

Enumerator
Height 
XHeight 

Definition at line 312 of file qgsdiagramrendererv2.h.

Deprecated:
use QgsSymbolV2::OutputUnit instead
Enumerator
MM 
MapUnits 

Definition at line 306 of file qgsdiagramrendererv2.h.

Constructor & Destructor Documentation

QgsDiagramSettings::QgsDiagramSettings ( )
inline

Definition at line 327 of file qgsdiagramrendererv2.h.

Member Function Documentation

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

Returns list of legend nodes for the diagram.

Note
caller is responsible for deletion of QgsLayerTreeModelLegendNodes
added in 2.10

Definition at line 705 of file qgsdiagramrendererv2.cpp.

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

Definition at line 165 of file qgsdiagramrendererv2.cpp.

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

Definition at line 300 of file qgsdiagramrendererv2.cpp.

Member Data Documentation

int QgsDiagramSettings::angleOffset

Definition at line 378 of file qgsdiagramrendererv2.h.

QColor QgsDiagramSettings::backgroundColor

Definition at line 370 of file qgsdiagramrendererv2.h.

double QgsDiagramSettings::barWidth

Definition at line 375 of file qgsdiagramrendererv2.h.

QList< QString > QgsDiagramSettings::categoryAttributes

Definition at line 346 of file qgsdiagramrendererv2.h.

QList< QColor > QgsDiagramSettings::categoryColors

Definition at line 345 of file qgsdiagramrendererv2.h.

QList< QString > QgsDiagramSettings::categoryLabels
Note
added in 2.10

Definition at line 348 of file qgsdiagramrendererv2.h.

DiagramOrientation QgsDiagramSettings::diagramOrientation

Definition at line 374 of file qgsdiagramrendererv2.h.

bool QgsDiagramSettings::enabled

Definition at line 343 of file qgsdiagramrendererv2.h.

QFont QgsDiagramSettings::font

Definition at line 344 of file qgsdiagramrendererv2.h.

LabelPlacementMethod QgsDiagramSettings::labelPlacementMethod

Definition at line 373 of file qgsdiagramrendererv2.h.

QgsMapUnitScale QgsDiagramSettings::lineSizeScale

Line unit scale.

Note
added in 2.16

Definition at line 368 of file qgsdiagramrendererv2.h.

QgsSymbolV2::OutputUnit QgsDiagramSettings::lineSizeUnit

Line unit index.

Note
added in 2.16

Definition at line 363 of file qgsdiagramrendererv2.h.

double QgsDiagramSettings::maxScaleDenominator

Definition at line 383 of file qgsdiagramrendererv2.h.

double QgsDiagramSettings::minimumSize

Scale diagrams smaller than mMinimumSize to mMinimumSize.

Definition at line 386 of file qgsdiagramrendererv2.h.

double QgsDiagramSettings::minScaleDenominator

Definition at line 382 of file qgsdiagramrendererv2.h.

QColor QgsDiagramSettings::penColor

Definition at line 371 of file qgsdiagramrendererv2.h.

double QgsDiagramSettings::penWidth

Definition at line 372 of file qgsdiagramrendererv2.h.

bool QgsDiagramSettings::scaleBasedVisibility

Definition at line 380 of file qgsdiagramrendererv2.h.

bool QgsDiagramSettings::scaleByArea

Definition at line 377 of file qgsdiagramrendererv2.h.

QSizeF QgsDiagramSettings::size

Definition at line 349 of file qgsdiagramrendererv2.h.

QgsMapUnitScale QgsDiagramSettings::sizeScale

Diagram size unit scale.

Note
added in 2.16

Definition at line 358 of file qgsdiagramrendererv2.h.

QgsSymbolV2::OutputUnit QgsDiagramSettings::sizeType

Diagram size unit.

Definition at line 353 of file qgsdiagramrendererv2.h.

int QgsDiagramSettings::transparency

Definition at line 376 of file qgsdiagramrendererv2.h.


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