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

QwtPlotBarChart - QwtPlotBarChart displays a series of a values as bars.

Author

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

Version 6.1.4                                    Wed Jan 2 2019                               QwtPlotBarChart(3)

Constructor & Destructor Documentation

QwtPlotBarChart::QwtPlotBarChart(constQString&title=QString())[explicit]
       Constructor

       Parameters:title Title of the curve

   QwtPlotBarChart::QwtPlotBarChart(constQwtText&title)[explicit]
       Constructor

       Parameters:title Title of the curve

Detailed Description

QwtPlotBarChart displays a series of a values as bars.

       Each bar might be customized individually by implementing a specialSymbol(). Otherwise it is rendered
       using a default symbol.

       Depending on its orientation() the bars are displayed horizontally or vertically. The bars cover the
       interval between the baseline() and the value.

       By activating the LegendBarTitles mode each sample will have its own entry on the legend.

       The most common use case of a bar chart is to display a list of y coordinates, where the x coordinate is
       simply the index in the list. But for other situations ( f.e. when values are related to dates ) it is
       also possible to set x coordinates explicitly.

       Seealso:QwtPlotMultiBarChart, QwtPlotHistogram, QwtPlotCurve::Sticks, QwtPlotSeriesItem::orientation(),
           QwtPlotAbstractBarChart::baseline()

Member Enumeration Documentation

enumQwtPlotBarChart::LegendMode
       Legend modes. The default setting is QwtPlotBarChart::LegendChartTitle.

       Seealso:setLegendMode(), legendMode()EnumeratorLegendChartTitle
              One entry on the legend showing the default symbol and the title() of the chart

       Seealso:QwtPlotItem::title()LegendBarTitles
              One entry for each value showing the individual symbol of the corresponding bar and the bar title.

       Seealso:specialSymbol(), barTitle()

Member Function Documentation

QwtTextQwtPlotBarChart::barTitle(intsampleIndex)const[virtual]
       Return  the  title  of  a  bar.  In  LegendBarTitles  mode  the  title  is  displayed on the legend entry
       corresponding to a bar.

       The default implementation is a dummy, that is intended to be overloaded.

       Parameters:sampleIndex Index of the bar

       Returns:
           An empty text

       Seealso:LegendBarTitlesQRectFQwtPlotBarChart::boundingRect()const[virtual]Returns:
           Bounding rectangle of all samples. For an empty series the rectangle is invalid.

       Reimplemented from QwtPlotSeriesItem.

   voidQwtPlotBarChart::drawBar(QPainter*painter,intsampleIndex,constQPointF&sample,constQwtColumnRect&rect)const[protected],[virtual]
       Draw a bar

       Parameters:painter Painter
           sampleIndex Index of the sample represented by the bar
           sample Value of the sample
           rect Bounding rectangle of the bar

   voidQwtPlotBarChart::drawSample(QPainter*painter,constQwtScaleMap&xMap,constQwtScaleMap&yMap,constQRectF&canvasRect,constQwtInterval&boundingInterval,intindex,constQPointF&sample)const[protected],[virtual]
       Draw a sample

       Parameters:painter Painter
           xMap x map
           yMap y map
           canvasRect Contents rect of the canvas
           boundingInterval Bounding interval of sample values
           index Index of the sample
           sample Value of the sample

       Seealso:drawSeries()voidQwtPlotBarChart::drawSeries(QPainter*painter,constQwtScaleMap&xMap,constQwtScaleMap&yMap,constQRectF&canvasRect,intfrom,intto)const[virtual]
       Draw an interval of the bar chart

       Parameters:painter Painter
           xMap Maps x-values into pixel coordinates.
           yMap Maps y-values into pixel coordinates.
           canvasRect Contents rect of the canvas
           from Index of the first point to be painted
           to Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

       Seealso:
           drawSymbols()

       Implements QwtPlotSeriesItem.

   QList<QwtLegendData>QwtPlotBarChart::legendData()const[protected],[virtual]
       Return all information, that is needed to represent the item on the legend. In case of LegendBarTitles an
       entry  for  each  bar  is  returned, otherwise the chart is represented like any other plot item from its
       title() and the legendIcon().

       Returns:
           Information, that is needed to represent the item on the legend

       Seealso:title(), setLegendMode(), barTitle(), QwtLegend, QwtPlotLegendItem

       Reimplemented from QwtPlotItem.

   QwtGraphicQwtPlotBarChart::legendIcon(intindex,constQSizeF&size)const[protected],[virtual]Returns:
           Icon representing a bar or the chart on the legend

       When the legendMode() is LegendBarTitles the icon shows the bar corresponding to index  -  otherwise  the
       bar displays the default symbol.

       Parameters:index Index of the legend entry
           size Icon size

       Seealso:setLegendMode(), drawBar(), QwtPlotItem::setLegendIconSize(), QwtPlotItem::legendData()

       Reimplemented from QwtPlotItem.

   QwtPlotBarChart::LegendModeQwtPlotBarChart::legendMode()constReturns:
           Legend mode

       Seealso:setLegendMode()intQwtPlotBarChart::rtti()const[virtual]Returns:QwtPlotItem::Rtti_PlotBarChart

       Reimplemented from QwtPlotItem.

   voidQwtPlotBarChart::setLegendMode(LegendModemode)
       Set the mode that decides what to display on the legend

       In case of LegendBarTitles barTitle() needs to be overloaded to return individual titles for each bar.

       Parameters:mode New mode

       Seealso:legendMode(), legendData(), barTitle(), QwtPlotItem::ItemAttributevoidQwtPlotBarChart::setSamples(constQVector<QPointF>&samples)
       Initialize data with an array of points

       Parameters:samples Vector of points

       Note:
           QVector is implicitly shared

           QPolygonF is derived from QVector<QPointF>

   voidQwtPlotBarChart::setSamples(constQVector<double>&samples)
       Initialize data with an array of doubles

       The indices in the array are taken as x coordinate, while the doubles are interpreted as y values.

       Parameters:samples Vector of y coordinates

       Note:
           QVector is implicitly shared

   voidQwtPlotBarChart::setSamples(QwtSeriesData<QPointF>*data)
       Assign a series of samples

       setSamples()  is  just a wrapper for setData() without any additional value - beside that it is easier to
       find for the developer.

       Parameters:data Data

       Warning:
           The item takes ownership of the data object, deleting it when its not used anymore.

   voidQwtPlotBarChart::setSymbol(QwtColumnSymbol*symbol)
       Assign a symbol. The bar chart will take the ownership of the symbol, hence  the  previously  set  symbol
       will be delete by setting a new one. If symbol is NULL no symbol will be drawn.

       Parameters:symbol Symbol

       Seealso:symbol()QwtColumnSymbol*QwtPlotBarChart::specialSymbol(intsampleIndex,constQPointF&sample)const[virtual]
       Needs to be overloaded to return a non default symbol for a specific sample

       Parameters:sampleIndex Index of the sample represented by the bar
           sample Value of the sample

       Returns:
           NULL, indicating to use the default symbol

   constQwtColumnSymbol*QwtPlotBarChart::symbol()constReturns:
           Current symbol or NULL, when no symbol has been assigned

       Seealso:setSymbol()

Name

       QwtPlotBarChart - QwtPlotBarChart displays a series of a values as bars.

Synopsis

       #include <qwt_plot_barchart.h>

       Inherits QwtPlotAbstractBarChart, and QwtSeriesStore<QPointF>.

   PublicTypes
       enum LegendMode { LegendChartTitle, LegendBarTitles }
           Legend modes.

   PublicMemberFunctionsQwtPlotBarChart (const QString &title=QString())
       QwtPlotBarChart (const QwtText &title)
       virtual ~QwtPlotBarChart ()
           Destructor.
       virtual int rtti () const
       void setSamples (const QVector< QPointF > &)
       void setSamples (const QVector< double > &)
       void setSamples (QwtSeriesData< QPointF > *)
       void setSymbol (QwtColumnSymbol *)
           Assign a symbol.
       const QwtColumnSymbol * symbol () const
       void setLegendMode (LegendMode)
       LegendModelegendMode () const
       virtual void drawSeries (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const
           QRectF &canvasRect, int from, int to) const
       virtual QRectF boundingRect () const
       virtual QwtColumnSymbol * specialSymbol (int sampleIndex, const QPointF &) const
       virtual QwtTextbarTitle (int sampleIndex) const
           Return the title of a bar.

   ProtectedMemberFunctions
       virtual void drawSample (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const
           QRectF &canvasRect, const QwtInterval &boundingInterval, int index, const QPointF &sample) const
       virtual void drawBar (QPainter *, int sampleIndex, const QPointF &sample, const QwtColumnRect &) const
       QList< QwtLegendData > legendData () const
           Return all information, that is needed to represent the item on the legend.
       QwtGraphiclegendIcon (int index, const QSizeF &) const

See Also