Qwt User's Guide  6.1.3
QwtPlotMultiBarChart Class Reference

QwtPlotMultiBarChart displays a series of a samples that consist each of a set of values. More...

#include <qwt_plot_multi_barchart.h>

Inheritance diagram for QwtPlotMultiBarChart:

Public Types

enum  ChartStyle { Grouped, Stacked }
 Chart styles. More...
 
- Public Types inherited from QwtPlotAbstractBarChart
enum  LayoutPolicy { AutoAdjustSamples, ScaleSamplesToAxes, ScaleSampleToCanvas, FixedSampleSize }
 Mode how to calculate the bar width. More...
 
- Public Types inherited from QwtPlotItem
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...
 
enum  ItemAttribute { Legend = 0x01, AutoScale = 0x02, Margins = 0x04 }
 Plot Item Attributes. More...
 
enum  ItemInterest { ScaleInterest = 0x01, LegendInterest = 0x02 }
 Plot Item Interests. More...
 
enum  RenderHint { RenderAntialiased = 0x1 }
 Render hints. More...
 
typedef QFlags< ItemAttributeItemAttributes
 Plot Item Attributes.
 
typedef QFlags< ItemInterestItemInterests
 Plot Item Interests.
 
typedef QFlags< RenderHintRenderHints
 Render hints.
 

Public Member Functions

 QwtPlotMultiBarChart (const QString &title=QString::null)
 
 QwtPlotMultiBarChart (const QwtText &title)
 
virtual ~QwtPlotMultiBarChart ()
 Destructor.
 
virtual int rtti () const
 
void setBarTitles (const QList< QwtText > &)
 Set the titles for the bars. More...
 
QList< QwtTextbarTitles () const
 
void setSamples (const QVector< QwtSetSample > &)
 
void setSamples (const QVector< QVector< double > > &)
 
void setSamples (QwtSeriesData< QwtSetSample > *)
 
void setStyle (ChartStyle style)
 
ChartStyle style () const
 
void setSymbol (int barIndex, QwtColumnSymbol *symbol)
 Add a symbol to the symbol map. More...
 
const QwtColumnSymbolsymbol (int barIndex) const
 
void resetSymbolMap ()
 
virtual void drawSeries (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, int from, int to) const
 
virtual QRectF boundingRect () const
 
virtual QList< QwtLegendDatalegendData () const
 
virtual QwtGraphic legendIcon (int index, const QSizeF &) const
 
- Public Member Functions inherited from QwtPlotAbstractBarChart
 QwtPlotAbstractBarChart (const QwtText &title)
 
virtual ~QwtPlotAbstractBarChart ()
 Destructor.
 
void setLayoutPolicy (LayoutPolicy)
 
LayoutPolicy layoutPolicy () const
 
void setLayoutHint (double)
 
double layoutHint () const
 
void setSpacing (int)
 Set the spacing. More...
 
int spacing () const
 
void setMargin (int)
 Set the margin. More...
 
int margin () const
 
void setBaseline (double)
 Set the baseline. More...
 
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. More...
 
- Public Member Functions inherited from QwtPlotSeriesItem
 QwtPlotSeriesItem (const QString &title=QString::null)
 
 QwtPlotSeriesItem (const QwtText &title)
 
virtual ~QwtPlotSeriesItem ()
 Destructor.
 
void setOrientation (Qt::Orientation)
 
Qt::Orientation orientation () const
 
virtual void draw (QPainter *p, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &) const
 Draw the complete series. More...
 
virtual void updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &)
 Update the item to changes of the axes scale division. More...
 
- Public Member Functions inherited from QwtPlotItem
 QwtPlotItem (const QwtText &title=QwtText())
 
virtual ~QwtPlotItem ()
 Destroy the QwtPlotItem.
 
void attach (QwtPlot *plot)
 Attach the item to a plot. More...
 
void detach ()
 This method detaches a QwtPlotItem from any QwtPlot it has been associated with. More...
 
QwtPlotplot () const
 Return attached plot.
 
void setTitle (const QString &title)
 
void setTitle (const QwtText &title)
 
const QwtTexttitle () const
 
void setItemAttribute (ItemAttribute, bool on=true)
 
bool testItemAttribute (ItemAttribute) const
 
void setItemInterest (ItemInterest, bool on=true)
 
bool testItemInterest (ItemInterest) const
 
void setRenderHint (RenderHint, bool on=true)
 
bool testRenderHint (RenderHint) const
 
void setRenderThreadCount (uint numThreads)
 
uint renderThreadCount () const
 
void setLegendIconSize (const QSize &)
 
QSize legendIconSize () const
 
double z () const
 
void setZ (double z)
 Set the z value. More...
 
void show ()
 Show the item.
 
void hide ()
 Hide the item.
 
virtual void setVisible (bool)
 
bool isVisible () const
 
void setAxes (int xAxis, int yAxis)
 
void setXAxis (int axis)
 
int xAxis () const
 Return xAxis.
 
void setYAxis (int axis)
 
int yAxis () const
 Return yAxis.
 
virtual void itemChanged ()
 
