QGIS API Documentation  2.15.0-Master (5f66276)
Public Member Functions | Protected Member Functions | List of all members
QgsDiagram Class Referenceabstract

Base class for all diagram types. More...

#include <qgsdiagram.h>

Inheritance diagram for QgsDiagram:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsDiagram ()
 
void clearCache ()
 
virtual QgsDiagramclone () const =0
 Returns an instance that is equivalent to this one. More...
 
virtual QString diagramName () const =0
 
virtual QSizeF diagramSize (const QgsAttributes &attributes, const QgsRenderContext &c, const QgsDiagramSettings &s)=0
 Returns the size in map units the diagram will use to render. More...
 
virtual Q_DECL_DEPRECATED QSizeF diagramSize (const QgsAttributes &attributes, const QgsRenderContext &c, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is)
 
virtual QSizeF diagramSize (const QgsFeature &feature, const QgsRenderContext &c, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is)=0
 Returns the size in map units the diagram will use to render. More...
 
Q_DECL_DEPRECATED QgsExpressiongetExpression (const QString &expression, const QgsFields *fields)
 
QgsExpressiongetExpression (const QString &expression, const QgsExpressionContext &context)
 Returns a prepared expression for the specified context. More...
 
virtual double legendSize (double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is) const =0
 Returns the size of the legend item for the diagram corresponding to a specified value. More...
 
virtual Q_DECL_DEPRECATED void renderDiagram (const QgsAttributes &att, QgsRenderContext &c, const QgsDiagramSettings &s, QPointF position)
 
virtual void renderDiagram (const QgsFeature &feature, QgsRenderContext &c, const QgsDiagramSettings &s, QPointF position)=0
 Draws the diagram at the given position (in pixel coordinates) More...
 

Protected Member Functions

 QgsDiagram ()
 
 QgsDiagram (const QgsDiagram &other)
 
