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.

List of all members, including inherited members

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.
`copyCommonProperties`	Copies all Qgs2DXyPlot-level properties (axis ranges, axes, flip state, background and border symbols) from other to this plot.
`flipAxes`	Returns whether the X and Y axes are flipped.
`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.
`setFlipAxes`	Sets whether the X and Y axes are flipped.
`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.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of Qgs2DXyPlot. See the FAQ for more details.

interiorPlotArea

Returns the area of the plot which corresponds to the actual plot content (excluding all titles and other components which sit outside the plot area).

class qgis.core.Qgs2DXyPlot[source]¶

Bases: Qgs2DPlot

__init__(): Constructor for Qgs2DXyPlot.

applyDataDefinedProperties(self, context: QgsRenderContext)[source]¶

Applies 2D XY plot data-defined properties

Parameters:: context (QgsRenderContext)
Return type:: (float, float, float, float, float, float, float, float, float, float)

calculateOptimisedIntervals(self, context: QgsRenderContext, plotContext: QgsPlotRenderContext)[source]¶

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[source]¶

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

See also

setChartBackgroundSymbol()

Return type:: Optional[QgsFillSymbol]

chartBorderSymbol(self) → QgsFillSymbol | None[source]¶

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

See also

setChartBorderSymbol()

Return type:: Optional[QgsFillSymbol]

copyCommonProperties(self, other: Qgs2DXyPlot | None)[source]¶

Copies all Qgs2DXyPlot-level properties (axis ranges, axes, flip state, background and border symbols) from other to this plot.

Added in version 4.0.

Parameters:: other (Optional[Qgs2DXyPlot])

flipAxes(self) → bool[source]¶

Returns whether the X and Y axes are flipped.

Return type:: bool

virtual interiorPlotArea(self, context: QgsRenderContext, plotContext: QgsPlotRenderContext, plotData: QgsPlotData = QgsPlotData()) → QRectF[source]¶

Returns the area of the plot which corresponds to the actual plot content (excluding all titles and other components which sit outside the plot area).

Parameters: