QwtPlotScaleItem(3)

📦
version 6.3.0 · 6 versions
, in alpine 3.24

🌸 NAME 🌸

okay bestie, this is QwtPlotScaleItem(3) from the Library Functions Manual — literally a class which draws a scale inside the plot canvas. That's the whole vibe. 💅✨

🦋 SYNOPSIS 🦋

#include <qwt_plot_scaleitem.h>

Inherits QwtPlotItem.

💖 Public Member Functions 💖

  • QwtPlotScaleItem (QwtScaleDraw::Alignment=QwtScaleDraw::BottomScale, const double pos=0.0) — constructor for a scale item at the position pos. 🫶
  • virtual ~QwtPlotScaleItem () — destructor. bye-bye, scale item 💀
  • virtual int rtti () const override
  • void setScaleDiv (const QwtScaleDiv &) — assign a scale division.
  • const QwtScaleDiv & scaleDiv () const
  • void setScaleDivFromAxis (bool on)
  • bool isScaleDivFromAxis () const
  • void setPalette (const QPalette &)
  • QPalette palette () const
  • void setFont (const QFont &)
  • QFont font () const
  • void setScaleDraw (QwtScaleDraw *) — set a scale draw.
  • const QwtScaleDraw * scaleDraw () const
  • QwtScaleDraw * scaleDraw ()
  • void setPosition (double pos)
  • double position () const
  • void setBorderDistance (int) — align the scale to the canvas.
  • int borderDistance () const
  • void setAlignment (QwtScaleDraw::Alignment)
  • 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 ()
  • QwtPlotItem (const QString &title)
  • QwtPlotItem (const QwtText &title)
  • virtual ~QwtPlotItem () — destroy the QwtPlotItem.
  • void attach (QwtPlot *plot) — attach the item to a plot.
  • void detach () — this method detaches a QwtPlotItem from any QwtPlot it has been associated with.
  • QwtPlot * plot () const — return attached plot.
  • void setTitle (const QString &title)
  • void setTitle (const QwtText &title)
  • const QwtText & title () const
  • void setItemAttribute (ItemAttribute, bool on=true)
  • bool testItemAttribute (ItemAttribute) const
  • void setItemInterest (ItemInterest, bool on=true)
  • bool testItemInterest (ItemInterest) const
  • void setRenderHint (RenderHint, bool on=true)
  • bool testRenderHint (RenderHint) const
  • void setRenderThreadCount (uint numThreads)
  • uint renderThreadCount () const
  • void setLegendIconSize (const QSize &)
  • QSize legendIconSize () const
  • double z () const
  • void setZ (double z) — set the z value.
  • void show () — show the item.
  • void hide () — hide the item.
  • virtual void setVisible (bool)
  • bool isVisible () const
  • void setAxes (QwtAxisId xAxis, QwtAxisId yAxis)
  • void setXAxis (QwtAxisId)
  • QwtAxisId xAxis () const — return xAxis.
  • void setYAxis (QwtAxisId)
  • QwtAxisId yAxis () const — return yAxis.
  • virtual void itemChanged ()
  • virtual void legendChanged ()
  • virtual QRectF boundingRect () const
  • virtual void getCanvasMarginHint (const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, double &left, double &top, double &right, double &bottom) const — calculate a hint for the canvas margin.
  • virtual void updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &) — update the item to changes of the legend info.
  • QRectF scaleRect (const QwtScaleMap &, const QwtScaleMap &) const — calculate the bounding scale rectangle of 2 maps.
  • QRectF paintRect (const QwtScaleMap &, const QwtScaleMap &) const — calculate the bounding paint rectangle of 2 maps.
  • virtual QList< QwtLegendData > legendData () const — return all information, that is needed to represent the item on the legend.
  • virtual QwtGraphic legendIcon (int index, const QSizeF &) const

🧚 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_PlotUserItem = 1000 }

Runtime type information. 👑

enum ItemAttribute { Legend = 0x01, AutoScale = 0x02, Margins = 0x04 }

Plot Item Attributes. 🎀

enum ItemInterest { ScaleInterest = 0x01, LegendInterest = 0x02 }

Plot Item Interests. 💖

enum RenderHint { RenderAntialiased = 0x1 }

Render hints. ✨

typedef QFlags< ItemAttribute > ItemAttributes
typedef QFlags< ItemInterest > ItemInterests
typedef QFlags< RenderHint > RenderHints

🛡 Protected Member Functions inherited from QwtPlotItem 🛡

  • QwtGraphic defaultIcon (const QBrush &, const QSizeF &) const — return a default icon from a brush.

✨ Detailed Description ✨

This class draws a scale inside the plot canvas. That's the whole main-character energy. 💅

QwtPlotScaleItem can be used to draw an axis inside the plot canvas. It might be synchronized to one of the axes of the plot, but it 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 (for example 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 );

Definition at line 46 of file qwt_plot_scaleitem.h. 💖

🐚 Constructor & Destructor Documentation 🐚

💖 QwtPlotScaleItem::QwtPlotScaleItem 💖

QwtPlotScaleItem::QwtPlotScaleItem (QwtScaleDraw::Alignment alignment =
    QwtScaleDraw::BottomScale, const double pos = 0.0) [explicit]

Constructor for scale item at the position pos. 🫶

Parameters

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

See also

setPosition(), setAlignment()

Definition at line 75 of file qwt_plot_scaleitem.cpp. ✨

💀 QwtPlotScaleItem::~QwtPlotScaleItem 💀

QwtPlotScaleItem::~QwtPlotScaleItem () [virtual]

Destructor.

Definition at line 88 of file qwt_plot_scaleitem.cpp. 🌈

💖 Member Function Documentation 💖

