A class which draws a scale inside the plot canvas. More...

#include <qwt_plot_scaleitem.h>

Inheritance diagram for QwtPlotScaleItem:

Classes
class	PrivateData

Public Member Functions
	QwtPlotScaleItem (QwtScaleDraw::Alignment=QwtScaleDraw::BottomScale, const double pos=0.0)
	Constructor for scale item at the position pos.

virtual int	rtti () const override
	Get the runtime type information.

void	setScaleDiv (const QwtScaleDiv &)
	Assign a scale division.

const QwtScaleDiv &	scaleDiv () const
	Get the scale division.

void	setScaleDivFromAxis (bool on)
	Enable/Disable the synchronization of the scale division with the corresponding axis.

bool	isScaleDivFromAxis () const
	Check if synchronization of the scale division with the corresponding axis is enabled.

void	setPalette (const QPalette &)
	Set the palette.

QPalette	palette () const
	Get the palette.

void	setFont (const QFont &)
	Change the tick label font.

QFont	font () const
	Get the tick label font.

void	setScaleDraw (QwtScaleDraw *)
	Set a scale draw.

const QwtScaleDraw *	scaleDraw () const
	Get the scale draw (const version)

QwtScaleDraw *	scaleDraw ()
	Get the scale draw.

void	setPosition (double pos)
	Change the position of the scale.

double	position () const
	Get the position of the scale.

void	setBorderDistance (int)
	Align the scale to the canvas.

int	borderDistance () const
	Get the distance from a canvas border.

void	setAlignment (QwtScaleDraw::Alignment)
	Change the alignment of the scale.

virtual void	draw (QPainter *, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect) const override
	Draw the scale.

virtual void	updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &) override
	Update the item to changes of the axes scale division.

Public Member Functions inherited from QwtPlotItem
	QwtPlotItem ()
	Default constructor.

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

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

virtual	~QwtPlotItem ()
	Destructor.

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

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

Additional Inherited Members
Public Types inherited from QwtPlotItem
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...

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

Detailed Description

A class which draws a scale inside the plot canvas.

QwtPlotScaleItem can be used to draw an axis inside the plot canvas. It might be synchronized to one of the axis of the plot, but can also display its own ticks and labels.

It is allowed to synchronize the scale item with a disabled axis. In plots with vertical and horizontal scale items, it might be necessary to remove ticks at the intersections, by overloading updateScaleDiv().

     The scale might be at a specific position (e.g 0.0) or it might be aligned to a canvas border.

Example: The following example shows how to replace the left axis, by a scale item at the x position 0.0.
QwtPlotScaleItem *scaleItem = new QwtPlotScaleItem( QwtScaleDraw::RightScale, 0.0 );

scaleItem->setFont( plot->axisWidget( QwtAxis::YLeft )->font() );

scaleItem->attach(plot);

plot->setAxisVisible( QwtAxis::YLeft, false );

QwtPlotItem::plot
QwtPlot * plot() const
Get the plot the item is attached to.
Definition qwt_plot_item.cpp:164

QwtPlotItem::attach
virtual void attach(QwtPlot *plot)
Attach the item to a plot.
Definition qwt_plot_item.cpp:118

QwtPlotScaleItem
A class which draws a scale inside the plot canvas.
Definition qwt_plot_scaleitem.h:58

QwtPlotScaleItem::setFont
void setFont(const QFont &)
Change the tick label font.
Definition qwt_plot_scaleitem.cpp:208

QwtPlot::setAxisVisible
void setAxisVisible(QwtAxisId, bool on=true)
Hide or show a specified axis.
Definition qwt_plot_axis.cpp:462

QwtPlot::axisWidget
const QwtScaleWidget * axisWidget(QwtAxisId) const
Return the scale widget of the specified axis.
Definition qwt_plot_axis.cpp:176

QwtScaleDraw::RightScale
@ RightScale
The scale is right.
Definition qwt_scale_draw.h:70

QwtAxis::YLeft
@ YLeft
Y axis left of the canvas.
Definition qwt_axis.h:45

Constructor & Destructor Documentation

◆ QwtPlotScaleItem()

QwtPlotScaleItem::QwtPlotScaleItem	(	QwtScaleDraw::Alignment	alignment = `QwtScaleDraw::BottomScale`,
		const double	pos = `0.0`
	)

explicit

Constructor for scale item at the position pos.

Parameters

[in]	alignment	In case of QwtScaleDraw::BottomScale or QwtScaleDraw::TopScale, the scale item is corresponding to the xAxis(), otherwise it corresponds to the yAxis().
[in]	pos	x or y position, depending on the corresponding axis.

See also: setPosition(), setAlignment()

Destructor

Member Function Documentation

◆ borderDistance()

int QwtPlotScaleItem::borderDistance ( ) const

Get the distance from a canvas border.

Returns: Distance from a canvas border

See also: setBorderDistance(), setPosition()

◆ draw()

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

overridevirtual

Draw the scale.

Parameters

[in]	painter	Painter
[in]	xMap	X Scale Map
[in]	yMap	Y Scale Map
[in]	canvasRect	Contents rectangle of the canvas in painter coordinates

Implements QwtPlotItem.

◆ font()

QFont QwtPlotScaleItem::font ( ) const

Get the tick label font.

Returns: Font

See also: setFont()

