Class: QgsDiagram

class qgis.core.QgsDiagram

Bases: sip.wrapper

Constructor for QgsDiagram.

QgsDiagram(other: QgsDiagram)

Base class for all diagram types*

Enums

Methods

clearCache
clone Returns an instance that is equivalent to this one
diagramName Gets a descriptive name for this diagram type.
diagramSize Returns the size in map units the diagram will use to render.
getExpression Returns a prepared expression for the specified context.
legendSize Returns the size of the legend item for the diagram corresponding to a specified value.
renderDiagram Draws the diagram at the given position (in pixel coordinates)
scaledFont Calculates a size to match the current settings and rendering context
setPenWidth Changes the pen width to match the current settings and rendering context
sizeForValue Returns the scaled size of a diagram for a value, respecting the specified diagram interpolation settings.
sizePainterUnits Calculates a size to match the current settings and rendering context

Signals

Attributes

clearCache(self)
clone(self) → QgsDiagram

Returns an instance that is equivalent to this one

New in version 2.4.

diagramName(self) → str

Gets a descriptive name for this diagram type.

diagramSize(self, attributes: object, c: QgsRenderContext, s: QgsDiagramSettings) → QSizeF

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

diagramSize(self, feature: QgsFeature, c: QgsRenderContext, s: QgsDiagramSettings, is_: QgsDiagramInterpolationSettings) -> QSizeF Returns the size in map units the diagram will use to render. Interpolate size

getExpression(self, expression: str, context: QgsExpressionContext) → QgsExpression

Returns a prepared expression for the specified context.

Parameters:
  • expression – expression string
  • context – expression context

New in version 2.12.

legendSize(self, value: float, s: QgsDiagramSettings, is_: QgsDiagramInterpolationSettings) → float

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

Parameters:
  • value – value to return legend item size for
  • s – diagram settings
  • is – interpolation settings

New in version 2.16.

renderDiagram(self, feature: QgsFeature, c: QgsRenderContext, s: QgsDiagramSettings, position: Union[QPointF, QPoint])

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

scaledFont(self, s: QgsDiagramSettings, c: QgsRenderContext) → QFont

Calculates a size to match the current settings and rendering context

Parameters:
  • s – The settings that contain the font size and size type
  • c – The rendering specifying the proper scale units for pixel conversion
Returns:

The properly scaled font for rendering

setPenWidth(self, pen: Union[QPen, QColor, Qt.GlobalColor, QGradient], s: QgsDiagramSettings, c: QgsRenderContext)

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

Parameters:
  • pen – The pen to modify
  • s – The settings that specify the pen width
  • c – The rendering specifying the proper scale units for pixel conversion
sizeForValue(self, value: float, s: QgsDiagramSettings, is_: QgsDiagramInterpolationSettings) → QSizeF

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

Parameters:
  • value – value to calculate corresponding circular size for
  • s – diagram settings
  • is – interpolation settings

New in version 2.16.

sizePainterUnits(self, size: QSizeF, s: QgsDiagramSettings, c: QgsRenderContext) → QSizeF

Calculates a size to match the current settings and rendering context

Parameters:
  • size – The size to convert
  • s – The settings that specify the size type
  • c – The rendering specifying the proper scale units for pixel conversion
Returns:

The converted size for rendering

sizePainterUnits(self, l: float, s: QgsDiagramSettings, c: QgsRenderContext) -> float Calculates a length to match the current settings and rendering context

Parameters:
  • l – The length to convert
  • s – Unused
  • c – The rendering specifying the proper scale units for pixel conversion
Returns:

The converted length for rendering