Base class for items on the plot canvas. More...

#include <qwt_plot_item.h>

Inheritance diagram for QwtPlotItem:

Classes
class	PrivateData

Public Types
enum	RttiValues { Rtti_PlotItem = 0 , Rtti_PlotGrid , Rtti_PlotScale , Rtti_PlotLegend , Rtti_PlotMarker , Rtti_PlotCurve , Rtti_PlotSpectroCurve , Rtti_PlotIntervalCurve , Rtti_PlotHistogram , Rtti_PlotSpectrogram , Rtti_PlotGraphic , Rtti_PlotTradingCurve , Rtti_PlotBarChart , Rtti_PlotMultiBarChart , Rtti_PlotShape , Rtti_PlotTextLabel , Rtti_PlotZone , Rtti_PlotVectorField , Rtti_PlotArrowMarker , Rtti_PlotBoxChart , Rtti_PlotUserItem = 1000 }
	Runtime type information. More...

enum	ItemAttribute { Legend = 0x01 , AutoScale = 0x02 , Margins = 0x04 }
	Plot Item Attributes. More...

enum	ItemInterest { ScaleInterest = 0x01 , LegendInterest = 0x02 }
	Plot Item Interests. More...

enum	RenderHint { RenderAntialiased = 0x1 }
	Render hints . More...

Public Member Functions
	QwtPlotItem ()
	Default constructor.

	QwtPlotItem (const QString &title)
	Constructor with title as QString.

	QwtPlotItem (const QwtText &title)
	Constructor with title as QwtText.

virtual	~QwtPlotItem ()
	Destructor.

void	attach (QwtPlot *plot)
	Attach the item to a plot.

void	detach ()
	Detach the item from the plot.

QwtPlot *	plot () const
	Get the plot the item is attached to.

void	setTitle (const QString &title)
	Set the title using a QString.

void	setTitle (const QwtText &title)
	Set the title using a QwtText.

const QwtText &	title () const
	Get the title.

virtual int	rtti () const
	Runtime type information.

void	setItemAttribute (ItemAttribute, bool on=true)
	Set an item attribute.

bool	testItemAttribute (ItemAttribute) const
	Test an item attribute.

void	setItemInterest (ItemInterest, bool on=true)
	Set an item interest.

bool	testItemInterest (ItemInterest) const
	Test an item interest.

void	setRenderHint (RenderHint, bool on=true)
	Set a render hint.

bool	testRenderHint (RenderHint) const
	Test a render hint.

void	setRenderThreadCount (uint numThreads)
	Set the number of render threads.

uint	renderThreadCount () const
	Get the number of render threads.

void	setLegendIconSize (const QSize &)
	Set the legend icon size.

QSize	legendIconSize () const
	Get the legend icon size.

double	z () const
	Get the z-value.

void	setZ (double z)
	Set the z-value.

void	show ()
	Show the item.

void	hide ()
	Hide the item.

virtual void	setVisible (bool)
	Set the visibility.

bool	isVisible () const
	Check if the item is visible.

void	setAxes (QwtAxisId xAxis, QwtAxisId yAxis)
	Set both axes.

void	setXAxis (QwtAxisId)
	Set the x-axis.

QwtAxisId	xAxis () const
	Get the x-axis.

void	setYAxis (QwtAxisId)
	Set the y-axis.

QwtAxisId	yAxis () const
	Get the y-axis.

virtual void	itemChanged ()
	Notify the plot that the item has changed.

virtual void	legendChanged ()
	Notify the item that the legend has changed.

virtual void	draw (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect) const =0
	Draw the item.

virtual QRectF	boundingRect () const
	Get the bounding rectangle.

virtual void	getCanvasMarginHint (const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, double &left, double &top, double &right, double &bottom) const
	Get margin hints for the canvas.

virtual void	updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &)
	Update the item with new scale divisions.

virtual void	updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &)
	Update the item with changes of the legend.

QRectF	scaleRect (const QwtScaleMap &, const QwtScaleMap &) const
	Calculate the scale rectangle.

QRectF	paintRect (const QwtScaleMap &, const QwtScaleMap &) const
	Calculate the paint rectangle.

virtual QList< QwtLegendData >	legendData () const
	Return legend data.

virtual QwtGraphic	legendIcon (int index, const QSizeF &) const
	Return a legend icon.

