Base class for 2-dimensional plot/chart/graphs. More...

#include <qgsplot.h>

Inheritance diagram for Qgs2DPlot:

Public Member Functions
	Qgs2DPlot ()
	Constructor for Qgs2DPlot.

	Qgs2DPlot (const Qgs2DPlot &other)=delete

	~Qgs2DPlot () override

void	calculateOptimisedIntervals (QgsRenderContext &context)
	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.

QgsFillSymbol *	chartBorderSymbol ()
	Returns the symbol used to render the border of the chart.

QRectF	interiorPlotArea (QgsRenderContext &context) const
	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).

const QgsMargins &	margins () const
	Returns the margins of the plot area (in millimeters)

Qgs2DPlot &	operator= (const Qgs2DPlot &other)=delete

bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads the plot's properties from an XML element.

void	render (QgsRenderContext &context)
	Renders the plot.

virtual void	renderContent (QgsRenderContext &context, const QRectF &plotArea)
	Renders the plot content.

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

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.

QSizeF	size () const
	Returns the overall size of the plot (in millimeters) (including titles and other components which sit outside the plot area).

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 QgsPlot
	QgsPlot ()=default

virtual	~QgsPlot ()

Detailed Description

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

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 272 of file qgsplot.h.

Constructor & Destructor Documentation

◆ Qgs2DPlot() [1/2]

Qgs2DPlot::Qgs2DPlot ( )

Constructor for Qgs2DPlot.

Definition at line 169 of file qgsplot.cpp.

◆ ~Qgs2DPlot()

Qgs2DPlot::~Qgs2DPlot ( )

overridedefault

◆ Qgs2DPlot() [2/2]

Qgs2DPlot::Qgs2DPlot ( const Qgs2DPlot & other )

delete

Member Function Documentation

◆ calculateOptimisedIntervals()

void Qgs2DPlot::calculateOptimisedIntervals ( QgsRenderContext & context )

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 611 of file qgsplot.cpp.

◆ chartBackgroundSymbol()

QgsFillSymbol * Qgs2DPlot::chartBackgroundSymbol ( )

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

See also: setChartBackgroundSymbol()

Definition at line 746 of file qgsplot.cpp.

◆ chartBorderSymbol()

QgsFillSymbol * Qgs2DPlot::chartBorderSymbol ( )

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

See also: setChartBorderSymbol()

Definition at line 756 of file qgsplot.cpp.

◆ interiorPlotArea()

QRectF Qgs2DPlot::interiorPlotArea ( QgsRenderContext & context ) const

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

Definition at line 496 of file qgsplot.cpp.

◆ margins()

const QgsMargins & Qgs2DPlot::margins ( ) const

Returns the margins of the plot area (in millimeters)

See also: setMargins()

Definition at line 766 of file qgsplot.cpp.

◆ operator=()

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

delete

◆ readXml()

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

overridevirtual

Reads the plot's properties from an XML element.

Reimplemented from QgsPlot.

Definition at line 205 of file qgsplot.cpp.

◆ render()

void Qgs2DPlot::render ( QgsRenderContext & context )

Renders the plot.

Definition at line 229 of file qgsplot.cpp.

◆ renderContent()

void Qgs2DPlot::renderContent	(	QgsRenderContext &	context,
		const QRectF &	plotArea
	)

virtual

Renders the plot content.

Subclasses can implement this method to render the actual plot content (e.g. bar charts, scatter plots). This method will be called after the chart background and grid are rendered, but before the chart border is rendered.

The default implementation does nothing.

The plotArea argument specifies that area of the plot which corresponds to the actual plot content. Implementations should take care to scale values accordingly to render points correctly inside this plot area.

Definition at line 479 of file qgsplot.cpp.

◆ setChartBackgroundSymbol()

void Qgs2DPlot::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 751 of file qgsplot.cpp.

◆ setChartBorderSymbol()

void Qgs2DPlot::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 761 of file qgsplot.cpp.

◆ setMargins()

void Qgs2DPlot::setMargins ( const QgsMargins & margins )

Sets the margins of the plot area (in millimeters)

See also: setMargins()

Definition at line 771 of file qgsplot.cpp.

