##// END OF EJS Templates
Few more fixes to docs
Few more fixes to docs

File last commit:

r863:e54c97fc02b8
r937:ebc42fa644e2
Show More
qareaseries.cpp
151 lines | 4.3 KiB | text/x-c | CppLexer
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc
** All rights reserved.
** For any questions to Digia, please use contact form at http://qt.digia.com
**
** This file is part of the Qt Commercial Charts Add-on.
**
** $QT_BEGIN_LICENSE$
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** contact form at http://qt.digia.com
** $QT_END_LICENSE$
**
****************************************************************************/
#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,
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.
In that case QAreaSeries should be initiated with two QLineSerie instances. Please note terms "upper" and "lower" boundary can be misleading in cases
where "lower" boundary had bigger values than the "upper" one, however the main point that area between these two boundary lines will be filled.
\image areachart.png
Creating basic area chart is simple:
\code
QLineSeries* lineSeries = new QLineSeries();
series->append(0, 6);
series->append(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()
*/
/*!
\fn void QAreaSeries::clicked(const QPointF& point)
\brief Signal is emitted when user clicks the \a point on area chart.
*/
/*!
\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)
{
if (m_pen != pen) {
m_pen = pen;
emit updated();
}
}
/*!
Sets \a brush used for filling the area.
*/
void QAreaSeries::setBrush(const QBrush &brush)
{
if (m_brush != brush) {
m_brush = brush;
emit updated();
}
}
/*!
Sets if data points are \a visible and should be drawn on line.
*/
void QAreaSeries::setPointsVisible(bool visible)
{
if (m_pointsVisible != visible) {
m_pointsVisible = visible;
emit updated();
}
}
#include "moc_qareaseries.cpp"
QTCOMMERCIALCHART_END_NAMESPACE