A simple bar chart class. More...

#include <qgsbarchartplot.h>

Inheritance diagram for QgsBarChartPlot:

[legend]

Public Member Functions
	QgsBarChartPlot ()
	~QgsBarChartPlot () override=default
QgsFillSymbol *	fillSymbolAt (int index) const
	Returns the fill symbol for the series with matching index.
int	fillSymbolCount () const
	Returns the fill symbols list count.
void	initFromPlot (const QgsPlot *plot) override
	Initializes properties of this plot from an existing plot, transferring all applicable settings.
bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads the plot's properties from an XML element.
void	renderContent (QgsRenderContext &context, QgsPlotRenderContext &plotContext, const QRectF &plotArea, const QgsPlotData &plotData=QgsPlotData()) override
	Renders the plot content.
void	setFillSymbolAt (int index, QgsFillSymbol *symbol)
	Sets the fill symbol to use for the series with matching index.
QString	type () const override
	Returns the plot's type.
bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
	Writes the plot's properties into an XML element.
Public Member Functions inherited from Qgs2DXyPlot
	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
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.
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
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.
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.

Static Public Member Functions
static QgsBarChartPlot *	create ()
	Returns a new bar chart.
static QgsVectorLayerAbstractPlotDataGatherer *	createDataGatherer (QgsPlot *plot)
	Returns a new data gatherer for a given bar chart plot.
Static Public Member Functions inherited from QgsPlot
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the plot property definitions.

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...
Protected Member Functions inherited from Qgs2DXyPlot
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.
Protected Attributes inherited from QgsPlot
QgsPropertyCollection	mDataDefinedProperties

Detailed Description

A simple bar chart class.

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

Since: QGIS 4.0

Definition at line 40 of file qgsbarchartplot.h.

Constructor & Destructor Documentation

◆ QgsBarChartPlot()

QgsBarChartPlot::QgsBarChartPlot ( )

Definition at line 30 of file qgsbarchartplot.cpp.

◆ ~QgsBarChartPlot()

QgsBarChartPlot::~QgsBarChartPlot ( )

overridedefault

Member Function Documentation

◆ create()

QgsBarChartPlot * QgsBarChartPlot::create ( )

static

Returns a new bar chart.

Definition at line 238 of file qgsbarchartplot.cpp.

◆ createDataGatherer()

QgsVectorLayerAbstractPlotDataGatherer * QgsBarChartPlot::createDataGatherer ( QgsPlot * plot )

static

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

Definition at line 243 of file qgsbarchartplot.cpp.

◆ fillSymbolAt()

QgsFillSymbol * QgsBarChartPlot::fillSymbolAt ( int index ) const

Returns the fill symbol for the series with matching index.

Definition at line 167 of file qgsbarchartplot.cpp.

◆ fillSymbolCount()

int QgsBarChartPlot::fillSymbolCount ( ) const

inline

Returns the fill symbols list count.

Definition at line 66 of file qgsbarchartplot.h.

◆ initFromPlot()

void QgsBarChartPlot::initFromPlot ( const QgsPlot * plot )

overridevirtual

Initializes properties of this plot from an existing plot, transferring all applicable settings.

Reimplemented from QgsPlot.

Definition at line 254 of file qgsbarchartplot.cpp.

◆ readXml()

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

overridevirtual

Reads the plot's properties from an XML element.

Reimplemented from Qgs2DXyPlot.

Definition at line 212 of file qgsbarchartplot.cpp.

◆ renderContent()

void QgsBarChartPlot::renderContent	(	QgsRenderContext &	context,
		QgsPlotRenderContext &	plotContext,
		const QRectF &	plotArea,
		const QgsPlotData &	plotData = QgsPlotData() )

overridevirtual

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.

Reimplemented from Qgs2DPlot.

Definition at line 35 of file qgsbarchartplot.cpp.

◆ setFillSymbolAt()

void QgsBarChartPlot::setFillSymbolAt	(	int	index,
		QgsFillSymbol *	symbol )

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

Definition at line 177 of file qgsbarchartplot.cpp.

◆ type()

QString QgsBarChartPlot::type ( ) const

inlineoverridevirtual

Returns the plot's type.

Since: QGIS 4.0

Reimplemented from QgsPlot.

Definition at line 46 of file qgsbarchartplot.h.

◆ writeXml()

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

overridevirtual

Writes the plot's properties into an XML element.

Reimplemented from Qgs2DXyPlot.

Definition at line 192 of file qgsbarchartplot.cpp.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsBarChartPlot()

◆ ~QgsBarChartPlot()

Member Function Documentation

◆ create()

◆ createDataGatherer()

◆ fillSymbolAt()

◆ fillSymbolCount()

◆ initFromPlot()

◆ readXml()

◆ renderContent()

◆ setFillSymbolAt()

◆ type()

◆ writeXml()