HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r481:676000b99479

Fixes for docs , adds xyseries docs

Michal Klocek -

r481:676000b99479

parent child

Context file:

r481:676000b99479

Collapse all files

doc/src/classes.qdoc +1 0

                         <li><a href="qseries.html">QSeries</a></li>
                         <li><a href="qsplineseries.html">QSplineSeries</a></li>
                         <li><a href="qstackedbarseries.html">QStackedBarSeries</a></li>
+                        <li><a href="qxyseries.html">QXYSeries</a></li>
                     </ul>
                     </td>
                     </tr>

src/qchart.cpp +2 -2

             }
             /*!
-                Sets the chart \a title. The description text that is rendered above the chart.
+                Sets the chart \a title. The description text that is drawn above the chart.
             */
             void QChart::setChartTitle(const QString& title)
             {
             }
             /*!
-                Gets the chart \a title. The description text that is rendered above the chart.
+                Returns the chart title. The description text that is drawn above the chart.
             */
             QString QChart::chartTitle() const
             {

src/qchartview.cpp +2 -2

             }
             /*!
-                Sets the chart \a title. A description text that is rendered above the chart.
+                Sets the chart \a title. A description text that is drawn above the chart.
             */
             void QChartView::setChartTitle(const QString& title)
             {
             }
             /*!
-                Returns the chart's title. A description text that is rendered above the chart.
+                Returns the chart's title. A description text that is drawn above the chart.
             */
             QString QChartView::chartTitle() const
             {

src/scatterseries/qscatterseries.cpp +15 -113

@@ -3,25 +3,23
3		3
4	/*!	4	/*!
5	\class QScatterSeries	5	\class QScatterSeries
6	\brief QtCommercial Chart series API for showing scatter series.	6	\brief The QScatterSeries class is used for making scatter charts.
7		7
8	\mainclass	8	\mainclass
9		9
10	Example on how to create a chart with scatter series:	10	The scatter data is displayed as a collection of points on the chart. Each point determines the position on the horizontal axis
11	\snippet ../example/scatter/main.cpp 1	11	and the vertical axis.
12		12
13	The example code would result the following:	13	\image scatterchart.png
14		14
15	\image scatter_example1.jpg	15	Creating basic scatter chart is simple:
16		16	\code
17	To customize the graphical representation of the series, you can modify pen, brush, shape and	17	QScatterSeries* series = new QScatterSeries();
18	size of the marker items. For example:	18	series->add(0, 6);
19		19	series->add(2, 4);
20	\snippet ../example/scatter/main.cpp 3	20	...
21		21	chartView->addSeries(series);
22	Would present your scatter markers as big rectangles with opaque, uglyish green outlines and	22	\endcode
23	opaque red filling instead of the beatiful markers defined by the chart's theme:
24	\image scatter_example_custom.jpg
25	*/	23	*/
26		24
27	/*!	25	/*!
@@ -41,13 +39,12
41	/*!	39	/*!
42	\fn QChartSeriesType QScatterSeries::type() const	40	\fn QChartSeriesType QScatterSeries::type() const
43	\brief Returns QChartSeries::SeriesTypeScatter.	41	\brief Returns QChartSeries::SeriesTypeScatter.
		42	\sa QSeries, QSeriesType
44	*/	43	*/
45		44
46	/*!	45	/*!
47	\fn void QScatterSeries::clicked(QPointF ~~coordinate~~)	46	\fn void QScatterSeries::clicked(const QPointF& point)
48	User clicked the scatter series. Note that the \a coordinate is the chart coordinate that the	47	\brief Signal is emitted when user clicks the \a point on scatter chart.
49	click occurred on; not necessarily a data point coordinate. To find the corresponding (closest)
50	data point you can use closestPoint().
51	*/	48	*/
52		49
53	QTCOMMERCIALCHART_BEGIN_NAMESPACE	50	QTCOMMERCIALCHART_BEGIN_NAMESPACE
@@ -69,101 +66,6 QScatterSeries::~QScatterSeries()
69	{	66	{
70	}	67	}
71		68
72
73
74	/*!
75	Stream operator for adding a data point with \a value to the series.
76	\sa add()
77
78	For example:
79	\snippet ../example/scatter/main.cpp 2
80	*/
81
82
83	/*!
84	Stream operator for adding a list of points to the series.
85	\sa add()
86	*/
87
88
89	/*!
90	Replaces the data of the series with the given list of data \a points.
91	*/
92
93
94	/*!
95	Returns the current list of data points of the series.
96	*/
97
98	/*!
99	Replaces the point at \a index with \a newPoint. Returns true if \a index is a valid position
100	in the series data, false otherwise.
101	*/
102
103
104	/*!
105	Remove the data point at \a index. Returns true if a point was removed, false if the point
106	at \a index does not exist on the series.
107	*/
108
109
110	/*!
111	Remove all occurrences of \a point from the series and returns the number of points removed.
112	*/
113
114
115	/*!
116	Remove all data points from the series.
117	*/
118
119	/*!
120	Returns the index of the data point that is closest to \a coordinate. If several data points
121	are at the same distance from the \a coordinate, returns the last one. If no points exist,
122	returns -1.
123
124	int QScatterSeries::closestPoint(QPointF coordinate)
125	{
126	qreal distance(-1);
127	int pointIndex(-1);
128	for (int i(0); i < d->m_data.count(); i++) {
129	QPointF dataPoint = d->m_data.at(i);
130	QPointF difference = dataPoint - coordinate;
131	if (i == 0 \|\| difference.manhattanLength() <= distance) {
132	distance = difference.manhattanLength();
133	pointIndex = i;
134	}
135	}
136	return pointIndex;
137	}
138	*/
139
140	/*!
141	Returns the pen used for drawing markers.
142	*/
143
144
145	/*!
146	Overrides the default pen used for drawing a marker item with a user defined \a pen. The
147	default pen is defined by chart theme setting.
148
149	\sa setBrush()
150	\sa QChart::setChartTheme()
151	*/
152
153
154	/*!
155	Returns the brush used for drawing markers.
156	*/
157
158
159	/*!
160	Overrides the default brush of the marker items with a user defined \a brush. The default brush
161	is defined by chart theme setting.
162
163	\sa setPen()
164	\sa QChart::setChartTheme()
165	*/
166
167	/*!	69	/*!
168	Returns the shape used for drawing markers.	70	Returns the shape used for drawing markers.
169	*/	71	*/

src/scatterseries/qscatterseries.h +1 -3

                 QSeriesType type() const { return QSeries::SeriesTypeScatter; }
             public:
-                //int closestPoint(QPointF coordinate);
                 MarkerShape shape() const;
                 void setShape(MarkerShape shape);
                 qreal size() const;
                 void setSize(qreal size);
             signals:
-                void clicked(QPointF coordinate);
+                void clicked(const QPointF& point);
             private:
                 MarkerShape m_shape;

src/xychart/qxyseries.cpp +31 -10

             */
             /*!
-                \fn virtual QSeriesType QXYSeries::type() const
-                \brief Returns type of series.
-                \sa QSeries, QSeriesType
-            */
-            /*!
                \fn QPen QXYSeries::pen() const
                \brief  Returns pen used to draw points for series.
                 \sa setPen()
             }
             /*!
+               This is an overloaded function.
+               Adds list of data \a points to the series. Points are connected with lines on the chart.
+             */
+            void QXYSeries::add(const QList<QPointF> points)
+            {
+                foreach(const QPointF& point , points) {
+                    add(point.x(),point.y());
+                }
+            }
+            /*!
               Modifies \a y value for given \a x a value.
             */
             void QXYSeries::replace(qreal x,qreal y)
             }
             /*!
-              Clears all the data.
+               Removes all data points from the series.
             */