💅 int QwtPlotScaleItem::borderDistance () const

Returns the Distance from a canvas border, bestie. That’s the whole vibe check. 🫶

See also: setBorderDistance(), setPosition()

Definition at line 312 of file qwt_plot_scaleitem.cpp.

🔥 void QwtPlotScaleItem::draw (QPainter * painter, const QwtScaleMap & xMap, const QwtScaleMap & yMap, const QRectF & canvasRect) const [override], [virtual]

Draw the scale. Literally the drawing moment, no cap. 💅

Implements: QwtPlotItem.

Definition at line 346 of file qwt_plot_scaleitem.cpp.

🎀 QFont QwtPlotScaleItem::font () const

Returns the tick label font. Cute font energy, but make it legible. ✨

See also: setFont()

Definition at line 196 of file qwt_plot_scaleitem.cpp.

🦋 bool QwtPlotScaleItem::isScaleDivFromAxis () const

Returns True if the synchronization of the scale division with the corresponding axis is enabled. So like… is it synced or not, bestie? 👑

See also: setScaleDiv(), setScaleDivFromAxis()

Definition at line 150 of file qwt_plot_scaleitem.cpp.

🌸 QPalette QwtPlotScaleItem::palette () const

Returns the palette. The color situation. 💖

See also: setPalette()

Definition at line 174 of file qwt_plot_scaleitem.cpp.

⭐ double QwtPlotScaleItem::position () const

Returns the Position of the scale. Where it’s at, literally. 📍

See also: setPosition(), setAlignment()

Definition at line 275 of file qwt_plot_scaleitem.cpp.

👑 int QwtPlotScaleItem::rtti () const [override], [virtual]

Returns QwtPlotItem::Rtti_PlotScale. That’s the type ID, periodt. 💅

Reimplemented from: QwtPlotItem.

Definition at line 94 of file qwt_plot_scaleitem.cpp.

🌈 const QwtScaleDiv & QwtPlotScaleItem::scaleDiv () const

Returns the Scale division. The division of the scale. Very demure, very division. 🎀

Definition at line 115 of file qwt_plot_scaleitem.cpp.

🧚 QwtScaleDraw * QwtPlotScaleItem::scaleDraw ()

Returns the Scale draw. The object in charge of the drawing situation. 🖌️

See also: setScaleDraw()

Definition at line 245 of file qwt_plot_scaleitem.cpp.

🧚‍♀️ const QwtScaleDraw * QwtPlotScaleItem::scaleDraw () const

Returns the Scale draw. Same scale draw energy, but const-coded. 💜

See also: setScaleDraw()

Definition at line 236 of file qwt_plot_scaleitem.cpp.

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

Change the alignment of the scale, bestie. 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()

Definition at line 333 of file qwt_plot_scaleitem.cpp.

🎀 void QwtPlotScaleItem::setBorderDistance (int distance)

Align the scale to the canvas. 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().

Parameters:

  • distance — Number of pixels between the canvas border and the backbone of the scale.

See also: setPosition(), borderDistance()

Definition at line 296 of file qwt_plot_scaleitem.cpp.

🌸 void QwtPlotScaleItem::setFont (const QFont & font)

Change the tick label font. Make it slay, but readable. 💖

See also: font()

Definition at line 183 of file qwt_plot_scaleitem.cpp.

🦋 void QwtPlotScaleItem::setPalette (const QPalette & palette)

Set the palette. Color coordination is literally everything. 🎨

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

Definition at line 159 of file qwt_plot_scaleitem.cpp.

⭐ void QwtPlotScaleItem::setPosition (double pos)

Change the position of the scale. The position is interpreted as y value for horizontal axes and as x value for vertical axes.

The border distance is set to -1.

Parameters:

  • pos — New position

See also: position(), setAlignment()

Definition at line 261 of file qwt_plot_scaleitem.cpp.

🔥 void QwtPlotScaleItem::setScaleDiv (const QwtScaleDiv & scaleDiv)

Assign a scale division. When assigning a scaleDiv the scale division won’t be synchronized with the corresponding axis anymore. So yeah, it’s doing its own thing now. 💀

Parameters:

  • scaleDiv — Scale division

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

Definition at line 108 of file qwt_plot_scaleitem.cpp.

💜 void QwtPlotScaleItem::setScaleDivFromAxis (bool on)

Enable/Disable the synchronization of the scale division with the corresponding axis. You’re literally flipping the sync switch, bestie. 🫶

Parameters:

  • on — true/false

See also: isScaleDivFromAxis()

Definition at line 127 of file qwt_plot_scaleitem.cpp.

🧚 void QwtPlotScaleItem::setScaleDraw (QwtScaleDraw * scaleDraw)

Set a scale draw.

Parameters:

  • 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. Iconic customization moment, no cap. ✨

See also: scaleDraw()

Definition at line 212 of file qwt_plot_scaleitem.cpp.

🌈 void QwtPlotScaleItem::updateScaleDiv (const QwtScaleDiv & xScaleDiv, const QwtScaleDiv & yScaleDiv) [override], [virtual]

Update the item to changes of the axes scale division. In case of isScaleDivFromAxis(), the scale draw is synchronized to the correspond axis.

Parameters:

  • xScaleDiv — Scale division of the x-axis
  • yScaleDiv — Scale division of the y-axis

See also: QwtPlot::updateAxes()

Reimplemented from: QwtPlotItem.

Definition at line 445 of file qwt_plot_scaleitem.cpp.

🌸 Author 🌸

Generated automatically by Doxygen for Qwt User's Guide from the source code.

✨ Cute sign-off: source/version = Qwt User's Guide, and the footer/date vibe is literally QwtPlotScaleItem(3). Byeee, bestie! 💅

📦 where this page comes from