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

#include <qgsplot.h>

Inheritance diagram for Qgs2DXyPlot:

[legend]

Public Member Functions
	Qgs2DXyPlot ()
	Constructor for Qgs2DXyPlot.
	Qgs2DXyPlot (const Qgs2DXyPlot &other)=delete
	~Qgs2DXyPlot () override
void	calculateOptimisedIntervals (QgsRenderContext &context, QgsPlotRenderContext &plotContext)
	Automatically sets the grid and label intervals to optimal values for display in the given render context.
QgsFillSymbol *	chartBackgroundSymbol ()
	Returns the fill symbol used to render the background of the chart.
const QgsFillSymbol *	chartBackgroundSymbol () const
	Returns the fill symbol used to render the background of the chart.
QgsFillSymbol *	chartBorderSymbol ()
	Returns the symbol used to render the border of the chart.
const QgsFillSymbol *	chartBorderSymbol () const
	Returns the symbol used to render the border of the chart.
void	copyCommonProperties (const Qgs2DXyPlot *other)
	Copies all Qgs2DXyPlot-level properties (axis ranges, axes, flip state, background and border symbols) from other to this plot.
bool	flipAxes () const
	Returns whether the X and Y axes are flipped.
QRectF	interiorPlotArea (QgsRenderContext &context, QgsPlotRenderContext &plotContext, const QgsPlotData &plotData=QgsPlotData()) const override
	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).
Qgs2DXyPlot &	operator= (const Qgs2DXyPlot &other)=delete
bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads the plot's properties from an XML element.
void	render (QgsRenderContext &context, QgsPlotRenderContext &plotContext, const QgsPlotData &plotData=QgsPlotData()) override
	Renders the plot.
void	setChartBackgroundSymbol (QgsFillSymbol *symbol)
	Sets the fill symbol used to render the background of the chart.
void	setChartBorderSymbol (QgsFillSymbol *symbol)
	Sets the symbol used to render the border of the chart.
void	setFlipAxes (bool flipAxes)
	Sets whether the X and Y axes are flipped.
void	setXMaximum (double maximum)
	Sets the maximum value of the x axis.
void	setXMinimum (double minimum)
	Sets the minimum value of the x axis.
void	setYMaximum (double maximum)
	Sets the maximum value of the y axis.
void	setYMinimum (double minimum)
	Sets the minimum value of the y axis.
bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
	Writes the plot's properties into an XML element.
QgsPlotAxis &	xAxis ()
	Returns a reference to the plot's x axis.
const QgsPlotAxis &	xAxis () const
	Returns a reference to the plot's x axis.
double	xMaximum () const
	Returns the maximum value of the x axis.
double	xMinimum () const
	Returns the minimum value of the x axis.
QgsPlotAxis &	yAxis ()
	Returns a reference to the plot's y axis.
const QgsPlotAxis &	yAxis () const
	Returns a reference to the plot's y axis.
double	yMaximum () const
	Returns the maximum value of the y axis.
double	yMinimum () const
	Returns the minimum value of the y axis.
Public Member Functions inherited from Qgs2DPlot
	Qgs2DPlot ()
	Constructor for Qgs2DPlot.
	Qgs2DPlot (const Qgs2DPlot &other)=delete
	~Qgs2DPlot () override
void	copyCommonProperties (const Qgs2DPlot *other)
	Copies all Qgs2DPlot-level properties (size, margins, data-defined properties) from other to this plot.
const QgsMargins &	margins () const
	Returns the margins of the plot area (in millimeters).
Qgs2DPlot &	operator= (const Qgs2DPlot &other)=delete
virtual void	renderContent (QgsRenderContext &context, QgsPlotRenderContext &plotContext, const QRectF &plotArea, const QgsPlotData &plotData=QgsPlotData())
	Renders the plot content.
void	setMargins (const QgsMargins &margins)
	Sets the margins of the plot area (in millimeters).
void	setSize (QSizeF size)
	Sets the overall size of the plot (including titles and over components which sit outside the plot area).
QSizeF	size () const
	Returns the overall size of the plot (in millimeters) (including titles and other components which sit outside the plot area).
Public Member Functions inherited from QgsPlot
	QgsPlot ()=default
virtual	~QgsPlot ()
QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the plot's property collection, used for data defined overrides.
const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the plot's property collection, used for data defined overrides.
virtual void	initFromPlot (const QgsPlot *plot)
	Initializes properties of this plot from an existing plot, transferring all applicable settings.
void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the plot's property collection, used for data defined overrides.
void	setDataDefinedProperty (DataDefinedProperty key, const QgsProperty &property)
	Sets a data defined property for the plot.
virtual QString	type () const
	Returns the plot's type.

Protected Member Functions
void	applyDataDefinedProperties (QgsRenderContext &context, double &minX, double &maxX, double &minY, double &maxY, double &majorIntervalX, double &minorIntervalX, double &labelIntervalX, double &majorIntervalY, double &minorIntervalY, double &labelIntervalY) const
	Applies 2D XY plot data-defined properties.