-            void QXYSeries::clear()
+            void QXYSeries::removeAll()
             {
                 m_x.clear();
                 m_y.clear();
             }
             /*!
-                Sets \a pen used for drawing points on the chart.
+                Sets \a pen used for drawing points on the chart. If the pen is not defined, the
+                pen from chart theme is used.
+                \sa QChart::setChartTheme()
             */
             void QXYSeries::setPen(const QPen& pen)
             {
             }
             /*!
-                Sets \a brush used for drawing points on the chart.
+                Sets \a brush used for drawing points on the chart. If the brush is not defined, brush
+                from chart theme setting is used.
+                \sa QChart::setChartTheme()
             */
             void QXYSeries::setBrush(const QBrush& brush)
             }
+            /*!
+                Stream operator for adding a list of \a points to the series.
+                \sa add()
+            */
+            QXYSeries& QXYSeries::operator<< (const QList<QPointF> points)
+            {
+                add(points);
+                return *this;
+            }
             #include "moc_qxyseries.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/xychart/qxyseries.h +3 -8

             public:
             	void add(qreal x, qreal y);
             	void add(const QPointF& point);
+                void add(const QList<QPointF> points);
             	void replace(qreal x,qreal y);
             	void replace(const QPointF& point);
             	void remove(qreal x);
             	void remove(const QPointF& point);
-            	void clear();
+            	void removeAll();
             	int count() const;
             	qreal x(int pos) const;
             	qreal y(int pos) const;
             	QXYSeries& operator << (const QPointF &point);
-            	/*
+            	QXYSeries& operator << (const QList<QPointF> points);
-            	void add(QList<QPointF> points);
-                void setData(QList<QPointF> points);
-                QScatterSeries& operator << (const QPointF &value);
-                QScatterSeries& operator << (QList<QPointF> points);
-               int removeAll(QPointF point);
-            	*/
             	void setPen(const QPen& pen);
             	QPen pen() const {return m_pen;}

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