virtual void legendChanged ()
 
virtual void updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &)
 Update the item to changes of the legend info. More...
 
QRectF scaleRect (const QwtScaleMap &, const QwtScaleMap &) const
 Calculate the bounding scale rectangle of 2 maps. More...
 
QRectF paintRect (const QwtScaleMap &, const QwtScaleMap &) const
 Calculate the bounding paint rectangle of 2 maps. More...
 
- Public Member Functions inherited from QwtSeriesStore< QwtSetSample >
 QwtSeriesStore ()
 Constructor The store contains no series.
 
 ~QwtSeriesStore ()
 Destructor.
 
void setData (QwtSeriesData< QwtSetSample > *series)
 
QwtSeriesData< QwtSetSample > * data ()
 
const QwtSeriesData< QwtSetSample > * data () const
 
QwtSetSample sample (int index) const
 
virtual size_t dataSize () const
 
virtual QRectF dataRect () const
 
virtual void setRectOfInterest (const QRectF &rect)
 
QwtSeriesData< QwtSetSample > * swapData (QwtSeriesData< QwtSetSample > *series)
 

Protected Member Functions

QwtColumnSymbolsymbol (int barIndex)
 
virtual QwtColumnSymbolspecialSymbol (int sampleIndex, int valueIndex) const
 Create a symbol for special values. More...
 
virtual void drawSample (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, const QwtInterval &boundingInterval, int index, const QwtSetSample &sample) const
 
virtual void drawBar (QPainter *, int sampleIndex, int barIndex, const QwtColumnRect &) const
 
void drawStackedBars (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, int index, double sampleWidth, const QwtSetSample &sample) const
 
void drawGroupedBars (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, int index, double sampleWidth, const QwtSetSample &sample) const
 
- Protected Member Functions inherited from QwtPlotAbstractBarChart
double sampleWidth (const QwtScaleMap &map, double canvasSize, double dataSize, double value) const
 
- Protected Member Functions inherited from QwtPlotSeriesItem
virtual void dataChanged ()
 dataChanged() indicates, that the series has been changed.
 
- Protected Member Functions inherited from QwtPlotItem
QwtGraphic defaultIcon (const QBrush &, const QSizeF &) const
 Return a default icon from a brush. More...
 
- Protected Member Functions inherited from QwtAbstractSeriesStore
virtual ~QwtAbstractSeriesStore ()
 Destructor.
 

Detailed Description

QwtPlotMultiBarChart displays a series of a samples that consist each of a set of values.

Each value is displayed as a bar, the bars of each set can be organized side by side or accumulated.

Each bar of a set is rendered by a QwtColumnSymbol, that is set by setSymbol(). The bars of different sets use the same symbols. Exceptions are possible by overloading specialSymbol() or overloading drawBar().

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

In opposite to most other plot items, QwtPlotMultiBarChart returns more than one entry for the legend - one for each symbol.

See also
QwtPlotBarChart, QwtPlotHistogram QwtPlotSeriesItem::orientation(), QwtPlotAbstractBarChart::baseline()

Member Enumeration Documentation

Chart styles.

The default setting is QwtPlotMultiBarChart::Grouped.

See also
setStyle(), style()
Enumerator
Grouped 

The bars of a set are displayed side by side.

Stacked 

The bars are displayed on top of each other accumulating to a single bar. All values of a set need to have the same sign.

Constructor & Destructor Documentation

QwtPlotMultiBarChart::QwtPlotMultiBarChart ( const QString &  title = QString::null)
explicit

Constructor

Parameters
titleTitle of the chart
QwtPlotMultiBarChart::QwtPlotMultiBarChart ( const QwtText title)
explicit

Constructor

Parameters
titleTitle of the chart

Member Function Documentation

QList< QwtText > QwtPlotMultiBarChart::barTitles ( ) const
Returns
Bar titles
See also
setBarTitles(), legendData()
QRectF QwtPlotMultiBarChart::boundingRect ( ) const
virtual
Returns
Bounding rectangle of all samples. For an empty series the rectangle is invalid.

Reimplemented from QwtPlotSeriesItem.

void QwtPlotMultiBarChart::drawBar ( QPainter *  painter,
int  sampleIndex,
int  valueIndex,
const QwtColumnRect rect 
) const
protectedvirtual

Draw a bar

Parameters
painterPainter
sampleIndexIndex of the sample - might be -1 when the bar is painted for the legend
valueIndexIndex of a value in a set
rectDirected target rectangle for the bar
See also
drawSeries()
void QwtPlotMultiBarChart::drawGroupedBars ( QPainter *  painter,
const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  canvasRect,
int  index,
double  sampleWidth,
const QwtSetSample sample 
) const
protected

Draw a grouped sample

Parameters
painterPainter
xMapx map
yMapy map
canvasRectContents rectangle of the canvas
indexIndex of the sample to be painted
sampleWidthBoundng width for all bars of the smaple
sampleSample
See also
drawSeries(), sampleWidth()
void QwtPlotMultiBarChart::drawSample ( QPainter *  painter,
const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  canvasRect,
const QwtInterval boundingInterval,
int  index,
const QwtSetSample sample 
) const
protectedvirtual