◆ setSize()

void Qgs2DPlot::setSize ( QSizeF size )

Sets the overall size of the plot (including titles and over components which sit outside the plot area).

See also: size()

Definition at line 491 of file qgsplot.cpp.

◆ setXMaximum()

void Qgs2DPlot::setXMaximum ( double maximum )

inline

Sets the maximum value of the x axis.

See also: xMaximum()

Definition at line 376 of file qgsplot.h.

◆ setXMinimum()

void Qgs2DPlot::setXMinimum ( double minimum )

inline

Sets the minimum value of the x axis.

See also: xMinimum()

Definition at line 348 of file qgsplot.h.

◆ setYMaximum()

void Qgs2DPlot::setYMaximum ( double maximum )

inline

Sets the maximum value of the y axis.

See also: yMaximum()

Definition at line 390 of file qgsplot.h.

◆ setYMinimum()

void Qgs2DPlot::setYMinimum ( double minimum )

inline

Sets the minimum value of the y axis.

See also: yMinimum()

Definition at line 362 of file qgsplot.h.

◆ size()

QSizeF Qgs2DPlot::size ( ) const

Returns the overall size of the plot (in millimeters) (including titles and other components which sit outside the plot area).

See also: setSize()

Definition at line 486 of file qgsplot.cpp.

◆ writeXml()

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

overridevirtual

Writes the plot's properties into an XML element.

Reimplemented from QgsPlot.

Definition at line 177 of file qgsplot.cpp.

◆ xAxis() [1/2]

QgsPlotAxis & Qgs2DPlot::xAxis ( )

inline

Returns a reference to the plot's x axis.

See also: yAxis()

Definition at line 397 of file qgsplot.h.

◆ xAxis() [2/2]

const QgsPlotAxis & Qgs2DPlot::xAxis ( ) const

inline

Returns a reference to the plot's x axis.

See also: yAxis()

Definition at line 404 of file qgsplot.h.

◆ xMaximum()

double Qgs2DPlot::xMaximum ( ) const

inline

Returns the maximum value of the x axis.

See also: setXMaximum()

Definition at line 369 of file qgsplot.h.

◆ xMinimum()

double Qgs2DPlot::xMinimum ( ) const

inline

Returns the minimum value of the x axis.

See also: setXMinimum()

Definition at line 341 of file qgsplot.h.

◆ yAxis() [1/2]

QgsPlotAxis & Qgs2DPlot::yAxis ( )

inline

Returns a reference to the plot's y axis.

See also: xAxis()

Definition at line 411 of file qgsplot.h.

◆ yAxis() [2/2]

const QgsPlotAxis & Qgs2DPlot::yAxis ( ) const

inline

Returns a reference to the plot's y axis.

See also: xAxis()

Definition at line 418 of file qgsplot.h.

◆ yMaximum()

double Qgs2DPlot::yMaximum ( ) const

inline

Returns the maximum value of the y axis.

See also: setYMaximum()

Definition at line 383 of file qgsplot.h.

◆ yMinimum()

double Qgs2DPlot::yMinimum ( ) const

inline

Returns the minimum value of the y axis.

See also: setYMinimum()

Definition at line 355 of file qgsplot.h.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/plot/qgsplot.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/plot/qgsplot.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Qgs2DPlot() [1/2]

◆ ~Qgs2DPlot()

◆ Qgs2DPlot() [2/2]

Member Function Documentation

◆ calculateOptimisedIntervals()

◆ chartBackgroundSymbol()

◆ chartBorderSymbol()

◆ interiorPlotArea()

◆ margins()

◆ operator=()

◆ readXml()

◆ render()

◆ renderContent()

◆ setChartBackgroundSymbol()

◆ setChartBorderSymbol()

◆ setMargins()

◆ setSize()

◆ setXMaximum()

◆ setXMinimum()

◆ setYMaximum()

◆ setYMinimum()

◆ size()

◆ writeXml()

◆ xAxis() [1/2]

◆ xAxis() [2/2]

◆ xMaximum()

◆ xMinimum()

◆ yAxis() [1/2]

◆ yAxis() [2/2]

◆ yMaximum()

◆ yMinimum()