Class: QgsPieChartPlot

A simple pie chart class.

Warning

This class is not considered stable API, and may change in future!

Added in version 4.0.

Class Hierarchy

Base classes

Qgs2DPlot	Base class for 2-dimensional plot/chart/graphs.
QgsPlot	Base class for plot/chart/graphs.

class qgis.core.QgsPieChartPlot

Bases: Qgs2DPlot

colorRampAt(self, index: int) → QgsColorRamp | None

Returns the color ramp for the series with matching index.

Parameters:

index (int)

Return type:

Optional[QgsColorRamp]

colorRampCount(self) → int

Returns the color ramps list count.

Return type:

int

static create() → QgsPieChartPlot | None

Returns a new pie chart.

Return type:

Optional[QgsPieChartPlot]

static createDataGatherer(plot: QgsPlot | None) → QgsVectorLayerAbstractPlotDataGatherer | None

Returns a new data gatherer for a given pie chart plot.

Parameters:

plot (Optional[QgsPlot])

Return type:

Optional[QgsVectorLayerAbstractPlotDataGatherer]

fillSymbolAt(self, index: int) → QgsFillSymbol | None

Returns the fill symbol for the series with matching index.

Parameters:

index (int)

Return type:

Optional[QgsFillSymbol]

fillSymbolCount(self) → int

Returns the fill symbols list count.

Return type:

int

labelType(self) → Qgis.PieChartLabelType

Returns the pie chart label type.

Return type:

Qgis.PieChartLabelType

numericFormat(self) → QgsNumericFormat | None

Returns the numeric format used for the pie chart labels.

See also

setNumericFormat()

Return type:

Optional[QgsNumericFormat]

setColorRampAt(self, index: int, ramp: QgsColorRamp | None)

Sets the color ramp for the series with matching index.

Parameters:

• index (int)

• ramp (Optional[QgsColorRamp])

setFillSymbolAt(self, index: int, symbol: QgsFillSymbol | None)

Sets the fill symbol to use for the series with matching index.

Parameters:

• index (int)

• symbol (Optional[QgsFillSymbol])

setLabelType(self, type: Qgis.PieChartLabelType)

Sets the pie chart label type.

Parameters:

type (Qgis.PieChartLabelType)

setNumericFormat(self, format: QgsNumericFormat | None)

Sets the numeric format used for the pie chart labels.

Ownership of format is transferred to the plot.

See also

numericFormat()

Parameters:

format (Optional[QgsNumericFormat])

setTextFormat(self, format: QgsTextFormat)

Sets the text format used for the pie chart labels.

See also

textFormat()

Parameters:

format (QgsTextFormat)

textFormat(self) → QgsTextFormat

Returns the text format used for the pie chart labels.

See also

setTextFormat()

Return type:

QgsTextFormat