Draw a sample

Parameters
painterPainter
xMapx map
yMapy map
canvasRectContents rectangle of the canvas
boundingIntervalBounding interval of sample values
indexIndex of the sample to be painted
sampleSample value
See also
drawSeries()
void QwtPlotMultiBarChart::drawSeries ( QPainter *  painter,
const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  canvasRect,
int  from,
int  to 
) const
virtual

Draw an interval of the bar chart

Parameters
painterPainter
xMapMaps x-values into pixel coordinates.
yMapMaps y-values into pixel coordinates.
canvasRectContents rectangle of the canvas
fromIndex of the first point to be painted
toIndex of the last point to be painted. If to < 0 the curve will be painted to its last point.
See also
drawSymbols()

Implements QwtPlotSeriesItem.

void QwtPlotMultiBarChart::drawStackedBars ( QPainter *  painter,
const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  canvasRect,
int  index,
double  sampleWidth,
const QwtSetSample sample 
) const
protected

Draw a stacked sample

Parameters
painterPainter
xMapx map
yMapy map
canvasRectContents rectangle of the canvas
indexIndex of the sample to be painted
sampleWidthWidth of the bars
sampleSample
See also
drawSeries(), sampleWidth()
QList< QwtLegendData > QwtPlotMultiBarChart::legendData ( ) const
virtual
Returns
Information to be displayed on the legend

The chart is represented by a list of entries - one for each bar title. Each element contains a bar title and an icon showing its corresponding bar.

See also
barTitles(), legendIcon(), legendIconSize()

Reimplemented from QwtPlotItem.

QwtGraphic QwtPlotMultiBarChart::legendIcon ( int  index,
const QSizeF &  size 
) const
virtual
Returns
Icon for representing a bar on the legend
Parameters
indexIndex of the bar
sizeIcon size
Returns
An icon showing a bar
See also
drawBar(), legendData()

Reimplemented from QwtPlotItem.

void QwtPlotMultiBarChart::resetSymbolMap ( )

Remove all symbols from the symbol map

int QwtPlotMultiBarChart::rtti ( ) const
virtual
Returns
QwtPlotItem::Rtti_PlotBarChart

Reimplemented from QwtPlotItem.

void QwtPlotMultiBarChart::setBarTitles ( const QList< QwtText > &  titles)

Set the titles for the bars.

The titles are used for the legend.

Parameters
titlesBar titles
See also
barTitles(), legendData()
void QwtPlotMultiBarChart::setSamples ( const QVector< QwtSetSample > &  samples)

Initialize data with an array of samples.

Parameters
samplesVector of points
void QwtPlotMultiBarChart::setSamples ( const QVector< QVector< double > > &  samples)

Initialize data with an array of samples.

Parameters
samplesVector of points
void QwtPlotMultiBarChart::setSamples ( QwtSeriesData< QwtSetSample > *  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
dataData
Warning
The item takes ownership of the data object, deleting it when its not used anymore.
void QwtPlotMultiBarChart::setStyle ( ChartStyle  style)

Set the style of the chart

Parameters
styleChart style
See also
style()
void QwtPlotMultiBarChart::setSymbol ( int  valueIndex,
QwtColumnSymbol symbol 
)

Add a symbol to the symbol map.

Assign a default symbol for drawing the bar representing all values with the same index in a set.

Parameters
valueIndexIndex of a value in a set
symbolSymbol used for drawing a bar
See also
symbol(), resetSymbolMap(), specialSymbol()
QwtColumnSymbol * QwtPlotMultiBarChart::specialSymbol ( int  sampleIndex,
int  valueIndex 
) const
protectedvirtual

Create a symbol for special values.

Usually the symbols for displaying a bar are set by setSymbols() and common for all sets. By overloading specialSymbol() it is possible to create a temporary symbol() for displaying a special value.

The symbol has to be created by new each time specialSymbol() is called. As soon as the symbol is painted this symbol gets deleted.

When no symbol ( NULL ) is returned, the value will be displayed with the standard symbol that is used for all symbols with the same valueIndex.

Parameters
sampleIndexIndex of the sample
valueIndexIndex of the value in the set
Returns
NULL, meaning that the value is not special
QwtPlotMultiBarChart::ChartStyle QwtPlotMultiBarChart::style ( ) const
Returns
Style of the chart
See also
setStyle()
const QwtColumnSymbol * QwtPlotMultiBarChart::symbol ( int  valueIndex) const

Find a symbol in the symbol map

Parameters
valueIndexIndex of a value in a set
Returns
The symbol, that had been set by setSymbol() or NULL.
See also
setSymbol(), specialSymbol(), drawBar()
QwtColumnSymbol * QwtPlotMultiBarChart::symbol ( int  valueIndex)
protected

Find a symbol in the symbol map

Parameters
valueIndexIndex of a value in a set
Returns
The symbol, that had been set by setSymbol() or NULL.
See also
setSymbol(), specialSymbol(), drawBar()