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

QwtPlotAbstractBarChart - Abstract base class for bar chart items.

Author

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

Version 6.1.4                                    Wed Jan 2 2019                       QwtPlotAbstractBarChart(3)

Constructor & Destructor Documentation

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

       Parameters:title Title of the chart

Detailed Description

       Abstract base class for bar chart items.

       In opposite to almost all other plot items bar charts can't be displayed inside of their bounding
       rectangle and need a special API how to calculate the width of the bars and how they affect the layout of
       the attached plot.

Member Enumeration Documentation

enumQwtPlotAbstractBarChart::LayoutPolicy
       Mode how to calculate the bar width. setLayoutPolicy(), setLayoutHint(), barWidthHint()

       EnumeratorAutoAdjustSamples
              The  sample  width  is calculated by dividing the bounding rectangle by the number of samples. The
              layoutHint() is used as a minimum width in paint device coordinates.

       Seealso:
           boundingRectangle()

       ScaleSamplesToAxeslayoutHint() defines an interval in axis coordinates

       ScaleSampleToCanvas
              The bar width is calculated by multiplying layoutHint() with the height or width of the canvas.

       Seealso:
           boundingRectangle()

       FixedSampleSizelayoutHint() defines a fixed width in paint device coordinates.

Member Function Documentation

doubleQwtPlotAbstractBarChart::baseline()constReturns:
           Value for the origin of the bar chart

       Seealso:setBaseline(), QwtPlotSeriesItem::orientation()voidQwtPlotAbstractBarChart::getCanvasMarginHint(constQwtScaleMap&xMap,constQwtScaleMap&yMap,constQRectF&canvasRect,double&left,double&top,double&right,double&bottom)const[virtual]
       Calculate a hint for the canvas margin. Bar charts need to reserve some space for displaying the bars for
       the  first  and  the  last  sample.  The  hint  is  calculated  from  the  layoutHint()  depending on the
       layoutPolicy().

       The margins are in target device coordinates ( pixels on screen )

       Parameters:xMap Maps x-values into pixel coordinates.
           yMap Maps y-values into pixel coordinates.
           canvasRect Contents rectangle of the canvas in painter coordinates
           left Returns the left margin
           top Returns the top margin
           right Returns the right margin
           bottom Returns the bottom margin

       Returns:
           Margin

       Seealso:layoutPolicy(),       layoutHint(),       QwtPlotItem::MarginsQwtPlot::getCanvasMarginsHint(),
           QwtPlot::updateCanvasMargins()

       Reimplemented from QwtPlotItem.

   doubleQwtPlotAbstractBarChart::layoutHint()const
       The combination of layoutPolicy() and layoutHint() define how the width of the bars is calculated

       Returns:
           Layout policy of the chart item

       Seealso:LayoutPolicy, setLayoutHint(), layoutPolicy()QwtPlotAbstractBarChart::LayoutPolicyQwtPlotAbstractBarChart::layoutPolicy()const
       The combination of layoutPolicy() and layoutHint() define how the width of the bars is calculated

       Returns:
           Layout policy of the chart item

       Seealso:setLayoutPolicy(), layoutHint()intQwtPlotAbstractBarChart::margin()constReturns:
           Margin between the outmost bars and the contentsRect() of the canvas.

       Seealso:setMargin(), spacing()doubleQwtPlotAbstractBarChart::sampleWidth(constQwtScaleMap&map,doublecanvasSize,doubleboundingSize,doublevalue)const[protected]
       Calculate the width for a sample in paint device coordinates

       Parameters:map Scale map for the corresponding scale
           canvasSize Size of the canvas in paint device coordinates
           boundingSize Bounding size of the chart in plot coordinates ( used in AutoAdjustSamples mode )
           value Value of the sample

       Returns:
           Sample width

       Seealso:layoutPolicy(), layoutHint()voidQwtPlotAbstractBarChart::setBaseline(doublevalue)
       Set  the baseline. The baseline is the origin for the chart. Each bar is painted from the baseline in the
       direction of the sample value. In case of a horizontal orientation() the baseline is interpreted as  x  -
       otherwise as y - value.

       The default value for the baseline is 0.

       Parameters:value Value for the baseline

       Seealso:baseline(), QwtPlotSeriesItem::orientation()voidQwtPlotAbstractBarChart::setLayoutHint(doublehint)
       The combination of layoutPolicy() and layoutHint() define how the width of the bars is calculated

       Parameters:hint Layout hint

       Seealso:LayoutPolicy, layoutPolicy(), layoutHint()voidQwtPlotAbstractBarChart::setLayoutPolicy(LayoutPolicypolicy)
       The combination of layoutPolicy() and layoutHint() define how the width of the bars is calculated

       Parameters:policy Layout policy

       Seealso:layoutPolicy(), layoutHint()voidQwtPlotAbstractBarChart::setMargin(intmargin)
       Set the margin. The margin is the distance between the outmost bars and the contentsRect() of the canvas.
       The default setting is 5 pixels.

       Parameters:margin Margin

       Seealso:spacing(), margin()voidQwtPlotAbstractBarChart::setSpacing(intspacing)
       Set  the  spacing. The spacing is the distance between 2 samples ( bars for QwtPlotBarChart or a group of
       bars for QwtPlotMultiBarChart ) in paint device coordinates.

       Seealso:spacing()intQwtPlotAbstractBarChart::spacing()constReturns:
           Spacing between 2 samples ( bars or groups of bars )

       Seealso:setSpacing(), margin()

Name

       QwtPlotAbstractBarChart - Abstract base class for bar chart items.

Synopsis

       #include <qwt_plot_abstract_barchart.h>

       Inherits QwtPlotSeriesItem.

       Inherited by QwtPlotBarChart, and QwtPlotMultiBarChart.

   PublicTypes
       enum LayoutPolicy { AutoAdjustSamples, ScaleSamplesToAxes, ScaleSampleToCanvas, FixedSampleSize }
           Mode how to calculate the bar width.

   PublicMemberFunctionsQwtPlotAbstractBarChart (const QwtText &title)
       virtual ~QwtPlotAbstractBarChart ()
           Destructor.
       void setLayoutPolicy (LayoutPolicy)
       LayoutPolicylayoutPolicy () const
       void setLayoutHint (double)
       double layoutHint () const
       void setSpacing (int)
           Set the spacing.
       int spacing () const
       void setMargin (int)
           Set the margin.
       int margin () const
       void setBaseline (double)
           Set the baseline.
       double baseline () 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.

   ProtectedMemberFunctions
       double sampleWidth (const QwtScaleMap &map, double canvasSize, double boundingSize, double value) const

See Also