QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
QgsTextDiagram Class Reference

A text based diagram. More...

#include <qgstextdiagram.h>

Inheritance diagram for QgsTextDiagram:

Public Types

enum  Orientation { Horizontal = 0 , Vertical }
enum  Shape { Circle = 0 , Rectangle , Triangle }

Public Member Functions

 QgsTextDiagram ()
QgsTextDiagramclone () 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_TEXT = QStringLiteral( "Text" )

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 text based diagram.

Definition at line 37 of file qgstextdiagram.h.

Member Enumeration Documentation

◆ Orientation

Enumerator
Horizontal 
Vertical 

Definition at line 49 of file qgstextdiagram.h.

◆ Shape

Enumerator
Circle 
Rectangle 
Triangle 

Definition at line 42 of file qgstextdiagram.h.

Constructor & Destructor Documentation

◆ QgsTextDiagram()

QgsTextDiagram::QgsTextDiagram ( )

Definition at line 25 of file qgstextdiagram.cpp.

Member Function Documentation

◆ clone()

QgsTextDiagram * QgsTextDiagram::clone ( ) const
overridevirtual

Returns an instance that is equivalent to this one.

Implements QgsDiagram.

Definition at line 33 of file qgstextdiagram.cpp.

◆ diagramName()

QString QgsTextDiagram::diagramName ( ) const
overridevirtual

Gets a descriptive name for this diagram type.

Implements QgsDiagram.

Definition at line 72 of file qgstextdiagram.cpp.

◆ diagramSize() [1/2]

QSizeF QgsTextDiagram::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 77 of file qgstextdiagram.cpp.

◆ diagramSize() [2/2]

QSizeF QgsTextDiagram::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 qgstextdiagram.cpp.

◆ legendSize()

double QgsTextDiagram::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 66 of file qgstextdiagram.cpp.

◆ renderDiagram()

void QgsTextDiagram::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 85 of file qgstextdiagram.cpp.

Member Data Documentation

◆ DIAGRAM_NAME_TEXT

const QString QgsTextDiagram::DIAGRAM_NAME_TEXT = QStringLiteral( "Text" )
static

Definition at line 40 of file qgstextdiagram.h.


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