◆ isScaleDivFromAxis()

bool QwtPlotScaleItem::isScaleDivFromAxis ( ) const

Check if synchronization of the scale division with the corresponding axis is enabled.

Returns: True, if the synchronization of the scale division with the corresponding axis is enabled.

See also: setScaleDiv(), setScaleDivFromAxis()

◆ palette()

QPalette QwtPlotScaleItem::palette ( ) const

Get the palette.

Returns: Palette

See also: setPalette()

◆ position()

double QwtPlotScaleItem::position ( ) const

Get the position of the scale.

Returns: Position of the scale

See also: setPosition(), setAlignment()

◆ rtti()

int QwtPlotScaleItem::rtti ( ) const

overridevirtual

Get the runtime type information.

Returns: QwtPlotItem::Rtti_PlotScale

Reimplemented from QwtPlotItem.

◆ scaleDiv()

const QwtScaleDiv & QwtPlotScaleItem::scaleDiv ( ) const

Get the scale division.

Returns: Scale division

◆ scaleDraw() [1/2]

QwtScaleDraw * QwtPlotScaleItem::scaleDraw ( )

Get the scale draw.

Returns: Scale draw

See also: setScaleDraw()

◆ scaleDraw() [2/2]

const QwtScaleDraw * QwtPlotScaleItem::scaleDraw ( ) const

Get the scale draw (const version)

Returns: Scale draw

See also: setScaleDraw()

◆ setAlignment()

void QwtPlotScaleItem::setAlignment ( QwtScaleDraw::Alignment alignment )

Change the alignment of the scale.

Parameters

[in] alignment Alignment

The alignment sets the orientation of the scale and the position of the ticks:

QwtScaleDraw::BottomScale: horizontal, ticks below
QwtScaleDraw::TopScale: horizontal, ticks above
QwtScaleDraw::LeftScale: vertical, ticks left
QwtScaleDraw::RightScale: vertical, ticks right For horizontal scales the position corresponds to QwtPlotItem::yAxis(), otherwise to QwtPlotItem::xAxis().
See also
scaleDraw(), QwtScaleDraw::alignment(), setPosition()

◆ setBorderDistance()

void QwtPlotScaleItem::setBorderDistance ( int distance )

Align the scale to the canvas.

Parameters

[in] distance Number of pixels between the canvas border and the backbone of the scale.

If distance is >= 0 the scale will be aligned to a border of the contents rectangle of the canvas. If alignment() is QwtScaleDraw::LeftScale, the scale will be aligned to the right border, if it is QwtScaleDraw::TopScale it will be aligned to the bottom (and vice versa). If distance is < 0 the scale will be at the position().

See also: setPosition(), borderDistance()

◆ setFont()

void QwtPlotScaleItem::setFont ( const QFont & font )

Change the tick label font.

Parameters

[in] font Font

See also: font()

◆ setPalette()

void QwtPlotScaleItem::setPalette ( const QPalette & palette )

Set the palette.

Parameters

[in] palette Palette

See also: QwtAbstractScaleDraw::draw(), palette()

◆ setPosition()

void QwtPlotScaleItem::setPosition ( double pos )

Change the position of the scale.

Parameters

[in] pos New position

The position is interpreted as y value for horizontal axes and as x value for vertical axes. The border distance is set to -1.

See also: position(), setAlignment()

◆ setScaleDiv()

void QwtPlotScaleItem::setScaleDiv ( const QwtScaleDiv & scaleDiv )

Assign a scale division.

Parameters

[in] scaleDiv Scale division

When assigning a scaleDiv the scale division won't be synchronized with the corresponding axis anymore.

See also: scaleDiv(), setScaleDivFromAxis(), isScaleDivFromAxis()

◆ setScaleDivFromAxis()

void QwtPlotScaleItem::setScaleDivFromAxis ( bool on )

Enable/Disable the synchronization of the scale division with the corresponding axis.

Parameters

[in] on true/false

See also: isScaleDivFromAxis()

◆ setScaleDraw()

void QwtPlotScaleItem::setScaleDraw ( QwtScaleDraw * scaleDraw )

Set a scale draw.

Parameters

[in] scaleDraw Object responsible for drawing scales

The main use case for replacing the default QwtScaleDraw is to overload QwtAbstractScaleDraw::label, to replace or swallow tick labels.

See also: scaleDraw()

◆ updateScaleDiv()

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

overridevirtual

Update the item to changes of the axes scale division.

Parameters

[in]	xScaleDiv	Scale division of the x-axis
[in]	yScaleDiv	Scale division of the y-axis

In case of isScaleDivFromAxis(), the scale draw is synchronized to the correspond axis.

See also: QwtPlot::updateAxes()

Reimplemented from QwtPlotItem.

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

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

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QwtPlotScaleItem()

Member Function Documentation

◆ borderDistance()

◆ draw()

◆ font()

◆ isScaleDivFromAxis()

◆ palette()

◆ position()

◆ rtti()

◆ scaleDiv()

◆ scaleDraw() [1/2]

◆ scaleDraw() [2/2]

◆ setAlignment()

◆ setBorderDistance()

◆ setFont()

◆ setPalette()

◆ setPosition()

◆ setScaleDiv()

◆ setScaleDivFromAxis()

◆ setScaleDraw()

◆ updateScaleDiv()