##// END OF EJS Templates
Documentation fixes....
Tero Ahola -
r995:d52b7de4b911
parent child
Show More
1 NO CONTENT: new file 100644, binary diff hidden
NO CONTENT: new file 100644, binary diff hidden
@@ -12,7 +12,6 HTML.postheader = \
12 " <ul>\n" \
12 " <ul>\n" \
13 " <li class=\"first\"><a href=\"index.html\">About</a></li>\n" \
13 " <li class=\"first\"><a href=\"index.html\">About</a></li>\n" \
14 " <li><a href=\"classes.html\">API Classes</a></li>\n" \
14 " <li><a href=\"classes.html\">API Classes</a></li>\n" \
15 " <li><a href=\"tutorials.html\">Tutorials</a></li>\n" \
16 " <li><a href=\"examples.html\">Examples</a></li>\n" \
15 " <li><a href=\"examples.html\">Examples</a></li>\n" \
17 " <li><a href=\"demos.html\">Demos</a></li>\n" \
16 " <li><a href=\"demos.html\">Demos</a></li>\n" \
18 " <!-- Breadcrumbs go here -->\n"
17 " <!-- Breadcrumbs go here -->\n"
@@ -49,7 +49,7
49 <li><a href="qpieseries.html">QPieSeries</a></li>
49 <li><a href="qpieseries.html">QPieSeries</a></li>
50 <li><a href="qpieslice.html">QPieSlice</a></li>
50 <li><a href="qpieslice.html">QPieSlice</a></li>
51 <li><a href="qscatterseries.html">QScatterSeries</a></li>
51 <li><a href="qscatterseries.html">QScatterSeries</a></li>
52 <li><a href="qseries.html">QSeries</a></li>
52 <li><a href="qabstractseries.html">QAbstractSeries</a></li>
53 <li><a href="qsplineseries.html">QSplineSeries</a></li>
53 <li><a href="qsplineseries.html">QSplineSeries</a></li>
54 <li><a href="qstackedbarseries.html">QStackedBarSeries</a></li>
54 <li><a href="qstackedbarseries.html">QStackedBarSeries</a></li>
55 <li><a href="qxyseries.html">QXYSeries</a></li>
55 <li><a href="qxyseries.html">QXYSeries</a></li>
@@ -42,17 +42,8 QTCOMMERCIALCHART_BEGIN_NAMESPACE
42 In that case QAreaSeries should be initiated with two QLineSerie instances. Please note terms "upper" and "lower" boundary can be misleading in cases
42 In that case QAreaSeries should be initiated with two QLineSerie instances. Please note terms "upper" and "lower" boundary can be misleading in cases
43 where "lower" boundary had bigger values than the "upper" one, however the main point that area between these two boundary lines will be filled.
43 where "lower" boundary had bigger values than the "upper" one, however the main point that area between these two boundary lines will be filled.
44
44
45 \image areachart.png
45 See the \l {AreaChart Example} {area chart example} to learn how to create a simple area chart.
46
46 \image examples_areachart.png
47 Creating basic area chart is simple:
48 \code
49 QLineSeries* lineSeries = new QLineSeries();
50 series->append(0, 6);
51 series->append(2, 4);
52 QAreaSeries* areaSeries = new QAreaSeries(lineSeries);
53 ...
54 chartView->addSeries(areaSeries);
55 \endcode
56 */
47 */
57
48
58 /*!
49 /*!
@@ -37,12 +37,14 QTCOMMERCIALCHART_BEGIN_NAMESPACE
37 /*!
37 /*!
38 \class QBarSeries
38 \class QBarSeries
39 \brief part of QtCommercial chart API.
39 \brief part of QtCommercial chart API.
40 \mainclass
40
41
41 QBarSeries represents a series of data shown as bars. One QBarSeries can contain multiple
42 QBarSeries represents a series of data shown as bars. One QBarSeries can contain multiple
42 QBarSet data sets. QBarSeries groups the data from sets to categories, which are defined
43 QBarSet data sets. QBarSeries groups the data from sets to categories, which are defined
43 by QStringList.
44 by QStringList.
44
45
45 \mainclass
46 See the \l {BarChart Example} {bar chart example} to learn how to create a simple bar chart.
47 \image examples_barchart.png
46
48
47 \sa QBarSet, QStackedBarSeries, QPercentBarSeries
49 \sa QBarSet, QStackedBarSeries, QPercentBarSeries
48 */
50 */
@@ -31,12 +31,14 QTCOMMERCIALCHART_BEGIN_NAMESPACE
31 /*!
31 /*!
32 \class QPercentBarSeries
32 \class QPercentBarSeries
33 \brief part of QtCommercial chart API.
33 \brief part of QtCommercial chart API.
34 \mainclass
34
35
35 QPercentBarSeries represents a series of data shown as bars. Each bar of QBarSet is shown as percentage
36 QPercentBarSeries represents a series of data shown as bars. Each bar of QBarSet is shown as percentage
36 of all bars in category. One QPercentBarSeries can contain multiple QBarSet data sets.
37 of all bars in category. One QPercentBarSeries can contain multiple QBarSet data sets.
37 QBarSeries groups the data from sets to categories, which are defined by QStringList.
38 QBarSeries groups the data from sets to categories, which are defined by QStringList.
38
39
39 \mainclass
40 See the \l {PercentbarChart Example} {percent bar chart example} to learn how to create a percent bar chart.
41 \image examples_percentbarchart.png
40
42
41 \sa QBarSet, QStackedBarSeries, QBarSeries
43 \sa QBarSet, QStackedBarSeries, QBarSeries
42 */
44 */
@@ -31,12 +31,14 QTCOMMERCIALCHART_BEGIN_NAMESPACE
31 /*!
31 /*!
32 \class QStackedBarSeries
32 \class QStackedBarSeries
33 \brief part of QtCommercial chart API.
33 \brief part of QtCommercial chart API.
34 \mainclass
34
35
35 QStackedBarSeries represents a series of data shown as bars. All bars in same category are
36 QStackedBarSeries represents a series of data shown as bars. All bars in same category are
36 stacked on top of each other. One QStackedBarSeries can contain multiple QBarSet data sets.
37 stacked on top of each other. One QStackedBarSeries can contain multiple QBarSet data sets.
37 QStackedBarSeries groups the data from sets to categories, which are defined by QStringList.
38 QStackedBarSeries groups the data from sets to categories, which are defined by QStringList.
38
39
39 \mainclass
40 See the \l {StackedbarChart Example} {stacked bar chart example} to learn how to create a stacked bar chart.
41 \image examples_stackedbarchart.png
40
42
41 \sa QBarSet, QPercentBarSeries, QBarSeries
43 \sa QBarSet, QPercentBarSeries, QBarSeries
42 */
44 */
@@ -46,18 +46,19
46 QTCOMMERCIALCHART_BEGIN_NAMESPACE
46 QTCOMMERCIALCHART_BEGIN_NAMESPACE
47
47
48 /*!
48 /*!
49 \class QLegend
49 \class QLegend
50 \brief part of QtCommercial chart API.
50 \brief part of QtCommercial chart API.
51 \mainclass
51
52
52 QLegend is a graphical object, whics displays legend of the chart. Legend state is updated by QChart, when
53 QLegend is a graphical object, whics displays legend of the chart. Legend state is updated by QChart, when
53 series have been changed. By default, legend is drawn by QChart, but user can set a new parent to legend and
54 series have been changed. By default, legend is drawn by QChart, but user can set a new parent to legend and
54 handle the drawing manually.
55 handle the drawing manually.
55 User isn't supposed to create or delete legend objects, but can reference it via QChart class.
56 User isn't supposed to create or delete legend objects, but can reference it via QChart class.
56
57
57 \mainclass
58 \image examples_percentbarchart_legend.png
58
59
59 \sa QChart, QAbstractSeries
60 \sa QChart
60 */
61 */
61
62
62 /*!
63 /*!
63 \enum QLegend::Alignment
64 \enum QLegend::Alignment
@@ -36,15 +36,15 QTCOMMERCIALCHART_BEGIN_NAMESPACE
36 A line chart is used to show information as a series of data points
36 A line chart is used to show information as a series of data points
37 connected by straight lines.
37 connected by straight lines.
38
38
39 \image linechart.png
39 \image examples_linechart.png
40
40
41 Creating basic line chart is simple:
41 Creating basic line chart is simple:
42 \code
42 \code
43 QLineSeries* series = new QLineSeries();
43 QLineSeries* series = new QLineSeries();
44 series->append(0, 6);
44 series->append(0, 6);
45 series->append(2, 4);
45 series->append(2, 4);
46 ...
46 ...
47 chartView->addSeries(series);
47 chart->addSeries(series);
48 \endcode
48 \endcode
49 */
49 */
50
50
@@ -45,6 +45,9 QTCOMMERCIALCHART_BEGIN_NAMESPACE
45 By default the pie is defined as a full pie but it can also be a partial pie.
45 By default the pie is defined as a full pie but it can also be a partial pie.
46 This can be done by setting a starting angle and angle span to the series.
46 This can be done by setting a starting angle and angle span to the series.
47 Full pie is 360 degrees where 0 is at 12 a'clock.
47 Full pie is 360 degrees where 0 is at 12 a'clock.
48
49 See the \l {PieChart Example} {pie chart example} to learn how to create a simple pie chart.
50 \image examples_piechart.png
48 */
51 */
49
52
50 /*!
53 /*!
@@ -34,7 +34,7
34 The scatter data is displayed as a collection of points on the chart. Each point determines the position on the horizontal axis
34 The scatter data is displayed as a collection of points on the chart. Each point determines the position on the horizontal axis
35 and the vertical axis.
35 and the vertical axis.
36
36
37 \image scatterchart.png
37 \image examples_scatterchart.png
38
38
39 Creating basic scatter chart is simple:
39 Creating basic scatter chart is simple:
40 \code
40 \code
@@ -42,7 +42,7
42 series->append(0, 6);
42 series->append(0, 6);
43 series->append(2, 4);
43 series->append(2, 4);
44 ...
44 ...
45 chartView->addSeries(series);
45 chart->addSeries(series);
46 \endcode
46 \endcode
47 */
47 */
48
48
@@ -31,6 +31,17
31
31
32 QSplineSeries stores the data points along with the segment control points needed by QPainterPath to draw spline
32 QSplineSeries stores the data points along with the segment control points needed by QPainterPath to draw spline
33 Control points are automatically calculated when data changes. The algorithm computes the points so that the normal spline can be drawn.
33 Control points are automatically calculated when data changes. The algorithm computes the points so that the normal spline can be drawn.
34
35 \image examples_splinechart.png
36
37 Creating basic spline chart is simple:
38 \code
39 QSplineSeries* series = new QSplineSeries();
40 series->append(0, 6);
41 series->append(2, 4);
42 ...
43 chart->addSeries(series);
44 \endcode
34 */
45 */
35
46
36 /*!
47 /*!
General Comments 0
You need to be logged in to leave comments. Login now