Classes | Public Member Functions | Private Attributes | List of all members
QwtPlotScaleItem Class Reference

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

#include <qwt_plot_scaleitem.h>

Inheritance diagram for QwtPlotScaleItem:
Inheritance graph
[legend]

Classes

class  PrivateData
 

Public Member Functions

int borderDistance () const
 
virtual void draw (QPainter *p, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &rect) const
 Draw the scale. More...
 
QFont font () const
 
bool isScaleDivFromAxis () const
 
QPalette palette () const
 
double position () const
 
 QwtPlotScaleItem (QwtScaleDraw::Alignment=QwtScaleDraw::BottomScale, const double pos=0.0)
 Constructor for scale item at the position pos. More...
 
virtual int rtti () const
 
const QwtScaleDivscaleDiv () const
 
const QwtScaleDrawscaleDraw () const
 
QwtScaleDrawscaleDraw ()
 
void setAlignment (QwtScaleDraw::Alignment)
 
void setBorderDistance (int numPixels)
 Align the scale to the canvas. More...
 
void setFont (const QFont &)
 
void setPalette (const QPalette &)
 
void setPosition (double pos)
 
void setScaleDiv (const QwtScaleDiv &)
 Assign a scale division. More...
 
void setScaleDivFromAxis (bool on)
 
void setScaleDraw (QwtScaleDraw *)
 Set a scale draw. More...
 
virtual void updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &)
 Update the item to changes of the axes scale division. More...
 
virtual ~QwtPlotScaleItem ()
 Destructor. More...
 
- Public Member Functions inherited from QwtPlotItem
void attach (QwtPlot *plot)
 Attach the item to a plot. More...
 
virtual QRectF boundingRect () const
 
void detach ()
 This method detaches a QwtPlotItem from any QwtPlot it has been associated with. More...
 
virtual void getCanvasMarginHint (const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasSize, double &left, double &top, double &right, double &bottom) const
 Calculate a hint for the canvas margin. More...
 
void hide ()
 Hide the item. More...
 
bool isVisible () const
 
virtual void itemChanged ()
 
virtual void legendChanged ()
 
virtual QList< QwtLegendDatalegendData () const
 Return all information, that is needed to represent the item on the legend. More...
 
virtual QwtGraphic legendIcon (int index, const QSizeF &) const
 
QSize legendIconSize () const
 
QRectF paintRect (const QwtScaleMap &, const QwtScaleMap &) const
 Calculate the bounding paint rectangle of 2 maps. More...
 
QwtPlotplot () const
 Return attached plot. More...
 
 QwtPlotItem (const QwtText &title=QwtText())
 
uint renderThreadCount () const
 
QRectF scaleRect (const QwtScaleMap &, const QwtScaleMap &) const
 Calculate the bounding scale rectangle of 2 maps. More...
 
void setAxes (int xAxis, int yAxis)
 
void setItemAttribute (ItemAttribute, bool on=true)
 
void setItemInterest (ItemInterest, bool on=true)
 
void setLegendIconSize (const QSize &)
 
void setRenderHint (RenderHint, bool on=true)
 
void setRenderThreadCount (uint numThreads)
 
void setTitle (const QString &title)
 
void setTitle (const QwtText &title)
 
virtual void setVisible (bool)
 
void setXAxis (int axis)
 
void setYAxis (int axis)
 
void setZ (double z)
 Set the z value. More...
 
void show ()
 Show the item. More...
 
bool testItemAttribute (ItemAttribute) const
 
bool testItemInterest (ItemInterest) const
 
bool testRenderHint (RenderHint) const
 
const QwtTexttitle () const
 
virtual void updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &)
 Update the item to changes of the legend info. More...
 
int xAxis () const
 Return xAxis. More...
 
int yAxis () const
 Return yAxis. More...
 
double z () const
 
virtual ~QwtPlotItem ()
 Destroy the QwtPlotItem. More...
 

Private Attributes

PrivateDatad_data
 

Additional Inherited Members

- Public Types inherited from QwtPlotItem
enum  ItemAttribute { Legend = 0x01, AutoScale = 0x02, Margins = 0x04 }
 Plot Item Attributes. More...
 
typedef QFlags< ItemAttributeItemAttributes
 Plot Item Attributes. More...
 
enum  ItemInterest { ScaleInterest = 0x01, LegendInterest = 0x02 }
 Plot Item Interests. More...
 
typedef QFlags< ItemInterestItemInterests
 Plot Item Interests. More...
 
enum  RenderHint { RenderAntialiased = 0x1 }
 Render hints. More...
 
typedef QFlags< RenderHintRenderHints
 Render hints. More...
 
enum  RttiValues {
  Rtti_PlotItem = 0, Rtti_PlotGrid, Rtti_PlotScale, Rtti_PlotLegend,
  Rtti_PlotMarker, Rtti_PlotCurve, Rtti_PlotSpectroCurve, Rtti_PlotIntervalCurve,
  Rtti_PlotHistogram, Rtti_PlotSpectrogram, Rtti_PlotSVG, Rtti_PlotTradingCurve,
  Rtti_PlotBarChart, Rtti_PlotMultiBarChart, Rtti_PlotShape, Rtti_PlotTextLabel,
  Rtti_PlotZone, Rtti_PlotUserItem = 1000
}
 Runtime type information. More...
 