Protected Member Functions inherited from Qgs2DPlot
void	applyDataDefinedProperties (QgsRenderContext &context, QgsMargins &margins) const
	Applies 2D plot data-defined properties.

Additional Inherited Members
Public Types inherited from QgsPlot
enum class	DataDefinedProperty : int { MarginLeft , MarginTop , MarginRight , MarginBottom , XAxisMajorInterval , XAxisMinorInterval , XAxisLabelInterval , YAxisMajorInterval , YAxisMinorInterval , YAxisLabelInterval , XAxisMinimum , XAxisMaximum , YAxisMinimum , YAxisMaximum }
	Data defined properties for different plot types. More...
Static Public Member Functions inherited from QgsPlot
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the plot property definitions.
Protected Attributes inherited from QgsPlot
QgsPropertyCollection	mDataDefinedProperties

Detailed Description

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!

Since: QGIS 3.26

Definition at line 686 of file qgsplot.h.

Constructor & Destructor Documentation

◆ Qgs2DXyPlot() [1/2]

Qgs2DXyPlot::Qgs2DXyPlot ( )

Constructor for Qgs2DXyPlot.

Definition at line 414 of file qgsplot.cpp.

◆ ~Qgs2DXyPlot()

Qgs2DXyPlot::~Qgs2DXyPlot ( )

overridedefault

◆ Qgs2DXyPlot() [2/2]

Qgs2DXyPlot::Qgs2DXyPlot ( const Qgs2DXyPlot & other )

delete

Member Function Documentation

◆ applyDataDefinedProperties()

void Qgs2DXyPlot::applyDataDefinedProperties	(	QgsRenderContext &	context,
		double &	minX,
		double &	maxX,
		double &	minY,
		double &	maxY,
		double &	majorIntervalX,
		double &	minorIntervalX,
		double &	labelIntervalX,
		double &	majorIntervalY,
		double &	minorIntervalY,
		double &	labelIntervalY ) const

protected

Applies 2D XY plot data-defined properties.

Definition at line 1229 of file qgsplot.cpp.

◆ calculateOptimisedIntervals()

void Qgs2DXyPlot::calculateOptimisedIntervals	(	QgsRenderContext &	context,
		QgsPlotRenderContext &	plotContext )

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.

Definition at line 1042 of file qgsplot.cpp.

◆ chartBackgroundSymbol() [1/2]

QgsFillSymbol * Qgs2DXyPlot::chartBackgroundSymbol ( )

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

See also: setChartBackgroundSymbol()

Definition at line 1194 of file qgsplot.cpp.

◆ chartBackgroundSymbol() [2/2]

const QgsFillSymbol * Qgs2DXyPlot::chartBackgroundSymbol ( ) const

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

See also: setChartBackgroundSymbol()

Note: not available in Python bindings

Definition at line 1199 of file qgsplot.cpp.

◆ chartBorderSymbol() [1/2]

QgsFillSymbol * Qgs2DXyPlot::chartBorderSymbol ( )

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

See also: setChartBorderSymbol()

Definition at line 1209 of file qgsplot.cpp.

◆ chartBorderSymbol() [2/2]

const QgsFillSymbol * Qgs2DXyPlot::chartBorderSymbol ( ) const

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

See also: setChartBorderSymbol()

Note: not available in Python bindings

Definition at line 1214 of file qgsplot.cpp.

◆ copyCommonProperties()

void Qgs2DXyPlot::copyCommonProperties ( const Qgs2DXyPlot * other )

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

Since: QGIS 4.0

Definition at line 1350 of file qgsplot.cpp.

◆ flipAxes()

bool Qgs2DXyPlot::flipAxes ( ) const

inline

Returns whether the X and Y axes are flipped.

Definition at line 856 of file qgsplot.h.

◆ interiorPlotArea()

QRectF Qgs2DXyPlot::interiorPlotArea	(	QgsRenderContext &	context,
		QgsPlotRenderContext &	plotContext,
		const QgsPlotData &	plotData = QgsPlotData() ) const

overridevirtual

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).

Reimplemented from Qgs2DPlot.

Definition at line 871 of file qgsplot.cpp.

◆ operator=()

Qgs2DXyPlot & Qgs2DXyPlot::operator= ( const Qgs2DXyPlot & other )

delete

◆ readXml()

bool Qgs2DXyPlot::readXml	(	const QDomElement &	element,
		const QgsReadWriteContext &	context )

overridevirtual

Reads the plot's properties from an XML element.

Reimplemented from Qgs2DPlot.

Reimplemented in QgsBarChartPlot, and QgsLineChartPlot.

Definition at line 450 of file qgsplot.cpp.

◆ render()

void Qgs2DXyPlot::render	(	QgsRenderContext &	context,
		QgsPlotRenderContext &	plotContext,
		const QgsPlotData &	plotData = QgsPlotData() )

overridevirtual

Renders the plot.

Reimplemented from Qgs2DPlot.

Definition at line 474 of file qgsplot.cpp.

◆ setChartBackgroundSymbol()

