Class: Qgs2DXyPlot

Base class for 2-dimensional plot/chart/graphs with an X and Y axes.

The base class is responsible for rendering the axis, grid lines and chart area. Subclasses can implement the renderContent() method to render their actual plot content.

Warning

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

Added in version 3.26.

Class Hierarchy

Base classes

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

Subclasses

QgsBarChartPlot	A simple bar chart class.
QgsLineChartPlot	A simple line chart class.

Methods

applyDataDefinedProperties	Applies 2D XY plot data-defined properties
calculateOptimisedIntervals	Automatically sets the grid and label intervals to optimal values for display in the given render context.
chartBackgroundSymbol	Returns the fill symbol used to render the background of the chart.
chartBorderSymbol	Returns the symbol used to render the border of the chart.
setChartBackgroundSymbol	Sets the fill symbol used to render the background of the chart.
setChartBorderSymbol	Sets the symbol used to render the border of the chart.
setXMaximum	Sets the maximum value of the x axis.
setXMinimum	Sets the minimum value of the x axis.
setYMaximum	Sets the maximum value of the y axis.
setYMinimum	Sets the minimum value of the y axis.
xAxis	Returns a reference to the plot's x axis.
xMaximum	Returns the maximum value of the x axis.
xMinimum	Returns the minimum value of the x axis.
yAxis	Returns a reference to the plot's y axis.
yMaximum	Returns the maximum value of the y axis.
yMinimum	Returns the minimum value of the y axis.

class qgis.core.Qgs2DXyPlot

Bases: Qgs2DPlot

__init__()

Constructor for Qgs2DXyPlot.

applyDataDefinedProperties(self, context: QgsRenderContext)

Applies 2D XY plot data-defined properties

Parameters:

context (QgsRenderContext) -> (float)

calculateOptimisedIntervals(self, context: QgsRenderContext, plotContext: QgsPlotRenderContext)

Automatically sets the grid and label intervals to optimal values for display in the given render context.

Intervals will be calculated in order to avoid overlapping axis labels and to ensure round values are shown.

Parameters:

• context (QgsRenderContext)

• plotContext (QgsPlotRenderContext)

chartBackgroundSymbol(self) → QgsFillSymbol | None

Returns the fill symbol used to render the background of the chart.

See also

setChartBackgroundSymbol()

Return type:

Optional[QgsFillSymbol]

chartBorderSymbol(self) → QgsFillSymbol | None

Returns the symbol used to render the border of the chart.

See also

setChartBorderSymbol()

Return type:

Optional[QgsFillSymbol]

setChartBackgroundSymbol(self, symbol: QgsFillSymbol | None)

Sets the fill symbol used to render the background of the chart.

Ownership of symbol is transferred to the plot.

See also

chartBackgroundSymbol()

Parameters:

symbol (Optional[QgsFillSymbol])

setChartBorderSymbol(self, symbol: QgsFillSymbol | None)

Sets the symbol used to render the border of the chart.

Ownership of symbol is transferred to the plot.

See also

chartBorderSymbol()

Parameters:

symbol (Optional[QgsFillSymbol])

setXMaximum(self, maximum: float)

Sets the maximum value of the x axis.

See also

xMaximum()

Parameters:

maximum (float)

setXMinimum(self, minimum: float)

Sets the minimum value of the x axis.

See also

xMinimum()

Parameters:

minimum (float)

setYMaximum(self, maximum: float)

Sets the maximum value of the y axis.

See also

yMaximum()

Parameters:

maximum (float)

setYMinimum(self, minimum: float)

Sets the minimum value of the y axis.

See also

yMinimum()

Parameters:

minimum (float)

xAxis(self) → QgsPlotAxis

Returns a reference to the plot’s x axis.

See also

yAxis()

Return type:

QgsPlotAxis

xMaximum(self) → float

Returns the maximum value of the x axis.

See also

setXMaximum()

Return type:

float

xMinimum(self) → float

Returns the minimum value of the x axis.

See also

setXMinimum()

Return type:

float

yAxis(self) → QgsPlotAxis

Returns a reference to the plot’s y axis.

See also

xAxis()

Return type:

QgsPlotAxis

yMaximum(self) → float

Returns the maximum value of the y axis.

See also

setYMaximum()

Return type:

float

yMinimum(self) → float

Returns the minimum value of the y axis.

See also

setYMinimum()

Return type:

float