- Protected Member Functions inherited from QwtPlotItem
QwtGraphic defaultIcon (const QBrush &, const QSizeF &) const
 Return a default icon from a brush. More...
 

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 by 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 (f.e 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(QwtPlot::yLeft)->font());
scaleItem->attach(plot);

plot->enableAxis(QwtPlot::yLeft, false);

Definition at line 47 of file qwt_plot_scaleitem.h.

Constructor & Destructor Documentation

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

Constructor for scale item at the position pos.

Parameters
alignmentIn case of QwtScaleDraw::BottomScale or QwtScaleDraw::TopScale the scale item is corresponding to the xAxis(), otherwise it corresponds to the yAxis().
posx or y position, depending on the corresponding axis.
See also
setPosition(), setAlignment()

Definition at line 73 of file qwt_plot_scaleitem.cpp.

QwtPlotScaleItem::~QwtPlotScaleItem ( )
virtual

Destructor.

Definition at line 86 of file qwt_plot_scaleitem.cpp.

Member Function Documentation

int QwtPlotScaleItem::borderDistance ( ) const
Returns
Distance from a canvas border
See also
setBorderDistance(), setPosition()

Definition at line 310 of file qwt_plot_scaleitem.cpp.

void QwtPlotScaleItem::draw ( QPainter *  p,
const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  rect 
) const
virtual

Draw the scale.

Implements QwtPlotItem.

Definition at line 344 of file qwt_plot_scaleitem.cpp.

QFont QwtPlotScaleItem::font ( ) const
Returns
tick label font
See also
setFont()

Definition at line 194 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.
See also
setScaleDiv(), setScaleDivFromAxis()

Definition at line 148 of file qwt_plot_scaleitem.cpp.

QPalette QwtPlotScaleItem::palette ( ) const
Returns
palette
See also
setPalette()

Definition at line 172 of file qwt_plot_scaleitem.cpp.

double QwtPlotScaleItem::position ( ) const
Returns
Position of the scale
See also
setPosition(), setAlignment()

Definition at line 273 of file qwt_plot_scaleitem.cpp.

int QwtPlotScaleItem::rtti ( ) const
virtual
Returns
QwtPlotItem::Rtti_PlotScale

Reimplemented from QwtPlotItem.

Definition at line 92 of file qwt_plot_scaleitem.cpp.

const QwtScaleDiv & QwtPlotScaleItem::scaleDiv ( ) const
Returns
Scale division

Definition at line 113 of file qwt_plot_scaleitem.cpp.

const QwtScaleDraw * QwtPlotScaleItem::scaleDraw ( ) const
Returns
Scale draw
See also
setScaleDraw()

Definition at line 234 of file qwt_plot_scaleitem.cpp.

QwtScaleDraw * QwtPlotScaleItem::scaleDraw ( )
Returns
Scale draw
See also
setScaleDraw()

Definition at line 243 of file qwt_plot_scaleitem.cpp.

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

Change the alignment of the scale

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

For horizontal scales the position corresponds to QwtPlotItem::yAxis(), otherwise to QwtPlotItem::xAxis().

See also
scaleDraw(), QwtScaleDraw::alignment(), setPosition()

Definition at line 331 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
distanceNumber of pixels between the canvas border and the backbone of the scale.
See also
setPosition(), borderDistance()

Definition at line 294 of file qwt_plot_scaleitem.cpp.

void QwtPlotScaleItem::setFont ( const QFont &  font)

Change the tick label font

See also
font()

Definition at line 181 of file qwt_plot_scaleitem.cpp.

void QwtPlotScaleItem::setPalette ( const QPalette &  palette)

Set the palette

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

Definition at line 157 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
posNew position
See also
position(), setAlignment()

Definition at line 259 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.

Parameters
scaleDivScale division
See also
scaleDiv(), setScaleDivFromAxis(), isScaleDivFromAxis()

Definition at line 106 of file qwt_plot_scaleitem.cpp.

void QwtPlotScaleItem::setScaleDivFromAxis ( bool  on)

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

Parameters
ontrue/false
See also
isScaleDivFromAxis()

Definition at line 125 of file qwt_plot_scaleitem.cpp.

void QwtPlotScaleItem::setScaleDraw ( QwtScaleDraw scaleDraw)

Set a scale draw.

Parameters
scaleDrawobject 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()

Definition at line 210 of file qwt_plot_scaleitem.cpp.

void QwtPlotScaleItem::updateScaleDiv ( const QwtScaleDiv xScaleDiv,
const QwtScaleDiv yScaleDiv 
)
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
xScaleDivScale division of the x-axis
yScaleDivScale division of the y-axis
See also
QwtPlot::updateAxes()

Reimplemented from QwtPlotItem.

Definition at line 443 of file qwt_plot_scaleitem.cpp.

Member Data Documentation

PrivateData* QwtPlotScaleItem::d_data
private

Definition at line 90 of file qwt_plot_scaleitem.h.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Sat Jul 6 2019 03:44:18