QFont scaledFont (const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a size to match the current settings and rendering context. More...
 
void setPenWidth (QPen &pen, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Changes the pen width to match the current settings and rendering context. More...
 
QSizeF sizeForValue (double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is) const
 Returns the scaled size of a diagram for a value, respecting the specified diagram interpolation settings. More...
 
QSizeF sizePainterUnits (QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a size to match the current settings and rendering context. More...
 
float sizePainterUnits (float l, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a length to match the current settings and rendering context. More...
 

Detailed Description

Base class for all diagram types.

Definition at line 35 of file qgsdiagram.h.

Constructor & Destructor Documentation

virtual QgsDiagram::~QgsDiagram ( )
inlinevirtual

Definition at line 38 of file qgsdiagram.h.

QgsDiagram::QgsDiagram ( )
protected

Definition at line 24 of file qgsdiagram.cpp.

QgsDiagram::QgsDiagram ( const QgsDiagram other)
protected

Definition at line 29 of file qgsdiagram.cpp.

Member Function Documentation

void QgsDiagram::clearCache ( )

Definition at line 36 of file qgsdiagram.cpp.

virtual QgsDiagram* QgsDiagram::clone ( ) const
pure virtual

Returns an instance that is equivalent to this one.

Note
added in 2.4

Implemented in QgsTextDiagram, QgsHistogramDiagram, and QgsPieDiagram.

virtual QString QgsDiagram::diagramName ( ) const
pure virtual
virtual QSizeF QgsDiagram::diagramSize ( const QgsAttributes attributes,
const QgsRenderContext c,
const QgsDiagramSettings s 
)
pure virtual

Returns the size in map units the diagram will use to render.

Implemented in QgsTextDiagram, QgsHistogramDiagram, and QgsPieDiagram.

QSizeF QgsDiagram::diagramSize ( const QgsAttributes attributes,
const QgsRenderContext c,
const QgsDiagramSettings s,
const QgsDiagramInterpolationSettings is 
)
virtual
virtual QSizeF QgsDiagram::diagramSize ( const QgsFeature feature,
const QgsRenderContext c,
const QgsDiagramSettings s,
const QgsDiagramInterpolationSettings is 
)
pure virtual

Returns the size in map units the diagram will use to render.

Interpolate size

Implemented in QgsTextDiagram, QgsHistogramDiagram, and QgsPieDiagram.

QgsExpression * QgsDiagram::getExpression ( const QString expression,
const QgsFields fields 
)
Deprecated:
use QgsExpressionContext variant instead

Definition at line 47 of file qgsdiagram.cpp.

QgsExpression * QgsDiagram::getExpression ( const QString expression,
const QgsExpressionContext context 
)

Returns a prepared expression for the specified context.

Parameters
expressionexpression string
contextexpression context
Note
added in QGIS 2.12

Definition at line 60 of file qgsdiagram.cpp.

virtual double QgsDiagram::legendSize ( double  value,
const QgsDiagramSettings s,
const QgsDiagramInterpolationSettings is 
) const
pure virtual

Returns the size of the legend item for the diagram corresponding to a specified value.

Parameters
valuevalue to return legend item size for
sdiagram settings
isinterpolation settings
Note
added in QGIS 2.16

Implemented in QgsTextDiagram, QgsHistogramDiagram, and QgsPieDiagram.

void QgsDiagram::renderDiagram ( const QgsAttributes att,
QgsRenderContext c,
const QgsDiagramSettings s,
QPointF  position 
)
virtual
Deprecated:
void renderDiagram( const QgsFeature& feature, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position ) should be used instead

Definition at line 148 of file qgsdiagram.cpp.

virtual void QgsDiagram::renderDiagram ( const QgsFeature feature,
QgsRenderContext c,
const QgsDiagramSettings s,
QPointF  position 
)
pure virtual

Draws the diagram at the given position (in pixel coordinates)

Implemented in QgsTextDiagram, QgsHistogramDiagram, and QgsPieDiagram.

QFont QgsDiagram::scaledFont ( const QgsDiagramSettings s,
const QgsRenderContext c 
)
protected

Calculates a size to match the current settings and rendering context.

Parameters
sThe settings that contain the font size and size type
cThe rendering specifying the proper scale units for pixel conversion
Returns
The properly scaled font for rendering

Definition at line 87 of file qgsdiagram.cpp.

void QgsDiagram::setPenWidth ( QPen pen,
const QgsDiagramSettings s,
const QgsRenderContext c 
)
protected

Changes the pen width to match the current settings and rendering context.

Parameters
penThe pen to modify
sThe settings that specify the pen width
cThe rendering specifying the proper scale units for pixel conversion

Definition at line 71 of file qgsdiagram.cpp.

QSizeF QgsDiagram::sizeForValue ( double  value,
const QgsDiagramSettings s,
const QgsDiagramInterpolationSettings is 
) const
protected

Returns the scaled size of a diagram for a value, respecting the specified diagram interpolation settings.

Parameters
valuevalue to calculate corresponding circular size for
sdiagram settings
isinterpolation settings
Note
added in QGIS 2.16

Definition at line 103 of file qgsdiagram.cpp.

QSizeF QgsDiagram::sizePainterUnits ( QSizeF  size,
const QgsDiagramSettings s,
const QgsRenderContext c 
)
protected

Calculates a size to match the current settings and rendering context.

Parameters
sizeThe size to convert
sThe settings that specify the size type
cThe rendering specifying the proper scale units for pixel conversion
Returns
The converted size for rendering

Definition at line 77 of file qgsdiagram.cpp.

float QgsDiagram::sizePainterUnits ( float  l,
const QgsDiagramSettings s,
const QgsRenderContext c 
)
protected

Calculates a length to match the current settings and rendering context.

Parameters
lThe length to convert
sUnused
cThe rendering specifying the proper scale units for pixel conversion
Returns
The converted length for rendering

Definition at line 82 of file qgsdiagram.cpp.


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