Protected Member Functions
QwtGraphic	defaultIcon (const QBrush &, const QSizeF &) const
	Create a default icon.

Detailed Description

Base class for items on the plot canvas.

Member Enumeration Documentation

◆ ItemAttribute

enum QwtPlotItem::ItemAttribute

Plot Item Attributes.

Enumerator

Legend

The item is represented on the legend.

AutoScale

The boundingRect() of the item is included in the autoscaling calculation as long as its width or height is >= 0.0.

Margins

The item needs extra space to display something outside its bounding rectangle.

See also: getCanvasMarginHint()

◆ ItemInterest

enum QwtPlotItem::ItemInterest

Plot Item Interests.

Enumerator

ScaleInterest

The item is interested in updates of the scales

See also: updateScaleDiv()

LegendInterest

The item is interested in updates of the legend ( of other items ) This flag is intended for items, that want to implement a legend for displaying entries of other plot item.

Note: If the plot item wants to be represented on a legend enable QwtPlotItem::Legend instead.

See also: updateLegend()

◆ RenderHint

enum QwtPlotItem::RenderHint

Render hints .

Enumerator
RenderAntialiased	Enable antialiasing.

◆ RttiValues

enum QwtPlotItem::RttiValues

Runtime type information.

Enumerator
Rtti_PlotItem	Unspecific value, that can be used, when it doesn't matter.
Rtti_PlotGrid	For QwtPlotGrid.
Rtti_PlotScale	For QwtPlotScaleItem.
Rtti_PlotLegend	For QwtPlotLegendItem.
Rtti_PlotMarker	For QwtPlotMarker.
Rtti_PlotCurve	For QwtPlotCurve.
Rtti_PlotSpectroCurve	For QwtPlotSpectroCurve.
Rtti_PlotIntervalCurve	For QwtPlotIntervalCurve.
Rtti_PlotHistogram	For QwtPlotHistogram.
Rtti_PlotSpectrogram	For QwtPlotSpectrogram.
Rtti_PlotGraphic	For QwtPlotGraphicItem, QwtPlotSvgItem.
Rtti_PlotTradingCurve	For QwtPlotTradingCurve.
Rtti_PlotBarChart	For QwtPlotBarChart.
Rtti_PlotMultiBarChart	For QwtPlotMultiBarChart.
Rtti_PlotShape	For QwtPlotShapeItem.
Rtti_PlotTextLabel	For QwtPlotTextLabel.
Rtti_PlotZone	For QwtPlotZoneItem.
Rtti_PlotVectorField	For QwtPlotVectorField.
Rtti_PlotArrowMarker	For QwtPlotArrowMarker.
Rtti_PlotBoxChart	Boxplot chart item.
Rtti_PlotUserItem	Values >= Rtti_PlotUserItem are reserved for plot items not implemented in the Qwt library.

Constructor & Destructor Documentation

◆ QwtPlotItem() [1/3]

QwtPlotItem::QwtPlotItem ( )

explicit

Default constructor.

◆ QwtPlotItem() [2/3]

QwtPlotItem::QwtPlotItem ( const QString & title )

explicit

Constructor with title as QString.

◆ QwtPlotItem() [3/3]

QwtPlotItem::QwtPlotItem ( const QwtText & title )

explicit

Constructor with title as QwtText.

◆ ~QwtPlotItem()

QwtPlotItem::~QwtPlotItem ( )

virtual

Destructor.

Member Function Documentation

◆ attach()

void QwtPlotItem::attach ( QwtPlot * plot )

Attach the item to a plot.

◆ boundingRect()

QRectF QwtPlotItem::boundingRect ( ) const

virtual

Get the bounding rectangle.

Reimplemented in QwtPlotArrowMarker, QwtPlotBarChart, QwtPlotBoxChart, QwtPlotGraphicItem, QwtPlotHistogram, QwtPlotIntervalCurve, QwtPlotMarker, QwtPlotMultiBarChart, QwtPlotRasterItem, QwtPlotSeriesItem, QwtPlotShapeItem, QwtPlotTradingCurve, QwtPlotVectorField, and QwtPlotZoneItem.

◆ defaultIcon()

QwtGraphic QwtPlotItem::defaultIcon	(	const QBrush &	brush,
		const QSizeF &	size
	)		const

protected

Create a default icon.

Return a default icon from a brush.

◆ detach()

void QwtPlotItem::detach ( )