void Qgs2DXyPlot::setChartBackgroundSymbol ( QgsFillSymbol * symbol )

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

Ownership of symbol is transferred to the plot.

See also: chartBackgroundSymbol()

Definition at line 1204 of file qgsplot.cpp.

◆ setChartBorderSymbol()

void Qgs2DXyPlot::setChartBorderSymbol ( QgsFillSymbol * symbol )

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

Ownership of symbol is transferred to the plot.

See also: chartBorderSymbol()

Definition at line 1219 of file qgsplot.cpp.

◆ setFlipAxes()

void Qgs2DXyPlot::setFlipAxes ( bool flipAxes )

Sets whether the X and Y axes are flipped.

Definition at line 1224 of file qgsplot.cpp.

◆ setXMaximum()

void Qgs2DXyPlot::setXMaximum ( double maximum )

inline

Sets the maximum value of the x axis.

See also: xMaximum()

Definition at line 762 of file qgsplot.h.

◆ setXMinimum()

void Qgs2DXyPlot::setXMinimum ( double minimum )

inline

Sets the minimum value of the x axis.

See also: xMinimum()

Definition at line 734 of file qgsplot.h.

◆ setYMaximum()

void Qgs2DXyPlot::setYMaximum ( double maximum )

inline

Sets the maximum value of the y axis.

See also: yMaximum()

Definition at line 776 of file qgsplot.h.

◆ setYMinimum()

void Qgs2DXyPlot::setYMinimum ( double minimum )

inline

Sets the minimum value of the y axis.

See also: yMinimum()

Definition at line 748 of file qgsplot.h.

◆ writeXml()

bool Qgs2DXyPlot::writeXml	(	QDomElement &	element,
		QDomDocument &	document,
		const QgsReadWriteContext &	context ) const

overridevirtual

Writes the plot's properties into an XML element.

Reimplemented from Qgs2DPlot.

Reimplemented in QgsBarChartPlot, and QgsLineChartPlot.

Definition at line 422 of file qgsplot.cpp.

◆ xAxis() [1/2]

QgsPlotAxis & Qgs2DXyPlot::xAxis ( )

inline

Returns a reference to the plot's x axis.

See also: yAxis()

Definition at line 783 of file qgsplot.h.

◆ xAxis() [2/2]

const QgsPlotAxis & Qgs2DXyPlot::xAxis ( ) const

inline

Returns a reference to the plot's x axis.

See also: yAxis()

Definition at line 790 of file qgsplot.h.

◆ xMaximum()

double Qgs2DXyPlot::xMaximum ( ) const

inline

Returns the maximum value of the x axis.

See also: setXMaximum()

Definition at line 755 of file qgsplot.h.

◆ xMinimum()

double Qgs2DXyPlot::xMinimum ( ) const

inline

Returns the minimum value of the x axis.

See also: setXMinimum()

Definition at line 727 of file qgsplot.h.

◆ yAxis() [1/2]

QgsPlotAxis & Qgs2DXyPlot::yAxis ( )

inline

Returns a reference to the plot's y axis.

See also: xAxis()

Definition at line 797 of file qgsplot.h.

◆ yAxis() [2/2]

const QgsPlotAxis & Qgs2DXyPlot::yAxis ( ) const

inline

Returns a reference to the plot's y axis.

See also: xAxis()

Definition at line 804 of file qgsplot.h.

◆ yMaximum()

double Qgs2DXyPlot::yMaximum ( ) const

inline

Returns the maximum value of the y axis.

See also: setYMaximum()

Definition at line 769 of file qgsplot.h.

◆ yMinimum()

double Qgs2DXyPlot::yMinimum ( ) const

inline

Returns the minimum value of the y axis.

See also: setYMinimum()

Definition at line 741 of file qgsplot.h.

The documentation for this class was generated from the following files:

/build/qgis-4.0.0+99sid/src/core/plot/qgsplot.h
/build/qgis-4.0.0+99sid/src/core/plot/qgsplot.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Qgs2DXyPlot() [1/2]

◆ ~Qgs2DXyPlot()

◆ Qgs2DXyPlot() [2/2]

Member Function Documentation

◆ applyDataDefinedProperties()

◆ calculateOptimisedIntervals()

◆ chartBackgroundSymbol() [1/2]

◆ chartBackgroundSymbol() [2/2]

◆ chartBorderSymbol() [1/2]

◆ chartBorderSymbol() [2/2]

◆ copyCommonProperties()

◆ flipAxes()

◆ interiorPlotArea()

◆ operator=()

◆ readXml()

◆ render()

◆ setChartBackgroundSymbol()

◆ setChartBorderSymbol()

◆ setFlipAxes()

◆ setXMaximum()

◆ setXMinimum()

◆ setYMaximum()

◆ setYMinimum()

◆ writeXml()

◆ xAxis() [1/2]

◆ xAxis() [2/2]

◆ xMaximum()

◆ xMinimum()

◆ yAxis() [1/2]

◆ yAxis() [2/2]

◆ yMaximum()

◆ yMinimum()