QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | 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.
 
QString diagramName () const override
 Gets a descriptive name for this diagram type.
 
QSizeF diagramSize (const QgsAttributes &attributes, const QgsRenderContext &c, const QgsDiagramSettings &s) override
 Returns the size in map units the diagram will use to render.
 
QSizeF diagramSize (const QgsFeature &feature, const QgsRenderContext &c, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &interpolationSettings) override
 Returns the size in map units the diagram will use to render. Interpolate size.
 
double legendSize (double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &interpolationSettings) const override
 Returns the size of the legend item for the diagram corresponding to a specified value.
 
void renderDiagram (const QgsFeature &feature, QgsRenderContext &c, const QgsDiagramSettings &s, QPointF position) override
 Draws the diagram at the given position (in pixel coordinates)
 
- Public Member Functions inherited from QgsDiagram
virtual ~QgsDiagram ()
 
void clearCache ()
 
QgsExpressiongetExpression (const QString &expression, const QgsExpressionContext &context)
 Returns a prepared expression for the specified context.
 

Static Public Attributes

static const QString DIAGRAM_NAME_HISTOGRAM = QStringLiteral( "Histogram" )
 

Additional Inherited Members

- Protected Member Functions inherited from QgsDiagram
 QgsDiagram ()=default
 
 QgsDiagram (const QgsDiagram &other)
 
QFont scaledFont (const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a size to match the current settings and rendering context.
 
void setPenWidth (QPen &pen, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Changes the pen width to match the current settings and rendering context.
 
QSizeF sizeForValue (double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &interpolationSettings) const
 Returns the scaled size of a diagram for a value, respecting the specified diagram interpolation settings.
 
double sizePainterUnits (double l, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a length to match the current settings and rendering context.
 
QSizeF sizePainterUnits (QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c)
 Calculates a size to match the current settings and rendering context.
 

Detailed Description

A histogram style diagram.

Definition at line 38 of file qgshistogramdiagram.h.

Constructor & Destructor Documentation

◆ QgsHistogramDiagram()

QgsHistogramDiagram::QgsHistogramDiagram ( )

Definition at line 26 of file qgshistogramdiagram.cpp.

Member Function Documentation

◆ clone()

QgsHistogramDiagram * QgsHistogramDiagram::clone ( ) const
overridevirtual

Returns an instance that is equivalent to this one.

Implements QgsDiagram.

Definition at line 33 of file qgshistogramdiagram.cpp.

◆ diagramName()

QString QgsHistogramDiagram::diagramName ( ) const
overridevirtual

Gets a descriptive name for this diagram type.

Implements QgsDiagram.

Definition at line 115 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 120 of file qgshistogramdiagram.cpp.

◆ diagramSize() [2/2]

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

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

Implements QgsDiagram.

Definition at line 38 of file qgshistogramdiagram.cpp.

◆ legendSize()

double QgsHistogramDiagram::legendSize ( double  value,
const QgsDiagramSettings s,
const QgsDiagramInterpolationSettings interpolationSettings 
) 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
interpolationSettingsinterpolation settings

Implements QgsDiagram.

Definition at line 100 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 168 of file qgshistogramdiagram.cpp.

Member Data Documentation

◆ DIAGRAM_NAME_HISTOGRAM

const QString QgsHistogramDiagram::DIAGRAM_NAME_HISTOGRAM = QStringLiteral( "Histogram" )
static

Definition at line 41 of file qgshistogramdiagram.h.


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