Classes | Public Types | Public Member Functions | Protected Member Functions | Private Attributes
QwtPlotAbstractBarChart Class Reference

Abstract base class for bar chart items. More...

#include <qwt_plot_abstract_barchart.h>

Inheritance diagram for QwtPlotAbstractBarChart:
Inheritance graph
[legend]

List of all members.

Classes

class  PrivateData

Public Types

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

Public Member Functions

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

Protected Member Functions

double sampleWidth (const QwtScaleMap &map, double canvasSize, double dataSize, double value) const

Private Attributes

PrivateDatad_data

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.

Definition at line 25 of file qwt_plot_abstract_barchart.h.


Member Enumeration Documentation

Mode how to calculate the bar width.

setLayoutPolicy(), setLayoutHint(), barWidthHint()

Enumerator:
AutoAdjustSamples 

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.

See also:
boundingRectangle()
ScaleSamplesToAxes 

layoutHint() defines an interval in axis coordinates

ScaleSampleToCanvas 

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

See also:
boundingRectangle()
FixedSampleSize 

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

Definition at line 33 of file qwt_plot_abstract_barchart.h.


Constructor & Destructor Documentation

Constructor

Parameters:
titleTitle of the chart

Definition at line 47 of file qwt_plot_abstract_barchart.cpp.

Destructor.

Definition at line 59 of file qwt_plot_abstract_barchart.cpp.


Member Function Documentation

Returns:
Value for the origin of the bar chart
See also:
setBaseline(), QwtPlotSeriesItem::orientation()

Definition at line 207 of file qwt_plot_abstract_barchart.cpp.

void QwtPlotAbstractBarChart::getCanvasMarginHint ( const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  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:
xMapMaps x-values into pixel coordinates.
yMapMaps y-values into pixel coordinates.
canvasRectContents rectangle of the canvas in painter coordinates
leftReturns the left margin
topReturns the top margin
rightReturns the right margin
bottomReturns the bottom margin
Returns:
Margin
See also:
layoutPolicy(), layoutHint(), QwtPlotItem::Margins QwtPlot::getCanvasMarginsHint(), QwtPlot::updateCanvasMargins()

Reimplemented from QwtPlotItem.

Definition at line 288 of file qwt_plot_abstract_barchart.cpp.

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

Returns:
Layout policy of the chart item
See also:
LayoutPolicy, setLayoutHint(), layoutPolicy()

Definition at line 118 of file qwt_plot_abstract_barchart.cpp.

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

Returns:
Layout policy of the chart item
See also:
setLayoutPolicy(), layoutHint()

Definition at line 88 of file qwt_plot_abstract_barchart.cpp.

Returns:
Margin between the outmost bars and the contentsRect() of the canvas.
See also:
setMargin(), spacing()

Definition at line 175 of file qwt_plot_abstract_barchart.cpp.

double QwtPlotAbstractBarChart::sampleWidth ( const QwtScaleMap map,
double  canvasSize,
double  boundingSize,
double  value 
) const [protected]

Calculate the width for a sample in paint device coordinates

Parameters:
mapScale map for the corresponding scale
canvasSizeSize of the canvas in paint device coordinates
boundingSizeBounding size of the chart in plot coordinates ( used in AutoAdjustSamples mode )
valueValue of the sample
Returns:
Sample width
See also:
layoutPolicy(), layoutHint()

Definition at line 224 of file qwt_plot_abstract_barchart.cpp.

void QwtPlotAbstractBarChart::setBaseline ( double  value)

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:
valueValue for the baseline
See also:
baseline(), QwtPlotSeriesItem::orientation()

Definition at line 194 of file qwt_plot_abstract_barchart.cpp.

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

Parameters:
hintLayout hint
See also:
LayoutPolicy, layoutPolicy(), layoutHint()

Definition at line 101 of file qwt_plot_abstract_barchart.cpp.

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

Parameters:
policyLayout policy
See also:
layoutPolicy(), layoutHint()

Definition at line 72 of file qwt_plot_abstract_barchart.cpp.

void QwtPlotAbstractBarChart::setMargin ( int  margin)

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:
marginMargin
See also:
spacing(), margin()

Definition at line 159 of file qwt_plot_abstract_barchart.cpp.

void QwtPlotAbstractBarChart::setSpacing ( int  spacing)

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.

See also:
spacing()

Definition at line 131 of file qwt_plot_abstract_barchart.cpp.

Returns:
Spacing between 2 samples ( bars or groups of bars )
See also:
setSpacing(), margin()

Definition at line 145 of file qwt_plot_abstract_barchart.cpp.


Member Data Documentation

Reimplemented from QwtPlotSeriesItem.

Reimplemented in QwtPlotMultiBarChart, and QwtPlotBarChart.

Definition at line 93 of file qwt_plot_abstract_barchart.h.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Fri Sep 1 2017 02:41:57