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.
- 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
See also
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
Added in version 3.12.
- Return type:
- 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:
- lineSizeScale: QgsMapUnitScale¶
- lineSizeUnit: RenderUnit¶
- maximumScale: float¶
- minimumScale: float¶
- minimumSize: float¶
- opacity: float¶
- paintEffect(self) QgsPaintEffect | None[source]¶
Returns the paint effect to use while rendering diagrams.
See also
Added in version 3.12.
- Return type:
Optional[QgsPaintEffect]
- penColor¶
- penWidth¶
- readXml(self, elem: QDomElement, context: QgsReadWriteContext = QgsReadWriteContext())[source]¶
Reads diagram settings from XML
- Parameters:
elem (QDomElement)
context (
QgsReadWriteContext= QgsReadWriteContext())
- rotationOffset: float¶
- scaleBasedVisibility¶
- scaleByArea¶
- setAxisLineSymbol(self, symbol: QgsLineSymbol | None)[source]¶
Sets the line
symbolto use for rendering axis in diagrams.Ownership of
symbolis transferred to the settings.See also
See also
Added in version 3.12.
- Parameters:
symbol (Optional[QgsLineSymbol])
- setDirection(self, direction: QgsDiagramSettings.Direction)[source]¶
Sets the chart’s angular
direction.See also
Added in version 3.12.
- Parameters:
direction (QgsDiagramSettings.Direction)
- setPaintEffect(self, effect: QgsPaintEffect | None)[source]¶
Sets the paint
effectto use while rendering diagrams.Ownership of
effectis transferred to the settings.See also
Added in version 3.12.
- Parameters:
effect (Optional[QgsPaintEffect])
- setShowAxis(self, showAxis: bool)[source]¶
Sets whether the diagram axis should be shown.
See also
See also
Added in version 3.12.
- Parameters:
showAxis (bool)
- setSpacing(self, spacing: float)[source]¶
Sets the
spacingbetween diagram contents.Spacing units are set via
setSpacingUnit().See also
See also
See also
Added in version 3.12.
- Parameters:
spacing (float)
- setSpacingMapUnitScale(self, scale: QgsMapUnitScale)[source]¶
Sets the map unit
scalefor the content spacing.See also
See also
See also
Added in version 3.12.
- Parameters:
scale (QgsMapUnitScale)
- setSpacingUnit(self, unit: Qgis.RenderUnit)[source]¶
Sets the
unitfor the content spacing.See also
See also
See also
Added in version 3.12.
- Parameters:
unit (Qgis.RenderUnit)
- setStackedDiagramSpacing(self, spacing: float)[source]¶
Sets the
spacingbetween subdiagrams in a stacked diagram.Spacing units are set via
setStackedDiagramSpacingUnit().See also
See also
Added in version 3.40.
- Parameters:
spacing (float)
- setStackedDiagramSpacingMapUnitScale(self, scale: QgsMapUnitScale)[source]¶
Sets the map unit
scalefor the spacing between subdiagrams in a stacked diagram.See also
See also
See also
Added in version 3.40.
- Parameters:
scale (QgsMapUnitScale)
- setStackedDiagramSpacingUnit(self, unit: Qgis.RenderUnit)[source]¶
Sets the
unitfor the spacing between subdiagrams in a stacked diagram.See also
See also
Added in version 3.40.
- Parameters:
unit (Qgis.RenderUnit)
- showAxis(self) bool[source]¶
Returns
Trueif the diagram axis should be shown.See also
See also
Added in version 3.12.
- Return type:
bool
- size¶
- sizeScale: QgsMapUnitScale¶
- sizeType: RenderUnit¶
- spacing(self) float[source]¶
Returns the spacing between diagram contents.
Spacing units can be retrieved by calling
spacingUnit().See also
See also
See also
Added in version 3.12.
- Return type:
float
- spacingMapUnitScale(self) QgsMapUnitScale¶
Returns the map unit scale for the content spacing.
See also
See also
See also
Added in version 3.12.
- Return type:
- spacingUnit(self) Qgis.RenderUnit[source]¶
Returns the units for the content spacing.
See also
See also
See also
Added in version 3.12.
- Return type:
- stackedDiagramMode¶
- stackedDiagramSpacing(self) float[source]¶
Returns the spacing between subdiagrams in a stacked diagram.
Spacing units can be retrieved by calling
stackedDiagramSpacingUnit().See also
See also
See also
Added in version 3.40.
- Return type:
float
- stackedDiagramSpacingMapUnitScale(self) QgsMapUnitScale¶
Returns the map unit scale for the spacing between subdiagrams in a stacked diagram.
See also
See also
See also
Added in version 3.40.
- Return type:
- stackedDiagramSpacingUnit(self) Qgis.RenderUnit[source]¶
Returns the units for the spacing between subdiagrams in a stacked diagram.
See also
See also
See also
Added in version 3.40.
- Return type:
- writeXml(self, rendererElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext())[source]¶
Writes diagram settings to XML
- Parameters:
rendererElem (QDomElement)
doc (QDomDocument)
context (
QgsReadWriteContext= QgsReadWriteContext())