Detach the item from the plot.

◆ draw()

virtual void QwtPlotItem::draw	(	QPainter *	painter,
		const QwtScaleMap &	xMap,
		const QwtScaleMap &	yMap,
		const QRectF &	canvasRect
	)		const

pure virtual

Draw the item.

Implemented in QwtPlotTextLabel, QwtPlotZoneItem, QwtPlotMarker, QwtPlotGraphicItem, QwtPlotGrid, QwtPlotLegendItem, QwtPlotRasterItem, QwtPlotScaleItem, QwtPlotSeriesItem, QwtPlotShapeItem, QwtPlotSpectrogram, and QwtPlotArrowMarker.

◆ getCanvasMarginHint()

void QwtPlotItem::getCanvasMarginHint	(	const QwtScaleMap &	xMap,
		const QwtScaleMap &	yMap,
		const QRectF &	canvasRect,
		double &	left,
		double &	top,
		double &	right,
		double &	bottom
	)		const

virtual

Get margin hints for the canvas.

Calculate a hint for the canvas margin.

Reimplemented in QwtPlotAbstractBarChart.

◆ hide()

void QwtPlotItem::hide ( )

Hide the item.

◆ isVisible()

bool QwtPlotItem::isVisible ( ) const

Check if the item is visible.

◆ itemChanged()

void QwtPlotItem::itemChanged ( )

virtual

Notify the plot that the item has changed.

◆ legendChanged()

void QwtPlotItem::legendChanged ( )

virtual

Notify the item that the legend has changed.

Notify that the legend has changed.

◆ legendData()

QList< QwtLegendData > QwtPlotItem::legendData ( ) const

virtual

Return legend data.

Return all information needed to represent the item on the legend.

Reimplemented in QwtPlotBarChart, and QwtPlotMultiBarChart.

◆ legendIcon()

QwtGraphic QwtPlotItem::legendIcon	(	int	index,
		const QSizeF &	size
	)		const

virtual

Return a legend icon.

Get the icon representing the item on the legend.

Reimplemented in QwtPlotBarChart, QwtPlotBoxChart, QwtPlotCurve, QwtPlotHistogram, QwtPlotIntervalCurve, QwtPlotMarker, QwtPlotMultiBarChart, QwtPlotShapeItem, QwtPlotTradingCurve, QwtPlotVectorField, and QwtPlotArrowMarker.

◆ legendIconSize()

QSize QwtPlotItem::legendIconSize ( ) const

Get the legend icon size.

◆ paintRect()

QRectF QwtPlotItem::paintRect	(	const QwtScaleMap &	xMap,
		const QwtScaleMap &	yMap
	)		const

Calculate the paint rectangle.

Calculate the bounding paint rectangle of 2 maps.

◆ plot()

QwtPlot * QwtPlotItem::plot ( ) const

Get the plot the item is attached to.

◆ renderThreadCount()

uint QwtPlotItem::renderThreadCount ( ) const

Get the number of render threads.

◆ rtti()

int QwtPlotItem::rtti ( ) const

virtual

Runtime type information.

Get runtime type information.

Reimplemented in QwtPlotArrowMarker, QwtPlotBarChart, QwtPlotBoxChart, QwtPlotCurve, QwtPlotGraphicItem, QwtPlotGrid, QwtPlotHistogram, QwtPlotIntervalCurve, QwtPlotLegendItem, QwtPlotMarker, QwtPlotMultiBarChart, QwtPlotScaleItem, QwtPlotShapeItem, QwtPlotSpectroCurve, QwtPlotSpectrogram, QwtPlotTextLabel, QwtPlotTradingCurve, QwtPlotVectorField, and QwtPlotZoneItem.

◆ scaleRect()

QRectF QwtPlotItem::scaleRect	(	const QwtScaleMap &	xMap,
		const QwtScaleMap &	yMap
	)		const

Calculate the scale rectangle.

Calculate the bounding scale rectangle of 2 maps.

◆ setAxes()

void QwtPlotItem::setAxes	(	QwtAxisId	xAxisId,
		QwtAxisId	yAxisId
	)

Set both axes.

Set X and Y axes.

◆ setItemAttribute()

void QwtPlotItem::setItemAttribute	(	ItemAttribute	attribute,
		bool	on = `true`
	)

Set an item attribute.

◆ setItemInterest()

