QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | List of all members
QgsHistogramDiagram Class Reference

A histogram style diagram. More...

#include <qgshistogramdiagram.h>

Inheritance diagram for QgsHistogramDiagram:
Inheritance graph
[legend]

Public Member Functions

 QgsHistogramDiagram ()
 
QgsHistogramDiagramclone () const override
 Returns an instance that is equivalent to this one. More...
 
QString diagramName () const override
 Gets a descriptive name for this diagram type. More...
 
QSizeF diagramSize (const QgsAttributes &attributes, const QgsRenderContext &c, const QgsDiagramSettings &s) override
 Returns the size in map units the diagram will use to render. More...
 
QSizeF diagramSize (const QgsFeature &feature, const QgsRenderContext &c, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is) override
 Returns the size in map units the diagram will use to render. Interpolate size. More...
 
double legendSize (double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is) const override
 Returns the size of the legend item for the diagram corresponding to a specified value. More...
 
void renderDiagram (const QgsFeature &feature, QgsRenderContext &c, const QgsDiagramSettings &s, QPointF position) override
 Draws the diagram at the given position (in pixel coordinates) More...
 
- Public Member Functions inherited from QgsDiagram
virtual ~QgsDiagram ()
 
void clearCache ()
 
virtual QgsDiagramclone () const =0
 Returns an instance that is equivalent to this one. More...
 
virtual QString diagramName () const =0
 Gets a descriptive name for this diagram type. More...
 
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 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. Interpolate size. More...
 
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 void renderDiagram (const QgsFeature &feature, QgsRenderContext &c, const QgsDiagramSettings &s, QPointF position)=0
 Draws the diagram at the given position (in pixel coordinates) More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsDiagram
 QgsDiagram ()=default
 Constructor for QgsDiagram. More...
 
 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...
 
double sizePainterUnits (double l, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a length to match the current settings and rendering context. More...
 
QSizeF sizePainterUnits (QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a size to match the current settings and rendering context. More...
 

Detailed Description

A histogram style diagram.

Definition at line 40 of file qgshistogramdiagram.h.

Constructor & Destructor Documentation

◆ QgsHistogramDiagram()

QgsHistogramDiagram::QgsHistogramDiagram ( )

Definition at line 24 of file qgshistogramdiagram.cpp.

Member Function Documentation

◆ clone()

QgsHistogramDiagram * QgsHistogramDiagram::clone ( ) const
overridevirtual

Returns an instance that is equivalent to this one.

Since
QGIS 2.4

Implements QgsDiagram.

Definition at line 31 of file qgshistogramdiagram.cpp.

◆ diagramName()

QString QgsHistogramDiagram::diagramName ( ) const
overridevirtual

Gets a descriptive name for this diagram type.

Implements QgsDiagram.

Definition at line 113 of file qgshistogramdiagram.cpp.

◆ diagramSize() [1/2]

QSizeF QgsHistogramDiagram::diagramSize ( const QgsAttributes attributes,
const QgsRenderContext c,
const QgsDiagramSettings s 
)
overridevirtual

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

Implements QgsDiagram.

Definition at line 118 of file qgshistogramdiagram.cpp.

◆ diagramSize() [2/2]

QSizeF QgsHistogramDiagram::diagramSize ( const QgsFeature feature,
const QgsRenderContext c,
const QgsDiagramSettings s,
const QgsDiagramInterpolationSettings is 
)
overridevirtual

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

Implements QgsDiagram.

Definition at line 36 of file qgshistogramdiagram.cpp.

◆ legendSize()

double QgsHistogramDiagram::legendSize ( double  value,
const QgsDiagramSettings s,
const QgsDiagramInterpolationSettings is 
) const
overridevirtual

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
Since
QGIS 2.16

Implements QgsDiagram.

Definition at line 98 of file qgshistogramdiagram.cpp.

◆ renderDiagram()

void QgsHistogramDiagram::renderDiagram ( const QgsFeature feature,
QgsRenderContext c,
const QgsDiagramSettings s,
QPointF  position 
)
overridevirtual

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

Implements QgsDiagram.

Definition at line 167 of file qgshistogramdiagram.cpp.


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