qareaseries.cpp
129 lines
| 3.5 KiB
| text/x-c
|
CppLexer
Michal Klocek
|
r421 | #include "qareaseries.h" | ||
#include "qlineseries.h" | ||||
QTCOMMERCIALCHART_BEGIN_NAMESPACE | ||||
/*! | ||||
\class QAreaSeries | ||||
\brief The QAreaSeries class is used for making area charts. | ||||
\mainclass | ||||
An area chart is used to show quantitative data. It is based on line chart, in the way that area between axis and the line | ||||
is emphasized with color. Since the area chart is based on line chart, QAreaSeries constructor needs QLineSeries instance, | ||||
Michal Klocek
|
r424 | which defines "upper" boundary of the area. "Lower" boundary is defined by default by axis X. Instead of axis X "lower" boundary can be specified by other line. | ||
Michal Klocek
|
r421 | In that case QAreaSeries should be initiated with two QLineSerie instances. Please note terms "upper" and "lower" boundary can be misleading in cases | ||
Michal Klocek
|
r424 | where "lower" boundary had bigger values than the "upper" one, however the main point that area between these two boundary lines will be filled. | ||
Michal Klocek
|
r421 | |||
\image areachart.png | ||||
Creating basic area chart is simple: | ||||
\code | ||||
QLineSeries* lineSeries = new QLineSeries(); | ||||
series->add(0, 6); | ||||
series->add(2, 4); | ||||
QAreaSeries* areaSeries = new QAreaSeries(lineSeries); | ||||
... | ||||
chartView->addSeries(areaSeries); | ||||
\endcode | ||||
*/ | ||||
/*! | ||||
\fn virtual QSeriesType QAreaSeries::type() const | ||||
\brief Returns type of series. | ||||
\sa QSeries, QSeriesType | ||||
*/ | ||||
/*! | ||||
\fn QLineSeries* QAreaSeries::upperSeries() const | ||||
\brief Returns upperSeries used to define one of area boundaries. | ||||
*/ | ||||
/*! | ||||
\fn QLineSeries* QAreaSeries::lowerSeries() const | ||||
\brief Returns lowerSeries used to define one of area boundaries. Note if QAreaSeries where counstucted wihtout a\ lowerSeries | ||||
this function return Null pointer. | ||||
*/ | ||||
/*! | ||||
\fn QPen QAreaSeries::pen() const | ||||
\brief Returns the pen used to draw line for this series. | ||||
\sa setPen() | ||||
*/ | ||||
/*! | ||||
\fn QPen QAreaSeries::brush() const | ||||
\brief Returns the brush used to draw line for this series. | ||||
\sa setBrush() | ||||
*/ | ||||
/*! | ||||
\fn bool QAreaSeries::pointsVisible() const | ||||
\brief Returns if the points are drawn for this series. | ||||
\sa setPointsVisible() | ||||
*/ | ||||
Michal Klocek
|
r574 | /*! | ||
\fn void QAreaSeries::clicked(const QPointF& point) | ||||
\brief Signal is emitted when user clicks the \a point on area chart. | ||||
*/ | ||||
Michal Klocek
|
r421 | /*! | ||
\fn void QAreaSeries::updated() | ||||
\brief \internal | ||||
*/ | ||||
/*! | ||||
Constructs area series object which is a child of \a upperSeries. Area will be spanned between \a | ||||
upperSeries line and \a lowerSeries line. If no \a lowerSeries is passed to constructor, area is specified by axis x (y=0) instead. | ||||
When series object is added to QChartView or QChart instance ownerships is transfered. | ||||
*/ | ||||
QAreaSeries::QAreaSeries(QLineSeries* upperSeries,QLineSeries* lowerSeries):QSeries(upperSeries), | ||||
m_upperSeries(upperSeries), | ||||
m_lowerSeries(lowerSeries), | ||||
m_pointsVisible(false) | ||||
{ | ||||
} | ||||
/*! | ||||
Destroys the object. Series added to QChartView or QChart instances are owned by those, | ||||
and are deleted when mentioned object are destroyed. | ||||
*/ | ||||
QAreaSeries::~QAreaSeries() | ||||
{ | ||||
} | ||||
/*! | ||||
Sets \a pen used for drawing area outline. | ||||
*/ | ||||
void QAreaSeries::setPen(const QPen& pen) | ||||
{ | ||||
Michal Klocek
|
r571 | if(m_pen!=pen){ | ||
m_pen=pen; | ||||
emit updated(); | ||||
} | ||||
Michal Klocek
|
r421 | } | ||
/*! | ||||
Sets \a brush used for filling the area. | ||||
*/ | ||||
void QAreaSeries::setBrush(const QBrush& brush) | ||||
{ | ||||
Michal Klocek
|
r571 | if(m_brush!=brush){ | ||
m_brush=brush; | ||||
emit updated(); | ||||
} | ||||
Michal Klocek
|
r421 | } | ||
/*! | ||||
Sets if data points are \a visible and should be drawn on line. | ||||
*/ | ||||
void QAreaSeries::setPointsVisible(bool visible) | ||||
{ | ||||
Michal Klocek
|
r571 | if(m_pointsVisible!=visible){ | ||
m_pointsVisible=visible; | ||||
emit updated(); | ||||
} | ||||
Michal Klocek
|
r421 | } | ||
#include "moc_qareaseries.cpp" | ||||
QTCOMMERCIALCHART_END_NAMESPACE | ||||