void QwtPlotItem::setItemInterest	(	ItemInterest	interest,
		bool	on = `true`
	)

Set an item interest.

◆ setLegendIconSize()

void QwtPlotItem::setLegendIconSize ( const QSize & size )

Set the legend icon size.

Set the size of the legend icon.

◆ setRenderHint()

void QwtPlotItem::setRenderHint	(	RenderHint	hint,
		bool	on = `true`
	)

Set a render hint.

◆ setRenderThreadCount()

void QwtPlotItem::setRenderThreadCount ( uint numThreads )

Set the number of render threads.

◆ setTitle() [1/2]

void QwtPlotItem::setTitle ( const QString & title )

Set the title using a QString.

◆ setTitle() [2/2]

void QwtPlotItem::setTitle ( const QwtText & title )

Set the title using a QwtText.

◆ setVisible()

void QwtPlotItem::setVisible ( bool on )

virtual

Set the visibility.

Set the visibility of the item.

◆ setXAxis()

void QwtPlotItem::setXAxis ( QwtAxisId axisId )

Set the x-axis.

Set the X axis.

◆ setYAxis()

void QwtPlotItem::setYAxis ( QwtAxisId axisId )

Set the y-axis.

Set the Y axis.

◆ setZ()

void QwtPlotItem::setZ ( double z )

Set the z-value.

◆ show()

void QwtPlotItem::show ( )

Show the item.

◆ testItemAttribute()

bool QwtPlotItem::testItemAttribute ( ItemAttribute attribute ) const

Test an item attribute.

◆ testItemInterest()

bool QwtPlotItem::testItemInterest ( ItemInterest interest ) const

Test an item interest.

◆ testRenderHint()

bool QwtPlotItem::testRenderHint ( RenderHint hint ) const

Test a render hint.

◆ title()

const QwtText & QwtPlotItem::title ( ) const

Get the title.

Get the title of the item.

◆ updateLegend()

void QwtPlotItem::updateLegend	(	const QwtPlotItem *	item,
		const QList< QwtLegendData > &	data
	)

virtual

Update the item with changes of the legend.

Update the item to changes of the legend info.

Reimplemented in QwtPlotLegendItem.

◆ updateScaleDiv()

void QwtPlotItem::updateScaleDiv	(	const QwtScaleDiv &	xScaleDiv,
		const QwtScaleDiv &	yScaleDiv
	)

virtual

Update the item with new scale divisions.

Update the item to changes of the axes scale division.

Reimplemented in QwtPlotScaleItem, QwtPlotSeriesItem, and QwtPlotGrid.

◆ xAxis()

QwtAxisId QwtPlotItem::xAxis ( ) const

Get the x-axis.

Get the X axis.

◆ yAxis()

QwtAxisId QwtPlotItem::yAxis ( ) const

Get the y-axis.

Get the Y axis.

◆ z()

double QwtPlotItem::z ( ) const

Get the z-value.

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

/home/runner/work/QWT/QWT/src/plot/qwt_plot_item.h
/home/runner/work/QWT/QWT/src/plot/qwt_plot_item.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ ItemAttribute

◆ ItemInterest

◆ RenderHint

◆ RttiValues

Constructor & Destructor Documentation

◆ QwtPlotItem() [1/3]

◆ QwtPlotItem() [2/3]

◆ QwtPlotItem() [3/3]

◆ ~QwtPlotItem()

Member Function Documentation

◆ attach()

◆ boundingRect()

◆ defaultIcon()

◆ detach()

◆ draw()

◆ getCanvasMarginHint()

◆ hide()

◆ isVisible()

◆ itemChanged()

◆ legendChanged()

◆ legendData()

◆ legendIcon()

◆ legendIconSize()

◆ paintRect()

◆ plot()

◆ renderThreadCount()

◆ rtti()

◆ scaleRect()

◆ setAxes()

◆ setItemAttribute()

◆ setItemInterest()

◆ setLegendIconSize()

◆ setRenderHint()

◆ setRenderThreadCount()

◆ setTitle() [1/2]

◆ setTitle() [2/2]

◆ setVisible()

◆ setXAxis()

◆ setYAxis()

◆ setZ()

◆ show()

◆ testItemAttribute()

◆ testItemInterest()

◆ testRenderHint()

◆ title()

◆ updateLegend()

◆ updateScaleDiv()

◆ xAxis()

◆ yAxis()

◆ z()