Class: QgsDiagramSettings¶

Stores the settings for rendering a single diagram.

QgsDiagramSettings stores the settings related to rendering the individual diagrams themselves, while QgsDiagramLayerSettings stores settings which control how ALL diagrams within a layer are rendered.

Methods

`axisLineSymbol`	Returns the line symbol to use for rendering axis in diagrams.
`direction`	Returns the chart's angular direction.
`legendItems`	Returns list of legend nodes for the diagram
`paintEffect`	Returns the paint effect to use while rendering diagrams.
`readXml`	Reads diagram settings from XML
`setAxisLineSymbol`	Sets the line symbol to use for rendering axis in diagrams.
`setDirection`	Sets the chart's angular direction.
`setPaintEffect`	Sets the paint effect to use while rendering diagrams.
`setShowAxis`	Sets whether the diagram axis should be shown.
`setSpacing`	Sets the spacing between diagram contents.
`setSpacingMapUnitScale`	Sets the map unit scale for the content spacing.
`setSpacingUnit`	Sets the unit for the content spacing.
`setStackedDiagramSpacing`	Sets the spacing between subdiagrams in a stacked diagram.
`setStackedDiagramSpacingMapUnitScale`	Sets the map unit scale for the spacing between subdiagrams in a stacked diagram.
`setStackedDiagramSpacingUnit`	Sets the unit for the spacing between subdiagrams in a stacked diagram.
`showAxis`	Returns `True` if the diagram axis should be shown.
`spacing`	Returns the spacing between diagram contents.
`spacingMapUnitScale`	Returns the map unit scale for the content spacing.
`spacingUnit`	Returns the units for the content spacing.
`stackedDiagramSpacing`	Returns the spacing between subdiagrams in a stacked diagram.
`stackedDiagramSpacingMapUnitScale`	Returns the map unit scale for the spacing between subdiagrams in a stacked diagram.
`stackedDiagramSpacingUnit`	Returns the units for the spacing between subdiagrams in a stacked diagram.
`writeXml`	Writes diagram settings to XML

Attributes

`Clockwise`
`Counterclockwise`
`Down`
`Height`
`Horizontal`
`Left`
`Right`
`Up`
`Vertical`
`XHeight`
`backgroundColor`
`barWidth`
`categoryAttributes`
`categoryColors`
`categoryLabels`
`diagramOrientation`
`enabled`
`font`
`labelPlacementMethod`
`lineSizeScale`	Line unit scale
`lineSizeUnit`	Line unit index
`maximumScale`	The maximum map scale (i.e. most "zoomed in" scale) at which the diagrams will be visible.
`minimumScale`	The minimum map scale (i.e. most "zoomed out" scale) at which the diagrams will be visible.
`minimumSize`	Scale diagrams smaller than mMinimumSize to mMinimumSize
`opacity`	Opacity, from 0 (transparent) to 1.0 (opaque)
`penColor`
`penWidth`
`rotationOffset`	Rotation offset, in degrees clockwise from horizontal.
`scaleBasedVisibility`
`scaleByArea`
`size`
`sizeScale`	Diagram size unit scale
`sizeType`	Diagram size unit
`stackedDiagramMode`

class qgis.core.QgsDiagramSettings[source]¶

Bases: object

Clockwise = 0¶

Counterclockwise = 1¶

class DiagramOrientation¶: Bases: int

class Direction¶: Bases: int

Down = 1¶

Height = 0¶

Horizontal = 0¶

class LabelPlacementMethod¶: Bases: int

Left = 2¶

Right = 3¶

class StackedDiagramMode¶: Bases: int

Up = 0¶

Vertical = 1¶

XHeight = 1¶

axisLineSymbol(self) → QgsLineSymbol | None[source]¶

Returns the line symbol to use for rendering axis in diagrams.

See also

setAxisLineSymbol()

See also

showAxis()

Added in version 3.12.

Return type:: Optional[QgsLineSymbol]

backgroundColor¶

barWidth¶

categoryAttributes¶

categoryColors¶

categoryLabels¶

diagramOrientation¶

direction(self) → QgsDiagramSettings.Direction[source]¶

Returns the chart’s angular direction.

See also

setDirection()

Added in version 3.12.

Return type:: QgsDiagramSettings.Direction

enabled¶

font¶

labelPlacementMethod¶

legendItems(self, nodeLayer: QgsLayerTreeLayer | None) → List[QgsLayerTreeModelLegendNode]¶

Returns list of legend nodes for the diagram

Note

caller is responsible for deletion of QgsLayerTreeModelLegendNodes

Parameters:: nodeLayer (Optional[QgsLayerTreeLayer])
Return type:: List[QgsLayerTreeModelLegendNode]

lineSizeScale¶: Line unit scale

lineSizeUnit¶: Line unit index

maximumScale¶: The maximum map scale (i.e. most “zoomed in” scale) at which the diagrams will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.

See also

minimumScale()

minimumScale¶: The minimum map scale (i.e. most “zoomed out” scale) at which the diagrams will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.

See also

maximumScale()