logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

QwtPlotScaleItem - A class which draws a scale inside the plot canvas.

Author

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

Version 6.1.4                                    Wed Jan 2 2019                              QwtPlotScaleItem(3)

Constructor & Destructor Documentation

QwtPlotScaleItem::QwtPlotScaleItem(QwtScaleDraw::Alignmentalignment=QwtScaleDraw::BottomScale,constdoublepos=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.

       Seealso:setPosition(), setAlignment()

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 );

Member Function Documentation

intQwtPlotScaleItem::borderDistance()constReturns:
           Distance from a canvas border

       Seealso:setBorderDistance(), setPosition()QFontQwtPlotScaleItem::font()constReturns:
           tick label font

       Seealso:setFont()boolQwtPlotScaleItem::isScaleDivFromAxis()constReturns:
           True, if the synchronization of the scale division with the corresponding axis is enabled.

       Seealso:setScaleDiv(), setScaleDivFromAxis()QPaletteQwtPlotScaleItem::palette()constReturns:
           palette

       Seealso:setPalette()doubleQwtPlotScaleItem::position()constReturns:
           Position of the scale

       Seealso:setPosition(), setAlignment()intQwtPlotScaleItem::rtti()const[virtual]Returns:QwtPlotItem::Rtti_PlotScale

       Reimplemented from QwtPlotItem.

   constQwtScaleDiv&QwtPlotScaleItem::scaleDiv()constReturns:
           Scale division

   constQwtScaleDraw*QwtPlotScaleItem::scaleDraw()constReturns:
           Scale draw

       Seealso:setScaleDraw()QwtScaleDraw*QwtPlotScaleItem::scaleDraw()Returns:
           Scale draw

       Seealso:setScaleDraw()voidQwtPlotScaleItem::setAlignment(QwtScaleDraw::Alignmentalignment)
       Change the alignment of the scale

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

       Seealso:scaleDraw(), QwtScaleDraw::alignment(), setPosition()voidQwtPlotScaleItem::setBorderDistance(intdistance)
       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.

       Seealso:setPosition(), borderDistance()voidQwtPlotScaleItem::setFont(constQFont&font)
       Change the tick label font

       Seealso:font()voidQwtPlotScaleItem::setPalette(constQPalette&palette)
       Set the palette

       Seealso:QwtAbstractScaleDraw::draw(), palette()voidQwtPlotScaleItem::setPosition(doublepos)
       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

       Seealso:position(), setAlignment()voidQwtPlotScaleItem::setScaleDiv(constQwtScaleDiv&scaleDiv)
       Assign a scale division. When assigning a scaleDiv the scale division  won't  be  synchronized  with  the
       corresponding axis anymore.

       Parameters:scaleDiv Scale division

       Seealso:scaleDiv(), setScaleDivFromAxis(), isScaleDivFromAxis()voidQwtPlotScaleItem::setScaleDivFromAxis(boolon)
       Enable/Disable the synchronization of the scale division with the corresponding axis.

       Parameters:on true/false

       Seealso:isScaleDivFromAxis()voidQwtPlotScaleItem::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.

       Seealso:scaleDraw()voidQwtPlotScaleItem::updateScaleDiv(constQwtScaleDiv&xScaleDiv,constQwtScaleDiv&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:xScaleDiv Scale division of the x-axis
           yScaleDiv Scale division of the y-axis

       Seealso:QwtPlot::updateAxes()

       Reimplemented from QwtPlotItem.

Name

       QwtPlotScaleItem - A class which draws a scale inside the plot canvas.

Synopsis

       #include <qwt_plot_scaleitem.h>

       Inherits QwtPlotItem.

   PublicMemberFunctionsQwtPlotScaleItem (QwtScaleDraw::Alignment=QwtScaleDraw::BottomScale, const double pos=0.0)
           Constructor for scale item at the position pos.
       virtual ~QwtPlotScaleItem ()
           Destructor.
       virtual int rtti () const
       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
           Draw the scale.
       virtual void updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &)
           Update the item to changes of the axes scale division.

   AdditionalInheritedMembers

See Also