##// END OF EJS Templates
Few docs changes based on the findings list
Marek Rosa -
r1510:1d95213abff9
parent child
Show More
@@ -1,98 +1,85
1 /*!
1 /*!
2 \page classes.html
2 \page classes.html
3 \title QtCommercial Charts API
3 \title QtCommercial Charts API
4 \keyword All Classes
4 \keyword All Classes
5
5
6 Charts API is build on top of Qt Graphics View Framework. Charts can be displayed as QGraphicsWidget using QChart class. However
6 Charts API is build on top of Qt Graphics View Framework. Charts can be displayed as QGraphicsWidget using QChart class. However
7 there is also convenience class QChartView which is QWidget based. These lets quickly use QCharts as normal Qt widget.
7 there is also convenience class QChartView which is QWidget based. These lets quickly use QCharts as normal Qt widget.
8 The API supports following chart types:
9
10 \list
11 \o line
12 \o area
13 \o scatter
14 \o spline
15 \o pie
16 \o grouped bar
17 \o percent bar
18 \o stacked bar
19 \endlist
20
21
8
22 Each chart type is represented by QAbstractSeries derived class. To create given chart type users have to use instance of related series class and add it to QChart instance.
9 Each chart type is represented by QAbstractSeries derived class. To create given chart type users have to use instance of related series class and add it to QChart instance.
23 \code
10 \code
24 QLineSeries* series = new QLineSeries();
11 QLineSeries* series = new QLineSeries();
25 series->add(0, 6);
12 series->add(0, 6);
26 series->add(2, 4);
13 series->add(2, 4);
27 ...
14 ...
28 chartView->chart()->addSeries(series);
15 chartView->chart()->addSeries(series);
29 \endcode
16 \endcode
30
17
31 \raw HTML
18 \raw HTML
32 <table cellpadding="2" cellspacing="1" border="0" width="100%" class="indextable">
19 <table cellpadding="2" cellspacing="1" border="0" width="100%" class="indextable">
33 <tr>
20 <tr>
34 <th class="titleheader" width="25%">
21 <th class="titleheader" width="25%">
35 Common and global
22 Common and global
36 </th>
23 </th>
37 <th class="titleheader" width="25%">
24 <th class="titleheader" width="25%">
38 XY chart
25 XY chart
39 </th>
26 </th>
40 </tr>
27 </tr>
41 <tr>
28 <tr>
42 <td valign="top">
29 <td valign="top">
43 <ul>
30 <ul>
44 <li><a href="qchart.html">QChart</a></li>
31 <li><a href="qchart.html">QChart</a></li>
45 <li><a href="qaxis.html">QAxis</a></li>
32 <li><a href="qaxis.html">QAxis</a></li>
46 <li><a href="qaxiscategories.html">QAxisCategories</a></li>
33 <li><a href="qaxiscategories.html">QAxisCategories</a></li>
47 <li><a href="qchartview.html">QChartView</a></li>
34 <li><a href="qchartview.html">QChartView</a></li>
48 <li><a href="qlegend.html">QLegend</a></li>
35 <li><a href="qlegend.html">QLegend</a></li>
49 <li><a href="qabstractseries.html">QAbstractSeries</a></li>
36 <li><a href="qabstractseries.html">QAbstractSeries</a></li>
50 <li><a href="qchartglobal.html">QChartGlobal</a></li>
37 <li><a href="qchartglobal.html">QChartGlobal</a></li>
51 </ul>
38 </ul>
52 </td>
39 </td>
53 <td valign="top">
40 <td valign="top">
54 <ul>
41 <ul>
55 <li><a href="qxyseries.html">QXYSeries</a></li>
42 <li><a href="qxyseries.html">QXYSeries</a></li>
56 <li><a href="qlineseries.html">QLineSeries</a></li>
43 <li><a href="qlineseries.html">QLineSeries</a></li>
57 <li><a href="qareaseries.html">QAreaSeries</a></li>
44 <li><a href="qareaseries.html">QAreaSeries</a></li>
58 <li><a href="qscatterseries.html">QScatterSeries</a></li>
45 <li><a href="qscatterseries.html">QScatterSeries</a></li>
59 <li><a href="qsplineseries.html">QSplineSeries</a></li>
46 <li><a href="qsplineseries.html">QSplineSeries</a></li>
60 <li><a href="qhxymodelmapper.html">QHXYModelMapper</a></li>
47 <li><a href="qhxymodelmapper.html">QHXYModelMapper</a></li>
61 <li><a href="qvxymodelmapper.html">QVXYModelMapper</a></li>
48 <li><a href="qvxymodelmapper.html">QVXYModelMapper</a></li>
62 </ul>
49 </ul>
63 </td>
50 </td>
64 </tr>
51 </tr>
65 </table>
52 </table>
66 <table cellpadding="2" cellspacing="1" border="0" width="100%" class="indextable">
53 <table cellpadding="2" cellspacing="1" border="0" width="100%" class="indextable">
67 <tr>
54 <tr>
68 <th class="titleheader" width="25%">
55 <th class="titleheader" width="25%">
69 Pie chart
56 Pie chart
70 </th>
57 </th>
71 <th class="titleheader" width="25%">
58 <th class="titleheader" width="25%">
72 Bar chart
59 Bar chart
73 </th>
60 </th>
74 <tr>
61 <tr>
75 <td valign="top">
62 <td valign="top">
76 <ul>
63 <ul>
77 <li><a href="qpieseries.html">QPieSeries</a></li>
64 <li><a href="qpieseries.html">QPieSeries</a></li>
78 <li><a href="qpieslice.html">QPieSlice</a></li>
65 <li><a href="qpieslice.html">QPieSlice</a></li>
79 <li><a href="qhpiemodelmapper.html">QHPieModelMapper</a></li>
66 <li><a href="qhpiemodelmapper.html">QHPieModelMapper</a></li>
80 <li><a href="qvpiemodelmapper.html">QVPieModelMapper</a></li>
67 <li><a href="qvpiemodelmapper.html">QVPieModelMapper</a></li>
81 </ul>
68 </ul>
82 </td>
69 </td>
83 <td valign="top">
70 <td valign="top">
84 <ul>
71 <ul>
85 <li><a href="qbarseries.html">QBarSeries</a></li>
72 <li><a href="qbarseries.html">QBarSeries</a></li>
86 <li><a href="qbarset.html">QBarSet</a></li>
73 <li><a href="qbarset.html">QBarSet</a></li>
87 <li><a href="qgroupedbarseries.html">QGroupedBarSeries</a></li>
74 <li><a href="qgroupedbarseries.html">QGroupedBarSeries</a></li>
88 <li><a href="qpercentbarseries.html">QPercentBarSeries</a></li>
75 <li><a href="qpercentbarseries.html">QPercentBarSeries</a></li>
89 <li><a href="qstackedbarseries.html">QStackedBarSeries</a></li>
76 <li><a href="qstackedbarseries.html">QStackedBarSeries</a></li>
90 <li><a href="qhbarmodelmapper.html">QHBarModelMapper</a></li>
77 <li><a href="qhbarmodelmapper.html">QHBarModelMapper</a></li>
91 <li><a href="qvbarmodelmapper.html">QVBarModelMapper</a></li>
78 <li><a href="qvbarmodelmapper.html">QVBarModelMapper</a></li>
92 </ul>
79 </ul>
93 </td>
80 </td>
94 </tr>
81 </tr>
95 </table>
82 </table>
96 \endraw
83 \endraw
97
84
98 */
85 */
@@ -1,73 +1,64
1 /*!
1 /*!
2 \page gettingstarted.html
2 \page gettingstarted.html
3 \title QtCommercial Charts getting started
3 \title QtCommercial Charts getting started
4 \keyword Introduction
4 \keyword Introduction
5
5
6 You can obtain the QtCommercial Charts package from \l {http://www.digia.com/en/Qt/Log-in-Customer-Portal/} {Customer portal}.
7
8 Compiling:
6 Compiling:
9 \code
7 \code
10 qmake CONFIG+=release
8 qmake CONFIG+=release
11 make
9 make
12 make install
10 make install
13 \endcode
11 \endcode
14
12
15 Depending on the OS and the compiler you are using "make" might need to be replaced with another command like: nmake, mingw32-make, etc.
13 Depending on the OS and the compiler you are using "make" might need to be replaced with another command like: nmake, mingw32-make, etc.
16
14
15 To uninstall the QtCommercialCharts run:
16 \code
17 make uninstall
18 \endcode
19
17 On Windows platforms both debug and release configurations are built by default at the same time.
20 On Windows platforms both debug and release configurations are built by default at the same time.
18 To build both at the same time on other platforms invoke the following command:
21 To build both at the same time on other platforms invoke the following command:
19
22
20 \code
23 \code
21 make all
24 make all
22 \endcode
25 \endcode
23
26
24 Compiling as a static library (lib only):
27 Compiling as a static library (lib only):
25 \code
28 \code
26 qmake CONFIG+=staticlib
29 qmake CONFIG+=staticlib
27 make
30 make
28 make install
31 make install
29 \endcode
32 \endcode
30
33
31 \bold {New project}
34 \bold {New project}
32
35
33 Create a new project in a usual way and then add to your project's *.pro file following line:
36 Create a new project in a usual way and then add to your project's *.pro file following line:
34
37
35 \code
38 \code
36 CONFIG += qtcommercialchart
39 CONFIG += qtcommercialchart
37 \endcode
40 \endcode
38
41
39 Or if you have not installed charts after building:
40
41 \code
42 CHARTSLIB = QtCommercialChart
43 CONFIG(debug, debug|release) {
44 mac: CHARTSLIB = $$join(CHARTSLIB,,,_debug)
45 win32: CHARTSLIB = $$join(CHARTSLIB,,,d)
46 }
47 INCLUDEPATH += <path_to_charts_folder>/include
48 LIBS += -L<path_to_charts_folder>/lib -l$$CHARTSLIB
49 \endcode
50
51 \bold {Widget project}
42 \bold {Widget project}
52
43
53 To use the QCharts classes add QtCommercialChart namespace macro in your header file.
44 To use the QCharts classes add QtCommercialChart namespace macro in your header file.
54 \code
45 \code
55 #include<QWidget>
46 #include<QWidget>
56 #include<QChartView>
47 #include<QChartView>
57
48
58 QTCOMMERCIALCHART_USE_NAMESPACE
49 QTCOMMERCIALCHART_USE_NAMESPACE
59
50
60 class ExampleWidget : public QWidget
51 class ExampleWidget : public QWidget
61 \endcode
52 \endcode
62
53
63 \bold {QML project}
54 \bold {QML project}
64
55
65 Add an import line to your *.qml file:
56 Add an import line to your *.qml file:
66 \code
57 \code
67 import QtCommercial.Chart 1.0
58 import QtCommercial.Chart 1.0
68 \endcode
59 \endcode
69
60
70 \raw HTML
61 \raw HTML
71 \endraw
62 \endraw
72
63
73 */
64 */
@@ -1,45 +1,45
1 /*!
1 /*!
2 \page index.html
2 \page index.html
3 \keyword About
3 \keyword About
4
4
5 \raw HTML
5 \raw HTML
6 <div class="qchart">
6 <div class="qchart">
7 <img src="images/qt_commercial_logo.png" alt="qtcommercial"/>
7 <img src="images/qt_commercial_logo.png" alt="qtcommercial"/>
8
8
9 <p>
9 <p>
10 QCharts is a part of Qt Commercial addons package. It provides a set of easy to use chart
10 QCharts is a part of Qt Commercial addons package. It provides a set of easy to use chart
11 components which are available for Qt Commercial customers. It uses Qt Graphics View
11 components which are available for Qt Commercial customers. It uses Qt Graphics View
12 Framework, therefore charts can be easily integrated to modern 2D user interfaces. QCharts can
12 Framework, therefore charts can be easily integrated to modern user interfaces. QCharts can
13 be used as QWidgets, QGraphicsWidget or QML elements. Users can easily create impressive
13 be used as QWidgets, QGraphicsWidget or QML elements. Users can easily create impressive
14 graphs by selecting one of the charts themes.
14 graphs by selecting one of the charts themes.
15 </p>
15 </p>
16
16
17 <table>
17 <table>
18 <tr>
18 <tr>
19 <td><a href="examples-linechart.html"><img src="images/examples_linechart.png" width="440" alt="linechart" /></a></td>
19 <td><a href="examples-linechart.html"><img src="images/examples_linechart.png" width="440" alt="linechart" /></a></td>
20 <td><a href="examples-areachart.html"><img src="images/examples_areachart.png" width="440" alt="areachart" /></a></td>
20 <td><a href="examples-areachart.html"><img src="images/examples_areachart.png" width="440" alt="areachart" /></a></td>
21 </tr>
21 </tr>
22 <tr>
22 <tr>
23 <td><a href="examples-scatterchart.html"><img src="images/examples_scatterchart.png" width="440" alt="scatterchart" /></a></td>
23 <td><a href="examples-scatterchart.html"><img src="images/examples_scatterchart.png" width="440" alt="scatterchart" /></a></td>
24 <td><a href="examples-barchart.html"><img src="images/examples_barchart.png" width="440" alt="barchart" /></a></td>
24 <td><a href="examples-barchart.html"><img src="images/examples_barchart.png" width="440" alt="barchart" /></a></td>
25 </tr>
25 </tr>
26 <tr>
26 <tr>
27 <td><a href="examples-groupedbarchart.html"><img src="images/examples_groupedbarchart.png" width="440" alt="groupedbarcchart" /></a></td>
27 <td><a href="examples-groupedbarchart.html"><img src="images/examples_groupedbarchart.png" width="440" alt="groupedbarcchart" /></a></td>
28 <td><a href="examples-stackedbarchart.html"><img src="images/examples_stackedbarchart.png" width="440" alt="stackedbarchart" /></a></td>
28 <td><a href="examples-stackedbarchart.html"><img src="images/examples_stackedbarchart.png" width="440" alt="stackedbarchart" /></a></td>
29 </tr>
29 </tr>
30 <tr>
30 <tr>
31 <td><a href="examples-percentbarchart.html"><img src="images/examples_percentbarchart.png" width="440" alt="percentbarcchart" /></a></td>
31 <td><a href="examples-percentbarchart.html"><img src="images/examples_percentbarchart.png" width="440" alt="percentbarcchart" /></a></td>
32 <td><a href="examples-splinechart.html"><img src="images/examples_splinechart.png" width="440" alt="linechart" /></a></td>
32 <td><a href="examples-splinechart.html"><img src="images/examples_splinechart.png" width="440" alt="linechart" /></a></td>
33 </tr>
33 </tr>
34 <tr>
34 <tr>
35 <td><a href="examples-customchart.html"><img src="images/examples_customchart.png" width="440" alt="customerchart" /></a></td>
35 <td><a href="examples-customchart.html"><img src="images/examples_customchart.png" width="440" alt="customerchart" /></a></td>
36 <td><a href="examples-piechart.html"><img src="images/examples_piechart.png" width="440" alt="piechart" /></a></td>
36 <td><a href="examples-piechart.html"><img src="images/examples_piechart.png" width="440" alt="piechart" /></a></td>
37 </tr>
37 </tr>
38 <tr>
38 <tr>
39 <td><a href="demos-chartthemes.html"><img src="images/demo_chartthemes_blue_cerulean.png" width=440 alt="charttheme" /></a></td>
39 <td><a href="demos-chartthemes.html"><img src="images/demo_chartthemes_blue_cerulean.png" width=440 alt="charttheme" /></a></td>
40 <td><a href="examples-zoomlinechart.html"><img src="images/examples_zoomlinechart2.png" width="440" alt="zoomlinechart" /></a></td>
40 <td><a href="examples-zoomlinechart.html"><img src="images/examples_zoomlinechart2.png" width="440" alt="zoomlinechart" /></a></td>
41 </tr>
41 </tr>
42 </table>
42 </table>
43 </div>
43 </div>
44 \endraw
44 \endraw
45 */
45 */
General Comments 0
You need to be logged in to leave comments. Login now