Class: QgsDiagramSettings¶
- class qgis.core.QgsDiagramSettings¶
Bases:
sip.wrapper
Stores the settings for rendering a single diagram.
QgsDiagramSettings
stores the settings related to rendering the individual diagrams themselves, whileQgsDiagramLayerSettings
stores settings which control how ALL diagrams within a layer are rendered.QgsDiagramSettings() Constructor for QgsDiagramSettings
QgsDiagramSettings(other:
QgsDiagramSettings
) Copy constructorMethods
Returns the line symbol to use for rendering axis in diagrams.
Returns the chart's angular direction.
Returns list of legend nodes for the diagram
Returns the paint effect to use while rendering diagrams.
Reads diagram settings from XML
Sets the line
symbol
to use for rendering axis in diagrams.Sets the chart's angular
direction
.Sets the paint
effect
to use while rendering diagrams.Sets whether the diagram axis should be shown.
Sets the
spacing
between diagram contents.Sets the map unit
scale
for the content spacing.Sets the
unit
for the content spacing.Returns
True
if the diagram axis should be shown.Returns the spacing between diagram contents.
Returns the map unit scale for the content spacing.
Returns the units for the content spacing.
Writes diagram settings to XML
Attributes
- Clockwise = 0¶
- Counterclockwise = 1¶
- class DiagramOrientation¶
Bases:
int
- class Direction¶
Bases:
int
- Down = 1¶
- Height = 0¶
- class LabelPlacementMethod¶
Bases:
int
- Left = 2¶
- Right = 3¶
- Up = 0¶
- XHeight = 1¶
- axisLineSymbol(self) QgsLineSymbol ¶
Returns the line symbol to use for rendering axis in diagrams.
See also
See also
New in version 3.12.
- Return type
- backgroundColor¶
- barWidth¶
- categoryAttributes¶
- categoryColors¶
- categoryLabels¶
- diagramOrientation¶
- direction(self) QgsDiagramSettings.Direction ¶
Returns the chart’s angular direction.
See also
New in version 3.12.
- Return type
- enabled¶
- font¶
- labelPlacementMethod¶
- legendItems(self, nodeLayer: QgsLayerTreeLayer) List[QgsLayerTreeModelLegendNode] ¶
Returns list of legend nodes for the diagram
Note
caller is responsible for deletion of
QgsLayerTreeModelLegendNodes
New in version 2.10.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
- Return type
- lineSizeScale¶
- lineSizeUnit¶
- maximumScale¶
- minimumScale¶
- minimumSize¶
- opacity¶
- paintEffect(self) QgsPaintEffect ¶
Returns the paint effect to use while rendering diagrams.
See also
New in version 3.12.
- Return type
- penColor¶
- penWidth¶
- readXml(self, elem: QDomElement, context: QgsReadWriteContext = QgsReadWriteContext())¶
Reads diagram settings from XML
- Parameters
elem (QDomElement) –
context (
QgsReadWriteContext
= QgsReadWriteContext()) –
- rotationOffset¶
- scaleBasedVisibility¶
- scaleByArea¶
- setAxisLineSymbol(self, symbol: QgsLineSymbol)¶
Sets the line
symbol
to use for rendering axis in diagrams.Ownership of
symbol
is transferred to the settings.See also
See also
New in version 3.12.
- Parameters
symbol (QgsLineSymbol) –
- setDirection(self, direction: QgsDiagramSettings.Direction)¶
Sets the chart’s angular
direction
.See also
New in version 3.12.
- Parameters
direction (QgsDiagramSettings.Direction) –
- setPaintEffect(self, effect: QgsPaintEffect)¶
Sets the paint
effect
to use while rendering diagrams.Ownership of
effect
is transferred to the settings.See also
New in version 3.12.
- Parameters
effect (QgsPaintEffect) –
- setShowAxis(self, showAxis: bool)¶
Sets whether the diagram axis should be shown.
See also
See also
New in version 3.12.
- Parameters
showAxis (bool) –
- setSpacing(self, spacing: float)¶
Sets the
spacing
between diagram contents.Spacing units are set via
setSpacingUnit()
.See also
See also
See also
New in version 3.12.
- Parameters
spacing (float) –
- setSpacingMapUnitScale(self, scale: QgsMapUnitScale)¶
Sets the map unit
scale
for the content spacing.See also
See also
See also
New in version 3.12.
- Parameters
scale (QgsMapUnitScale) –
- setSpacingUnit(self, unit: QgsUnitTypes.RenderUnit)¶
Sets the
unit
for the content spacing.See also
See also
See also
New in version 3.12.
- Parameters
unit (QgsUnitTypes.RenderUnit) –
- showAxis(self) bool ¶
Returns
True
if the diagram axis should be shown.See also
See also
New in version 3.12.
- Return type
bool
- size¶
- sizeScale¶
- sizeType¶
- spacing(self) float ¶
Returns the spacing between diagram contents.
Spacing units can be retrieved by calling
spacingUnit()
.See also
See also
See also
New 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
New in version 3.12.
- Return type
- spacingUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the units for the content spacing.
See also
See also
See also
New in version 3.12.
- Return type
- writeXml(self, rendererElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext())¶
Writes diagram settings to XML
- Parameters
rendererElem (QDomElement) –
doc (QDomDocument) –
context (
QgsReadWriteContext
= QgsReadWriteContext()) –