HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r261:0212e399865a

Documenting QScatterSeries

Tero Ahola -

r261:0212e399865a

parent child

Context file:

r261:0212e399865a

Collapse all files

doc/images/scatter_example_brush.jpg created 644 binary 0 0

NO CONTENT: new file 100644, binary diff hidden

doc/images/scatter_example_pen.jpg created 644 binary 0 0

NO CONTENT: new file 100644, binary diff hidden

doc/images/scatter_example_shape.jpg created 644 binary 0 0

NO CONTENT: new file 100644, binary diff hidden

example/scatter/main.cpp +4 -12

                 // Add another scatter series
                 // - more data with random component
                 QScatterSeries *scatter2 = new QScatterSeries();
-                for (qreal i(0.0); i < 20; i += 0.05) {
+                for (qreal i(0.0); i < 20; i += 0.15) {
                     (*scatter2) << QPointF(i + (qreal)(rand() % 100) / 100.0,
                                            i + (qreal)(rand() % 100) / 100.0);
                 }
-                chartView->addSeries(scatter2);
+                QBrush brush(QColor(255, 0, 0, 100), Qt::SolidPattern);
-                // Custom pen and brush (not those defined by the chart theme)
-                // - uses opaque color
-                QColor color("#2685BF");
-                color.setAlpha(80);
-                QBrush brush(Qt::SolidPattern);
-                brush.setColor(color);
                 scatter2->setMarkerBrush(brush);
-                QPen pen;
+                QPen pen(QColor(0, 255, 0, 80), 3);
-                pen.setColor(color);
-                pen.setWidth(2);
                 scatter2->setMarkerPen(pen);
-                // use a rectangle as the marker shape
                 scatter2->setMarkerShape(QScatterSeries::MarkerShapeRectangle);
+                chartView->addSeries(scatter2);
                 // Use the chart widget as the central widget
                 QMainWindow w;

src/scatterseries/qscatterseries.cpp +73 -5

             }
             /*!
+                \enum QScatterSeries::MarkerShape
+                This enum describes the shape used when rendering marker items.
+                \value MarkerShapeDefault
+                \value MarkerShapePoint
+                \value MarkerShapeX
+                \value MarkerShapeRectangle
+                \value MarkerShapeTiltedRectangle
+                \value MarkerShapeTriangle
+                \value MarkerShapeCircle
+            */
+            /*!
                 \class QScatterSeries
                 \brief QtCommercial Chart series API for showing scatter series.
                 \image scatter_example1.jpg
             */
+            /*!
+                Constructs a series object which is a child of \a parent.
+            */
             QScatterSeries::QScatterSeries(QObject *parent) :
                 QChartSeries(parent),
                 d(new QScatterSeriesPrivate())
             }
             /*!
-                Destructor
+                Destroys the object. Note that adding series to QChart transfers the ownership to the chart.
             */
             QScatterSeries::~QScatterSeries()
             {
             /*!
                 Add single data point to the series.
+                For example:
+                \code
+                mySeries.addData(QPointF(0.5, 5.0));
+                \endcode
             */
             void QScatterSeries::addData(QPointF value)
             {
             }
             /*!
-                returns the current list of data points of the series.
+                Returns the current list of data points of the series.
             */
             QList<QPointF> QScatterSeries::data()
             {
             }
             /*!
-                Customizes the graphical presentation of the marker items. Replaces the default pen used for
+                Overrides the default pen used for drawing a marker item with a user defined pen. The default
-                drawing a marker item with a user defined pen.
+                pen is defined by chart theme setting.
+                For example:
+                \code
+                QPen pen(QColor(0, 255, 0, 80), 3);
+                myScatter->setMarkerPen(pen);
+                \endcode
+                Would present your scatter markers with an opaque, uglyish green outlines:
+                \image scatter_example_pen.jpg
+                \sa setMarkerBrush()
+                \sa QChart::setTheme()
             */
             void QScatterSeries::setMarkerPen(QPen pen)
             {
             }
             /*!
+                Returns the pen used for drawing markers.
             */
             QPen QScatterSeries::markerPen()
             {
                 return d->m_markerPen;
             }
+            /*!
+                Overrides the default brush of the marker items with a user defined brush. The default
+                brush is defined by chart theme setting.
+                For example:
+                \code
+                QBrush brush(QColor(255, 0, 0, 100), Qt::SolidPattern);
+                myRandomScatter->setMarkerBrush(brush);
+                \endcode
+                Would fill your scatter markers with an opaque red color:
+                \image scatter_example_brush.jpg
+                \sa setMarkerPen()
+                \sa QChart::setTheme()
+            */
             void QScatterSeries::setMarkerBrush(QBrush brush)
             {
                 d->m_markerBrush = brush;
             }
+            /*!
+                Returns the brush used for drawing markers.
+            */
             QBrush QScatterSeries::markerBrush()
             {
                 return d->m_markerBrush;
             }
+            /*!
+                Overrides the default shape of the marker items with a user defined shape. The default
+                shape is defined by chart theme setting.
+                For example:
+                \code
+                myScatter->setMarkerShape(QScatterSeries::MarkerShapeRectangle);
+                \endcode
+                Would make your scatter marker items rectangle:
+                \image scatter_example_shape.jpg
+            */
             void QScatterSeries::setMarkerShape(MarkerShape shape)
             {
                 d->m_markerShape = shape;
             }
+            /*!
+                Returns the shape used for drawing markers.
+            */
             QScatterSeries::MarkerShape QScatterSeries::markerShape()
             {
                 return (QScatterSeries::MarkerShape) d->m_markerShape;

src/scatterseries/scatterpresenter.cpp +6 -4

             {
                 // TODO: Optimization: avoid setting on every paint method call?
                 // The custom settings in series override those defined by the theme
-                if (m_series->markerPen().color().isValid()) {
+                if (m_series->markerPen().color().isValid())
                     painter->setPen(m_series->markerPen());
-                    painter->setBrush(m_series->markerBrush());
+                else
-                } else {
                     painter->setPen(m_markerPen);
+                if (m_series->markerBrush().color().isValid())
+                    painter->setBrush(m_series->markerBrush());
+                else
                     painter->setBrush(m_markerBrush);
                 int shape = m_series->markerShape();

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages