diff options
Diffstat (limited to 'src/charts/doc')
134 files changed, 2748 insertions, 0 deletions
diff --git a/src/charts/doc/images/api_category_axis.png b/src/charts/doc/images/api_category_axis.png Binary files differnew file mode 100644 index 00000000..97fe6cd3 --- /dev/null +++ b/src/charts/doc/images/api_category_axis.png diff --git a/src/charts/doc/images/api_datatime_axis.png b/src/charts/doc/images/api_datatime_axis.png Binary files differnew file mode 100644 index 00000000..1c8c8311 --- /dev/null +++ b/src/charts/doc/images/api_datatime_axis.png diff --git a/src/charts/doc/images/arrow_down.png b/src/charts/doc/images/arrow_down.png Binary files differnew file mode 100644 index 00000000..9d01e97f --- /dev/null +++ b/src/charts/doc/images/arrow_down.png diff --git a/src/charts/doc/images/bg.png b/src/charts/doc/images/bg.png Binary files differnew file mode 100644 index 00000000..91c180a2 --- /dev/null +++ b/src/charts/doc/images/bg.png diff --git a/src/charts/doc/images/breadcrumb.png b/src/charts/doc/images/breadcrumb.png Binary files differnew file mode 100644 index 00000000..0ded5514 --- /dev/null +++ b/src/charts/doc/images/breadcrumb.png diff --git a/src/charts/doc/images/bullet_dn.png b/src/charts/doc/images/bullet_dn.png Binary files differnew file mode 100644 index 00000000..f7762472 --- /dev/null +++ b/src/charts/doc/images/bullet_dn.png diff --git a/src/charts/doc/images/bullet_gt.png b/src/charts/doc/images/bullet_gt.png Binary files differnew file mode 100644 index 00000000..7561b4ed --- /dev/null +++ b/src/charts/doc/images/bullet_gt.png diff --git a/src/charts/doc/images/bullet_sq.png b/src/charts/doc/images/bullet_sq.png Binary files differnew file mode 100644 index 00000000..a84845e3 --- /dev/null +++ b/src/charts/doc/images/bullet_sq.png diff --git a/src/charts/doc/images/bullet_up.png b/src/charts/doc/images/bullet_up.png Binary files differnew file mode 100644 index 00000000..7de2f069 --- /dev/null +++ b/src/charts/doc/images/bullet_up.png diff --git a/src/charts/doc/images/digia_logo.png b/src/charts/doc/images/digia_logo.png Binary files differnew file mode 100644 index 00000000..6ca67c84 --- /dev/null +++ b/src/charts/doc/images/digia_logo.png diff --git a/src/charts/doc/images/examples_areachart.png b/src/charts/doc/images/examples_areachart.png Binary files differnew file mode 100644 index 00000000..d48f7147 --- /dev/null +++ b/src/charts/doc/images/examples_areachart.png diff --git a/src/charts/doc/images/examples_audio.png b/src/charts/doc/images/examples_audio.png Binary files differnew file mode 100644 index 00000000..8859ee2e --- /dev/null +++ b/src/charts/doc/images/examples_audio.png diff --git a/src/charts/doc/images/examples_barchart.png b/src/charts/doc/images/examples_barchart.png Binary files differnew file mode 100644 index 00000000..bdd51199 --- /dev/null +++ b/src/charts/doc/images/examples_barchart.png diff --git a/src/charts/doc/images/examples_barmodelmapper.png b/src/charts/doc/images/examples_barmodelmapper.png Binary files differnew file mode 100644 index 00000000..6d41e5f5 --- /dev/null +++ b/src/charts/doc/images/examples_barmodelmapper.png diff --git a/src/charts/doc/images/examples_boxplotchart.png b/src/charts/doc/images/examples_boxplotchart.png Binary files differnew file mode 100644 index 00000000..6547a34b --- /dev/null +++ b/src/charts/doc/images/examples_boxplotchart.png diff --git a/src/charts/doc/images/examples_callout.png b/src/charts/doc/images/examples_callout.png Binary files differnew file mode 100644 index 00000000..cc597110 --- /dev/null +++ b/src/charts/doc/images/examples_callout.png diff --git a/src/charts/doc/images/examples_chartthemes_blue_cerulean.png b/src/charts/doc/images/examples_chartthemes_blue_cerulean.png Binary files differnew file mode 100644 index 00000000..69ac3793 --- /dev/null +++ b/src/charts/doc/images/examples_chartthemes_blue_cerulean.png diff --git a/src/charts/doc/images/examples_chartthemes_brown_sand.png b/src/charts/doc/images/examples_chartthemes_brown_sand.png Binary files differnew file mode 100644 index 00000000..ff5157a9 --- /dev/null +++ b/src/charts/doc/images/examples_chartthemes_brown_sand.png diff --git a/src/charts/doc/images/examples_chartthemes_light.png b/src/charts/doc/images/examples_chartthemes_light.png Binary files differnew file mode 100644 index 00000000..e6a64992 --- /dev/null +++ b/src/charts/doc/images/examples_chartthemes_light.png diff --git a/src/charts/doc/images/examples_customchart.png b/src/charts/doc/images/examples_customchart.png Binary files differnew file mode 100644 index 00000000..c416ef54 --- /dev/null +++ b/src/charts/doc/images/examples_customchart.png diff --git a/src/charts/doc/images/examples_datetimeaxis.png b/src/charts/doc/images/examples_datetimeaxis.png Binary files differnew file mode 100644 index 00000000..cedda80a --- /dev/null +++ b/src/charts/doc/images/examples_datetimeaxis.png diff --git a/src/charts/doc/images/examples_donutbreakdown.png b/src/charts/doc/images/examples_donutbreakdown.png Binary files differnew file mode 100644 index 00000000..a0569239 --- /dev/null +++ b/src/charts/doc/images/examples_donutbreakdown.png diff --git a/src/charts/doc/images/examples_donutchart.png b/src/charts/doc/images/examples_donutchart.png Binary files differnew file mode 100644 index 00000000..5eaf3fa3 --- /dev/null +++ b/src/charts/doc/images/examples_donutchart.png diff --git a/src/charts/doc/images/examples_dynamicspline1.png b/src/charts/doc/images/examples_dynamicspline1.png Binary files differnew file mode 100644 index 00000000..bcee80ed --- /dev/null +++ b/src/charts/doc/images/examples_dynamicspline1.png diff --git a/src/charts/doc/images/examples_dynamicspline2.png b/src/charts/doc/images/examples_dynamicspline2.png Binary files differnew file mode 100644 index 00000000..595c38b1 --- /dev/null +++ b/src/charts/doc/images/examples_dynamicspline2.png diff --git a/src/charts/doc/images/examples_horizontalbarchart.png b/src/charts/doc/images/examples_horizontalbarchart.png Binary files differnew file mode 100644 index 00000000..dfa50d60 --- /dev/null +++ b/src/charts/doc/images/examples_horizontalbarchart.png diff --git a/src/charts/doc/images/examples_horizontalpercentbarchart.png b/src/charts/doc/images/examples_horizontalpercentbarchart.png Binary files differnew file mode 100644 index 00000000..726a715b --- /dev/null +++ b/src/charts/doc/images/examples_horizontalpercentbarchart.png diff --git a/src/charts/doc/images/examples_horizontalstackedbarchart.png b/src/charts/doc/images/examples_horizontalstackedbarchart.png Binary files differnew file mode 100644 index 00000000..32806bb6 --- /dev/null +++ b/src/charts/doc/images/examples_horizontalstackedbarchart.png diff --git a/src/charts/doc/images/examples_legend_detach.png b/src/charts/doc/images/examples_legend_detach.png Binary files differnew file mode 100644 index 00000000..3376a4a0 --- /dev/null +++ b/src/charts/doc/images/examples_legend_detach.png diff --git a/src/charts/doc/images/examples_legend_detach2.png b/src/charts/doc/images/examples_legend_detach2.png Binary files differnew file mode 100644 index 00000000..5cc33819 --- /dev/null +++ b/src/charts/doc/images/examples_legend_detach2.png diff --git a/src/charts/doc/images/examples_legendmarkers.png b/src/charts/doc/images/examples_legendmarkers.png Binary files differnew file mode 100644 index 00000000..ac0ffef1 --- /dev/null +++ b/src/charts/doc/images/examples_legendmarkers.png diff --git a/src/charts/doc/images/examples_lineandbar.png b/src/charts/doc/images/examples_lineandbar.png Binary files differnew file mode 100644 index 00000000..0d7a66d7 --- /dev/null +++ b/src/charts/doc/images/examples_lineandbar.png diff --git a/src/charts/doc/images/examples_linechart.png b/src/charts/doc/images/examples_linechart.png Binary files differnew file mode 100644 index 00000000..57177907 --- /dev/null +++ b/src/charts/doc/images/examples_linechart.png diff --git a/src/charts/doc/images/examples_logvalueaxis.png b/src/charts/doc/images/examples_logvalueaxis.png Binary files differnew file mode 100644 index 00000000..36ae562d --- /dev/null +++ b/src/charts/doc/images/examples_logvalueaxis.png diff --git a/src/charts/doc/images/examples_modeldata.png b/src/charts/doc/images/examples_modeldata.png Binary files differnew file mode 100644 index 00000000..aa301fb9 --- /dev/null +++ b/src/charts/doc/images/examples_modeldata.png diff --git a/src/charts/doc/images/examples_multiaxis.png b/src/charts/doc/images/examples_multiaxis.png Binary files differnew file mode 100644 index 00000000..4e6c23f2 --- /dev/null +++ b/src/charts/doc/images/examples_multiaxis.png diff --git a/src/charts/doc/images/examples_nesteddonuts.png b/src/charts/doc/images/examples_nesteddonuts.png Binary files differnew file mode 100644 index 00000000..bc8825c8 --- /dev/null +++ b/src/charts/doc/images/examples_nesteddonuts.png diff --git a/src/charts/doc/images/examples_percentbarchart.png b/src/charts/doc/images/examples_percentbarchart.png Binary files differnew file mode 100644 index 00000000..74d7389b --- /dev/null +++ b/src/charts/doc/images/examples_percentbarchart.png diff --git a/src/charts/doc/images/examples_percentbarchart_legend.png b/src/charts/doc/images/examples_percentbarchart_legend.png Binary files differnew file mode 100644 index 00000000..ed1ed4f6 --- /dev/null +++ b/src/charts/doc/images/examples_percentbarchart_legend.png diff --git a/src/charts/doc/images/examples_piechart.png b/src/charts/doc/images/examples_piechart.png Binary files differnew file mode 100644 index 00000000..4977fa33 --- /dev/null +++ b/src/charts/doc/images/examples_piechart.png diff --git a/src/charts/doc/images/examples_piechartdrill1.png b/src/charts/doc/images/examples_piechartdrill1.png Binary files differnew file mode 100644 index 00000000..cdc56a9d --- /dev/null +++ b/src/charts/doc/images/examples_piechartdrill1.png diff --git a/src/charts/doc/images/examples_piechartdrill2.png b/src/charts/doc/images/examples_piechartdrill2.png Binary files differnew file mode 100644 index 00000000..384acda8 --- /dev/null +++ b/src/charts/doc/images/examples_piechartdrill2.png diff --git a/src/charts/doc/images/examples_polarchart.png b/src/charts/doc/images/examples_polarchart.png Binary files differnew file mode 100644 index 00000000..55f922c9 --- /dev/null +++ b/src/charts/doc/images/examples_polarchart.png diff --git a/src/charts/doc/images/examples_qmlaxes1.png b/src/charts/doc/images/examples_qmlaxes1.png Binary files differnew file mode 100644 index 00000000..3494766a --- /dev/null +++ b/src/charts/doc/images/examples_qmlaxes1.png diff --git a/src/charts/doc/images/examples_qmlaxes2.png b/src/charts/doc/images/examples_qmlaxes2.png Binary files differnew file mode 100644 index 00000000..d6c9164d --- /dev/null +++ b/src/charts/doc/images/examples_qmlaxes2.png diff --git a/src/charts/doc/images/examples_qmlaxes3.png b/src/charts/doc/images/examples_qmlaxes3.png Binary files differnew file mode 100644 index 00000000..eeef7bfa --- /dev/null +++ b/src/charts/doc/images/examples_qmlaxes3.png diff --git a/src/charts/doc/images/examples_qmlboxplot.png b/src/charts/doc/images/examples_qmlboxplot.png Binary files differnew file mode 100644 index 00000000..f9ddc489 --- /dev/null +++ b/src/charts/doc/images/examples_qmlboxplot.png diff --git a/src/charts/doc/images/examples_qmlchart1.png b/src/charts/doc/images/examples_qmlchart1.png Binary files differnew file mode 100644 index 00000000..6a3c7812 --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart1.png diff --git a/src/charts/doc/images/examples_qmlchart10.png b/src/charts/doc/images/examples_qmlchart10.png Binary files differnew file mode 100644 index 00000000..5fdd744c --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart10.png diff --git a/src/charts/doc/images/examples_qmlchart11.png b/src/charts/doc/images/examples_qmlchart11.png Binary files differnew file mode 100644 index 00000000..663967e7 --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart11.png diff --git a/src/charts/doc/images/examples_qmlchart12.png b/src/charts/doc/images/examples_qmlchart12.png Binary files differnew file mode 100644 index 00000000..e00465ad --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart12.png diff --git a/src/charts/doc/images/examples_qmlchart2.png b/src/charts/doc/images/examples_qmlchart2.png Binary files differnew file mode 100644 index 00000000..36a7873b --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart2.png diff --git a/src/charts/doc/images/examples_qmlchart3.png b/src/charts/doc/images/examples_qmlchart3.png Binary files differnew file mode 100644 index 00000000..74e3299c --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart3.png diff --git a/src/charts/doc/images/examples_qmlchart4.png b/src/charts/doc/images/examples_qmlchart4.png Binary files differnew file mode 100644 index 00000000..7b0d96a3 --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart4.png diff --git a/src/charts/doc/images/examples_qmlchart5.png b/src/charts/doc/images/examples_qmlchart5.png Binary files differnew file mode 100644 index 00000000..129a4e90 --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart5.png diff --git a/src/charts/doc/images/examples_qmlchart6.png b/src/charts/doc/images/examples_qmlchart6.png Binary files differnew file mode 100644 index 00000000..6968ffe3 --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart6.png diff --git a/src/charts/doc/images/examples_qmlchart7.png b/src/charts/doc/images/examples_qmlchart7.png Binary files differnew file mode 100644 index 00000000..acf29aed --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart7.png diff --git a/src/charts/doc/images/examples_qmlchart8.png b/src/charts/doc/images/examples_qmlchart8.png Binary files differnew file mode 100644 index 00000000..d1671758 --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart8.png diff --git a/src/charts/doc/images/examples_qmlchart9.png b/src/charts/doc/images/examples_qmlchart9.png Binary files differnew file mode 100644 index 00000000..1ebbc7dc --- /dev/null +++ b/src/charts/doc/images/examples_qmlchart9.png diff --git a/src/charts/doc/images/examples_qmlcustomizations.png b/src/charts/doc/images/examples_qmlcustomizations.png Binary files differnew file mode 100644 index 00000000..d28f5c80 --- /dev/null +++ b/src/charts/doc/images/examples_qmlcustomizations.png diff --git a/src/charts/doc/images/examples_qmlcustomlegend1.png b/src/charts/doc/images/examples_qmlcustomlegend1.png Binary files differnew file mode 100644 index 00000000..7f235934 --- /dev/null +++ b/src/charts/doc/images/examples_qmlcustomlegend1.png diff --git a/src/charts/doc/images/examples_qmlcustomlegend2.png b/src/charts/doc/images/examples_qmlcustomlegend2.png Binary files differnew file mode 100644 index 00000000..184615e9 --- /dev/null +++ b/src/charts/doc/images/examples_qmlcustomlegend2.png diff --git a/src/charts/doc/images/examples_qmlcustomlegend3.png b/src/charts/doc/images/examples_qmlcustomlegend3.png Binary files differnew file mode 100644 index 00000000..6f0c81c4 --- /dev/null +++ b/src/charts/doc/images/examples_qmlcustomlegend3.png diff --git a/src/charts/doc/images/examples_qmlcustommodel.png b/src/charts/doc/images/examples_qmlcustommodel.png Binary files differnew file mode 100644 index 00000000..1bf610f8 --- /dev/null +++ b/src/charts/doc/images/examples_qmlcustommodel.png diff --git a/src/charts/doc/images/examples_qmlf1legends.png b/src/charts/doc/images/examples_qmlf1legends.png Binary files differnew file mode 100644 index 00000000..789d45ab --- /dev/null +++ b/src/charts/doc/images/examples_qmlf1legends.png diff --git a/src/charts/doc/images/examples_qmloscilloscope.png b/src/charts/doc/images/examples_qmloscilloscope.png Binary files differnew file mode 100644 index 00000000..32e28ffb --- /dev/null +++ b/src/charts/doc/images/examples_qmloscilloscope.png diff --git a/src/charts/doc/images/examples_qmlpiechart.png b/src/charts/doc/images/examples_qmlpiechart.png Binary files differnew file mode 100644 index 00000000..bd347551 --- /dev/null +++ b/src/charts/doc/images/examples_qmlpiechart.png diff --git a/src/charts/doc/images/examples_qmlpolarchart1.png b/src/charts/doc/images/examples_qmlpolarchart1.png Binary files differnew file mode 100644 index 00000000..8cb3e8d1 --- /dev/null +++ b/src/charts/doc/images/examples_qmlpolarchart1.png diff --git a/src/charts/doc/images/examples_qmlpolarchart2.png b/src/charts/doc/images/examples_qmlpolarchart2.png Binary files differnew file mode 100644 index 00000000..02bcd778 --- /dev/null +++ b/src/charts/doc/images/examples_qmlpolarchart2.png diff --git a/src/charts/doc/images/examples_qmlpolarchart3.png b/src/charts/doc/images/examples_qmlpolarchart3.png Binary files differnew file mode 100644 index 00000000..184f5c9e --- /dev/null +++ b/src/charts/doc/images/examples_qmlpolarchart3.png diff --git a/src/charts/doc/images/examples_qmlweather.png b/src/charts/doc/images/examples_qmlweather.png Binary files differnew file mode 100644 index 00000000..feab0364 --- /dev/null +++ b/src/charts/doc/images/examples_qmlweather.png diff --git a/src/charts/doc/images/examples_scatterchart.png b/src/charts/doc/images/examples_scatterchart.png Binary files differnew file mode 100644 index 00000000..41900f66 --- /dev/null +++ b/src/charts/doc/images/examples_scatterchart.png diff --git a/src/charts/doc/images/examples_scatterinteractions.png b/src/charts/doc/images/examples_scatterinteractions.png Binary files differnew file mode 100644 index 00000000..cd4c78c0 --- /dev/null +++ b/src/charts/doc/images/examples_scatterinteractions.png diff --git a/src/charts/doc/images/examples_splinechart.png b/src/charts/doc/images/examples_splinechart.png Binary files differnew file mode 100644 index 00000000..733ddb17 --- /dev/null +++ b/src/charts/doc/images/examples_splinechart.png diff --git a/src/charts/doc/images/examples_stackedbarchart.png b/src/charts/doc/images/examples_stackedbarchart.png Binary files differnew file mode 100644 index 00000000..0c721305 --- /dev/null +++ b/src/charts/doc/images/examples_stackedbarchart.png diff --git a/src/charts/doc/images/examples_stackedbarchartdrilldown1.png b/src/charts/doc/images/examples_stackedbarchartdrilldown1.png Binary files differnew file mode 100644 index 00000000..9f128b6f --- /dev/null +++ b/src/charts/doc/images/examples_stackedbarchartdrilldown1.png diff --git a/src/charts/doc/images/examples_stackedbarchartdrilldown2.png b/src/charts/doc/images/examples_stackedbarchartdrilldown2.png Binary files differnew file mode 100644 index 00000000..67f8afbc --- /dev/null +++ b/src/charts/doc/images/examples_stackedbarchartdrilldown2.png diff --git a/src/charts/doc/images/examples_temperaturerecords.png b/src/charts/doc/images/examples_temperaturerecords.png Binary files differnew file mode 100644 index 00000000..ce54eede --- /dev/null +++ b/src/charts/doc/images/examples_temperaturerecords.png diff --git a/src/charts/doc/images/examples_zoomlinechart1.png b/src/charts/doc/images/examples_zoomlinechart1.png Binary files differnew file mode 100644 index 00000000..9162035e --- /dev/null +++ b/src/charts/doc/images/examples_zoomlinechart1.png diff --git a/src/charts/doc/images/examples_zoomlinechart2.png b/src/charts/doc/images/examples_zoomlinechart2.png Binary files differnew file mode 100644 index 00000000..2a971311 --- /dev/null +++ b/src/charts/doc/images/examples_zoomlinechart2.png diff --git a/src/charts/doc/images/horBar.png b/src/charts/doc/images/horBar.png Binary files differnew file mode 100644 index 00000000..100fe91c --- /dev/null +++ b/src/charts/doc/images/horBar.png diff --git a/src/charts/doc/images/piechart_customization.png b/src/charts/doc/images/piechart_customization.png Binary files differnew file mode 100644 index 00000000..d52ad583 --- /dev/null +++ b/src/charts/doc/images/piechart_customization.png diff --git a/src/charts/doc/images/qcharts.png b/src/charts/doc/images/qcharts.png Binary files differnew file mode 100644 index 00000000..69098333 --- /dev/null +++ b/src/charts/doc/images/qcharts.png diff --git a/src/charts/doc/images/qt-logo.png b/src/charts/doc/images/qt-logo.png Binary files differnew file mode 100644 index 00000000..14ddf2a0 --- /dev/null +++ b/src/charts/doc/images/qt-logo.png diff --git a/src/charts/doc/qtcharts.qdocconf b/src/charts/doc/qtcharts.qdocconf new file mode 100644 index 00000000..5fb7181c --- /dev/null +++ b/src/charts/doc/qtcharts.qdocconf @@ -0,0 +1,66 @@ +include($QT_INSTALL_DOCS/global/macros.qdocconf) +include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) +include($QT_INSTALL_DOCS/global/compat.qdocconf) +include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) +include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) + +project = Qt Charts +description = Qt Charts Reference Documentation +version = 2.0.0 + +sourcedirs += .. +headerdirs += .. +exampledirs += ../../../examples/charts \ + snippets +imagedirs += images +examplesinstallpath = charts + +indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \ + $QT_INSTALL_DOCS/qtgui/qtgui.index \ + $QT_INSTALL_DOCS/qtqml/qtqml.index \ + $QT_INSTALL_DOCS/qtquick/qtquick.index \ + $QT_INSTALL_DOCS/qtmultimedia/qtmultimedia.index + +Cpp.ignoretokens = Q_INVOKABLE \ + QT_CHARTS_EXPORT \ + QT_CHARTS_END_NAMESPACE \ + QT_CHARTS_BEGIN_NAMESPACE + +qhp.projects = QtCharts +qhp.QtCharts.file = qtcharts.qhp +qhp.QtCharts.namespace = com.digia.qtcharts.200 +qhp.QtCharts.virtualFolder = qtcharts +qhp.QtCharts.indexTitle = Qt Charts Reference +qhp.QtCharts.indexRoot = + +qhp.QtCharts.filterAttributes = qtcharts 2.0.0 qtrefdoc +qhp.QtCharts.customFilters.Qt.name = QtCharts 2.0.0 +qhp.QtCharts.customFilters.Qt.filterAttributes = qtcharts 2.0.0 + +qhp.QtCharts.subprojects = gettingstarted classes types examples + +qhp.QtCharts.subprojects.gettingstarted.title = Getting Started +qhp.QtCharts.subprojects.gettingstarted.indexTitle = Qt Charts Getting Started +qhp.QtCharts.subprojects.gettingstarted.selectors = fake:page +qhp.QtCharts.subprojects.gettingstarted.sortPages = true + +qhp.QtCharts.subprojects.classes.title = C++ Classes +qhp.QtCharts.subprojects.classes.indexTitle = Qt Charts C++ Classes +qhp.QtCharts.subprojects.classes.selectors = class +qhp.QtCharts.subprojects.classes.sortPages = true + +qhp.QtCharts.subprojects.types.title = QML Types +qhp.QtCharts.subprojects.types.indexTitle = Qt Charts QML Types +qhp.QtCharts.subprojects.types.selectors = fake:qmlclass +qhp.QtCharts.subprojects.types.sortPages = true + +qhp.QtCharts.subprojects.examples.title = Examples +qhp.QtCharts.subprojects.examples.indexTitle = Qt Charts Examples +qhp.QtCharts.subprojects.examples.selectors = fake:example +qhp.QtCharts.subprojects.examples.sortPages = true + +navigation.landingpage = Qt Charts +navigation.cppclassespage = Qt Charts C++ Classes +navigation.qmltypespage = Qt Charts QML Types + +buildversion = Qt Charts $QT_VERSION Reference Documentation diff --git a/src/charts/doc/snippets/doc_src_qmlcharts.cpp b/src/charts/doc/snippets/doc_src_qmlcharts.cpp new file mode 100644 index 00000000..3047db7a --- /dev/null +++ b/src/charts/doc/snippets/doc_src_qmlcharts.cpp @@ -0,0 +1,21 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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 QtCharts module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise 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 +** +****************************************************************************/ + +//! [0] +import QtCharts 2.0 +//! [0] diff --git a/src/charts/doc/snippets/doc_src_qtcharts.cpp b/src/charts/doc/snippets/doc_src_qtcharts.cpp new file mode 100644 index 00000000..d841bb88 --- /dev/null +++ b/src/charts/doc/snippets/doc_src_qtcharts.cpp @@ -0,0 +1,35 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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 QtCharts module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise 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 +** +****************************************************************************/ + +//! [0] +#include <QtCharts> + +using namespace QtCharts; +//! [0] + +//! [1] +qmake CONFIG+=static +make +make install +//! [1] + +//! [2] +qmake +make +./qmlpolarchart +//! [2] diff --git a/src/charts/doc/snippets/doc_src_qtcharts.pro b/src/charts/doc/snippets/doc_src_qtcharts.pro new file mode 100644 index 00000000..819b1c9c --- /dev/null +++ b/src/charts/doc/snippets/doc_src_qtcharts.pro @@ -0,0 +1,21 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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 QtCharts module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise 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 +** +****************************************************************************/ + +#! [0] +QT += charts +#! [0] diff --git a/src/charts/doc/src/examples-areachart.qdoc b/src/charts/doc/src/examples-areachart.qdoc new file mode 100644 index 00000000..f399adbe --- /dev/null +++ b/src/charts/doc/src/examples-areachart.qdoc @@ -0,0 +1,30 @@ +/*! + \example areachart + \title AreaChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple area chart. + + \image examples_areachart.png + + To create area charts, we need two QLineSeries instances. They are going to define the upper and lower boundary of the area. + + \snippet areachart/main.cpp 1 + + We add data to both series and use the stream operator. + + \snippet areachart/main.cpp 2 + + Now we create a QAreaSeries instance using two line series objects. We set the custom gradient fill and width of the outline. + + \snippet areachart/main.cpp 3 + + Last we create the QChartView instance, set the title, set anti-aliasing, and add the area series. We also create the default axes and specify the ranges on them. + + \snippet areachart/main.cpp 4 + + The chart is ready to be shown. + + \snippet areachart/main.cpp 5 + +*/ diff --git a/src/charts/doc/src/examples-audio.qdoc b/src/charts/doc/src/examples-audio.qdoc new file mode 100644 index 00000000..2a3a98ec --- /dev/null +++ b/src/charts/doc/src/examples-audio.qdoc @@ -0,0 +1,8 @@ +/*! + \example audio + \title Audio example + \ingroup qtcharts_examples + + \brief This example shows the drawing of dynamic data (microphone input). + \image examples_audio.png +*/ diff --git a/src/charts/doc/src/examples-barchart.qdoc b/src/charts/doc/src/examples-barchart.qdoc new file mode 100644 index 00000000..d217faac --- /dev/null +++ b/src/charts/doc/src/examples-barchart.qdoc @@ -0,0 +1,47 @@ +/*! + \example barchart + \title BarChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a bar chart. + + BarChart shows the data in sets as separate bars, which are in categories. + + \image examples_barchart.png + + The barsets are used in the same way in all barcharts. + To illustrate the difference between various barcharts, we use the same data in the examples. + Data that the barchart visualizes, is defined by the QBarSet instances. Here we create the sets and append data + to them. The data is appended here with the << operator. Alternatively, the append method could be used. + + \snippet barchart/main.cpp 1 + + We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories. + First values of each set are grouped together at first category second value to second category and so on. + + \snippet barchart/main.cpp 2 + + Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling + setAnimationOptions(QChart::SeriesAnimations) + + \snippet barchart/main.cpp 3 + + To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with a list of categories and + set it to be the x-axis of the chart. The chart takes ownership of axis. For y-axis we use default axis, which is created and scaled to series data + by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will + override the category axis. + + \snippet barchart/main.cpp 4 + + We also want to show the legend. To do that, we get the legend pointer from the chart and set it to visible. We also place the legend to the bottom of the chart by setting its alignment to Qt::AlignBottom. + + \snippet barchart/main.cpp 5 + + Finally we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet barchart/main.cpp 6 + + The chart is ready to be shown. We set the chart to be central widget of the window. We also set the size for the chart window and show it. + + \snippet barchart/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-barmodelmapper.qdoc b/src/charts/doc/src/examples-barmodelmapper.qdoc new file mode 100644 index 00000000..00d23326 --- /dev/null +++ b/src/charts/doc/src/examples-barmodelmapper.qdoc @@ -0,0 +1,58 @@ +/*! + \example barmodelmapper + \title BarModelMapper example + \ingroup qtcharts_examples + + \brief This example shows how to use QAbstractItemModel derived model as the data for the bar + series. + + \image examples_barmodelmapper.png + + Let's start by creating an instance of CustomTableModel class. + The CustomTableModel class is derived from QAbstractTableModel, and it was created for the purpose of this example. + The constructor of this class populates the model's internal data store with the data required for our chart example. + + \snippet barmodelmapper/tablewidget.cpp 1 + + We now have a model with data that we would like to display both on the chart and in a QTableView. + First, we create QTableView and tell it to use the model as a data source. To have the data presented nicely, the minimum width of the table view is set and its headers resize mode changed to stretch. + + \snippet barmodelmapper/tablewidget.cpp 2 + + Now we need a QChart instance to display the same data on the chart. + We also enable animations. It makes it easier to see how a modification to the model's data affects the chart. + + \snippet barmodelmapper/tablewidget.cpp 3 + + The first line of the code below creates new bar series. Variables firstRow and rowCount are used to define a custom model mapping. + Custom mapping allows to take only part of the data from the model. In this case data from 5 rows starting with the row with the index 3. + The following three lines create an instance of the QVBarModelMapper class and specify that the data for the bar sets should be taken from the model's columns with indexes from 1 to 4 (inclusive). + To create a connection between the series and the model we set both of those objects to QVBarModelMapper. + + Finally the series is added to the chart. + + \snippet barmodelmapper/tablewidget.cpp 4 + + To show in QTableView which data corresponds with which bar set, this example uses table coloring. + When series is added to the chart, it is assigned a color based on the currently selected theme. + Code below extracts that color from the series and uses it to create colored QTableView. + Coloring of the view is not a part of the QChart functionality. + + \snippet barmodelmapper/tablewidget.cpp 5 + + We would like to have categories placed on the chart's axis that describe what the data means. + Next snippet shows how to do that. + + \snippet barmodelmapper/tablewidget.cpp 6 + + To avoid setting up the QGraphicsScene we use the QChartView class that does it for us. The QChart object pointer is used as a parameter of the QChartView constructor. + To make the render look nicer Antialiasing is turned on and the minimum size of the chartView widget is set. + + \snippet barmodelmapper/tablewidget.cpp 7 + + Finally, we place both widgets in a layout and use the layout as the application layout. + + \snippet barmodelmapper/tablewidget.cpp 8 + + The application is ready. Try modifying the data in the table view and see how it affects the chart. +*/ diff --git a/src/charts/doc/src/examples-boxplotchart.qdoc b/src/charts/doc/src/examples-boxplotchart.qdoc new file mode 100644 index 00000000..c4d1eea4 --- /dev/null +++ b/src/charts/doc/src/examples-boxplotchart.qdoc @@ -0,0 +1,78 @@ +/*! + \example boxplotchart + \title Box and Whiskers Example + \ingroup qtcharts_examples + + \brief The example shows how to create a box-and-whiskers chart. + + The example also shows how to read the non-continuous data from a file, + arrange it and find medians needed for box-and-whiskers plotting. + + \image examples_boxplotchart.png + + To show the share deviation of two companies we start by creating two QBoxPlotSeries to handle monthly data. + + \snippet boxplotchart/main.cpp 1 + + QFile class is used to open a text file where the non-continuous data is kept. The BoxDataReader is an auxiliary class for + reading the text file and finding the extreme and median values from the data. The BoxDataReader is explained in more detail later. + The method readBox reads the values and sets them to the QBoxSet item which the method returns for the caller. The returned QBoxSet + item is added to the series. + + \snippet boxplotchart/main.cpp 2 + + In this section a second file is opened for reading the data for the second company. + + \snippet boxplotchart/main.cpp 3 + + In this code snippet a new QChart instance is created and previously created series are added to it. The title is also defined and + animation is set to be SeriesAnimation. + + \snippet boxplotchart/main.cpp 4 + + Here we ask the chart to create default axes for our presentation. We also set the range for the vertical axis by querying the pointer + for the axis from the chart, and then setting the min and max for that axis. + + \snippet boxplotchart/main.cpp 5 + + In this section we set the legends to be visible and place them at the bottom of the chart. + + \snippet boxplotchart/main.cpp 6 + + Finally, we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet boxplotchart/main.cpp 7 + + The chart is ready to be shown. We set the chart to be the central widget of the window. + We also set the size for the chart window and show it. + + \snippet boxplotchart/main.cpp 8 + + Here the method readBox is explained in detail. Firstly, a line is read from the file and lines starting with # are rejected + since they are considered as comment lines. + + \snippet boxplotchart/boxdatareader.cpp 1 + + In this file the data is arranged as number, space, number, or space. On this snippet the line is split into single number strings which + are stored on QStringList. + + \snippet boxplotchart/boxdatareader.cpp 2 + + The sortedList will hold the numbers in continuous order and in this code segment we show how to do it. First the sortedList is cleared and numbers + are read from the strList and stored into sortedList in double format. The qSort method arranges the sortedList into continuous order + starting from the smallest. + + \snippet boxplotchart/boxdatareader.cpp 3 + + Below you will find a code sample showing how to select extremes and medians from the continuous data. Firstly a new QBoxSet is created. + Lower and upper extremes are simple to select; they are just first and last items on the sortedList. For medians we use a helper + method findMedian which is explained later. For the median from the upper half we need to adjust the begin number if the + amount of the numbers is even or uneven. The end number for lower half comes naturally from int rounding. + + \snippet boxplotchart/boxdatareader.cpp 4 + + Below you will find the code sample for the method findMedian. If the amount of numbers is uneven we select the number from + the middle. For even amount numbers we take two numbers from the middle and calculate the mean value. + + \snippet boxplotchart/boxdatareader.cpp 5 +*/ diff --git a/src/charts/doc/src/examples-callout.qdoc b/src/charts/doc/src/examples-callout.qdoc new file mode 100644 index 00000000..1f5f8dcc --- /dev/null +++ b/src/charts/doc/src/examples-callout.qdoc @@ -0,0 +1,15 @@ +/*! + \example callout + \title Callout example + \ingroup qtcharts_examples + + \brief This example shows how to draw an additional element (a callout) on top of the chart. + \image examples_callout.png + + QChart class provides two methods that map between the scene coordinates and the series domain + (defined by the axes ranges). + + QPointF QChart::mapToPosition(const QPointF &value, QAbstractSeries *series) + + QPointF QChart::mapToValue(const QPointF &position, QAbstractSeries *series) +*/ diff --git a/src/charts/doc/src/examples-chartthemes.qdoc b/src/charts/doc/src/examples-chartthemes.qdoc new file mode 100644 index 00000000..d6121435 --- /dev/null +++ b/src/charts/doc/src/examples-chartthemes.qdoc @@ -0,0 +1,15 @@ +/*! + \example chartthemes + \title Chart themes example + \ingroup qtcharts_examples + + \brief The example shows the look and feel of the different built-in themes. + + This example shows the look and feel of the different built-in themes for all supported chart + types. In order to give the result a more harmonious look, the background palette of the + application is customized to the theme selected. + + \image examples_chartthemes_light.png + \image examples_chartthemes_brown_sand.png + \image examples_chartthemes_blue_cerulean.png +*/ diff --git a/src/charts/doc/src/examples-customchart.qdoc b/src/charts/doc/src/examples-customchart.qdoc new file mode 100644 index 00000000..4d1cee42 --- /dev/null +++ b/src/charts/doc/src/examples-customchart.qdoc @@ -0,0 +1,26 @@ +/*! + \example customchart + \title Custom Chart Example + \ingroup qtcharts_examples + + \brief This example shows how to customize the appearance of the different elements on a chart. + \image examples_customchart.png + + We begin by creating a simple line series and a chart object. + \snippet customchart/main.cpp 1 + + First we customize the series and the chart's title and background. + \snippet customchart/main.cpp 2 + + Then we customize the axes. + \snippet customchart/main.cpp 3 + + Then the axis label values and ranges. Once the axes are ready, we set them to be used by the chart. + \snippet customchart/main.cpp 4 + + Finally, we create a view containing the chart. + \snippet customchart/main.cpp 5 + + Now we are ready to show the chart on a main window. + \snippet customchart/main.cpp 6 +*/ diff --git a/src/charts/doc/src/examples-datetimeaxis.qdoc b/src/charts/doc/src/examples-datetimeaxis.qdoc new file mode 100644 index 00000000..b667af4d --- /dev/null +++ b/src/charts/doc/src/examples-datetimeaxis.qdoc @@ -0,0 +1,38 @@ +/*! + \example datetimeaxis + \title DateTimeAxis Example + \ingroup qtcharts_examples + + \brief The example shows how to use QLineChart with QDateTimeAxis. + + \image examples_datetimeaxis.png + + To create line chart, QLineSeries instance is needed. Let's create one. + + \snippet datetimeaxis/main.cpp 1 + + On the charts we will present how the number of sun spots changes in time. The data (from the Space Weather Prediction Center) is read from a text file. + In the snippet below, notice how the QDateTime::toMSecsSinceEpoch method is used to convert the QDateTime object into a number that can be passed to the QLineSeries append method. + + \snippet datetimeaxis/main.cpp 2 + + To present the data on the chart we need the QChart instance. We add the series to it, hide the legend, create the default axes and set the title of the chart. + + \snippet datetimeaxis/main.cpp 3 + + Since we use QLineSeries, calling createDefaultAxes will create QValueAxis both as X- and Y-axis. To use QDateTimeAxis we need to set it manually to the chart. + First, the instance of QDateTimeAxis is created, then the number of ticks to be shown is set. The number of sun spots is provided as an average for the month. + Therefore we don't need the axis labels to contain the information about the time and the day. This is achieved by setting a custom label format. + Please refer to the QDateTime::toString() method documentation to learn about the available format options. + + \snippet datetimeaxis/main.cpp 4 + + Then we create a QChartView object with QChart as a parameter. This way we don't need to create the QGraphicsView scene ourselves. We also set the Antialiasing on to have the rendered lines look nicer. + + \snippet datetimeaxis/main.cpp 5 + + The chart is ready to be shown. + + \snippet datetimeaxis/main.cpp 6 + +*/ diff --git a/src/charts/doc/src/examples-donutbreakdown.qdoc b/src/charts/doc/src/examples-donutbreakdown.qdoc new file mode 100644 index 00000000..5586a81c --- /dev/null +++ b/src/charts/doc/src/examples-donutbreakdown.qdoc @@ -0,0 +1,45 @@ +/*! + \example donutbreakdown + \title Donut chart breakdown example + \ingroup qtcharts_examples + + \brief This example shows how to use create a donut breakdown chart using QPieSeries API. + \image examples_donutbreakdown.png + + Let's start by defining some data for the chart. + + \snippet donutbreakdown/main.cpp 1 + + Then we create a chart where we add the data. Note that this is our own chart derived from QChart. + + \snippet donutbreakdown/main.cpp 2 + + Our own chart works in such a way that we create a main series in the constructor we create a main series, + which aggregates the data provided by the breakdown series. This is the piechart in the center. + + \snippet donutbreakdown/donutbreakdownchart.cpp 1 + + When a breakdown series is added the data is used to create a slice in the main series and the + breakdown series itself is used to create a segment of a donut positioned so that it is aligned + with the corresponding slice in the main series. + + \snippet donutbreakdown/donutbreakdownchart.cpp 2 + + Here's how the start and end angles for the donut segments are calculated. + + \snippet donutbreakdown/donutbreakdownchart.cpp 3 + + The legend markers are customized to show the breakdown percentage. The markers for the main level slices are hidden. + + \snippet donutbreakdown/donutbreakdownchart.cpp 4 + + Instead the main level slices show the percentage on the label. + + \snippet donutbreakdown/mainslice.cpp 1 + \snippet donutbreakdown/mainslice.cpp 2 + + Now that we have our chart defined, we can finally create a QChartView and show the chart. + + \snippet donutbreakdown/main.cpp 3 + +*/ diff --git a/src/charts/doc/src/examples-donutchart.qdoc b/src/charts/doc/src/examples-donutchart.qdoc new file mode 100644 index 00000000..4aa0d8b8 --- /dev/null +++ b/src/charts/doc/src/examples-donutchart.qdoc @@ -0,0 +1,9 @@ +/*! + \example donutchart + \title Donutchart Example + \ingroup qtcharts_examples + + \brief This example shows how to create a simple donut chart, and do some customizations to + a slice. + \image examples_donutchart.png +*/ diff --git a/src/charts/doc/src/examples-dynamicspline.qdoc b/src/charts/doc/src/examples-dynamicspline.qdoc new file mode 100644 index 00000000..60814a6f --- /dev/null +++ b/src/charts/doc/src/examples-dynamicspline.qdoc @@ -0,0 +1,10 @@ +/*! + \example dynamicspline + \title Dynamic spline example + \ingroup qtcharts_examples + + \brief This example shows how to draw dynamic data. + + \image examples_dynamicspline1.png + \image examples_dynamicspline2.png +*/ diff --git a/src/charts/doc/src/examples-horizontalbarchart.qdoc b/src/charts/doc/src/examples-horizontalbarchart.qdoc new file mode 100644 index 00000000..3ec69192 --- /dev/null +++ b/src/charts/doc/src/examples-horizontalbarchart.qdoc @@ -0,0 +1,50 @@ +/*! + \example horizontalbarchart + \title HorizontalBarChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a horizontal bar chart. + + QHorizontalBarChart shows the data in sets as separate bars, which are grouped in categories. QHorizontalBarChart works just like + QBarChart, except that the bars are drawn horizontally on the chart. + + \image examples_horizontalbarchart.png + + The bar sets are used in the same way in all bar charts. + To illustrate the difference between various bar charts, we use the same data in all examples. + Data that bar chart visualizes, is defined by QBarSet instances. Here we create the sets and append data + to them. The data is appended here with << operator. Alternatively, the append method could also be used. + + \snippet horizontalbarchart/main.cpp 1 + + We create the series and append the bar sets to it. The series takes ownership of the barsets. The series groups the data from sets to categories. + The first values of each set are grouped together in the first category; the second values in the second category, and so on. + + \snippet horizontalbarchart/main.cpp 2 + + Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling + setAnimationOptions(QChart::SeriesAnimations). + + \snippet horizontalbarchart/main.cpp 3 + + To have the categories displayed on axis, we need to create a QBarCategoryAxis. Here we create a category axis with a list of categories and + set it to be the y-axis of the chart. The chart takes ownership of axis. For the x-axis we use the default axis, which is created and scaled to series data + by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be done before we set the category axis. Otherwise the default axis will + override the category axis. + + \snippet horizontalbarchart/main.cpp 4 + + We also want to show the legend. To do so, we get the legend pointer from chart and set it to visible. We also place the legend to the bottom of the chart by setting its alignment + to Qt::AlignBottom. + + \snippet horizontalbarchart/main.cpp 5 + + Finally we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet horizontalbarchart/main.cpp 6 + + The chart is ready to be shown. We set the chart to be the central widget of the window. + We also set the size for the chart window and show it. + + \snippet horizontalbarchart/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-horizontalpercentbarchart.qdoc b/src/charts/doc/src/examples-horizontalpercentbarchart.qdoc new file mode 100644 index 00000000..f3e79353 --- /dev/null +++ b/src/charts/doc/src/examples-horizontalpercentbarchart.qdoc @@ -0,0 +1,56 @@ +/*! + \example horizontalpercentbarchart + \title HorizontalPercentBarChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple horizontal percent bar chart. + + The horizontal percent bar chart shows the data in a set as a percentage of + all sets per category. + + Creating a horizontal percent bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a + horizontal percent bar chart, we use the QHorizontalPercentBarSeries api instead of QBarSeries. Also, in the + \l {BarChart Example} {bar chart}, we used a nice numbers algorithm to make the y-axis numbering look better. With + the percent bar chart there is no need for that, because the maximum y-axis value is always 100. + + \image examples_horizontalpercentbarchart.png + + The barsets are used in same way in all barcharts. + To illustrate the difference between various barcharts, we use same data in examples. + The data which the bar chart visualizes is defined by QBarSet instances. Here we create the sets and append data + to them. The data is appended here with << operator. Alternatively the append method could be used. + + \snippet horizontalpercentbarchart/main.cpp 1 + + We create the series and append the bar sets to it. The series takes ownership of the barsets. The series groups the data from sets to categories. + The first values of each set are grouped together in the first category, the second value in the second category etc. + + \snippet horizontalpercentbarchart/main.cpp 2 + + Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling + setAnimationOptions(QChart::SeriesAnimations) + + \snippet horizontalpercentbarchart/main.cpp 3 + + To have the categories displayed on an axis, we need to create a QBarCategoryAxis first. Here we create a category axis with a list of categories and + set it to be the y-axis of the chart. The chart takes ownership of the axis. For the x-axis we use the default axis, which is created and scaled to series data + by calling createDefaultAxes of the chart. Note that createDefaultAxes must be called before we set the category axis. Otherwise the default axis will + override the category axis. + + \snippet horizontalpercentbarchart/main.cpp 4 + + We also want to show the legend. To do that, we get the legend pointer from the chart + and set it to visible. We also place the legend to bottom of the chart by setting its + alignment to Qt::AlignBottom. + + \snippet horizontalpercentbarchart/main.cpp 5 + + Finally, we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet horizontalpercentbarchart/main.cpp 6 + + The chart is ready to be shown. We set the chart to be the central widget of the window. + We also set the size for the chart window and show it. + + \snippet horizontalpercentbarchart/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-horizontalstackedbarchart.qdoc b/src/charts/doc/src/examples-horizontalstackedbarchart.qdoc new file mode 100644 index 00000000..19e1d1ba --- /dev/null +++ b/src/charts/doc/src/examples-horizontalstackedbarchart.qdoc @@ -0,0 +1,53 @@ +/*! + \example horizontalstackedbarchart + \title HorizontalStackedBarChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple stacked horizontal bar chart. + + The stacked bar chart shows the data in sets as bars that are + stacked on top of each other. The stacking is done per category. + Creating a stacked horizontal bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a + stacked horizontal bar chart, we use the QHorizontalStackedBarSeries api instead of QBarSeries. + + \image examples_horizontalstackedbarchart.png + + The bar sets are used in same way in all bar charts. + To illustrate the difference between various barcharts, we use the same data in all examples. + The data that barchart visualizes, is defined by the QBarSet instances. Here we create the sets and append data + to them. The data is appended here with the << operator. Alternatively, the append method could also be used. + + \snippet horizontalstackedbarchart/main.cpp 1 + + We create the series and append the bar sets to it. The series takes ownership of the bar sets. The series groups the data from sets to categories. + The first values of each set are grouped together in the first category, the second values in the second category and so on. + + \snippet horizontalstackedbarchart/main.cpp 2 + + Here we create the chart object and add the series to it. We set the title for the chart with setTitle, and then turn on the animations of the series by calling + setAnimationOptions(QChart::SeriesAnimations). + + \snippet horizontalstackedbarchart/main.cpp 3 + + To have categories displayed on an axis, we need to create a QBarCategoryAxis. Here we create a category axis with a list of categories and + set it to be the y-axis of the chart. The chart takes ownership of the axis. For the x-axis we use the default axis, which is created and scaled to series data + by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will + override the category axis. + + \snippet horizontalstackedbarchart/main.cpp 4 + + We also want to show the legend. To do that, we get the legend pointer from the chart and + set it to visible. We also place the legend to the bottom of the chart by setting its alignment + to Qt::AlignBottom. + + \snippet horizontalstackedbarchart/main.cpp 5 + + Finally we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet horizontalstackedbarchart/main.cpp 6 + + The chart is ready to be shown. We set the chart to be the central widget of the window. + We also set the size for the chart window and show it. + + \snippet horizontalstackedbarchart/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-legend.qdoc b/src/charts/doc/src/examples-legend.qdoc new file mode 100644 index 00000000..0886058c --- /dev/null +++ b/src/charts/doc/src/examples-legend.qdoc @@ -0,0 +1,40 @@ +/*! + \example legend + \title Legend Example + \ingroup qtcharts_examples + + \brief This example shows how to detach the legend from the chart and how to attach it back. + + By default the chart draws the legend inside the same view with the chart. In some cases the + user may want to draw the legend to somewhere else. To make this possible the legend can be + detached from the chart. Detaching means that the chart doesn't draw the legend or try to + change its layout. Detached legend can then be drawn wherever the user wishes, for example, + in a different graphics scene. The behavior of the legend can be inspected by running the + legend example. + In the example we use the bar series where we add or remove the bar sets. The legend reflects + the changes in series. The legend can be detached or attached back to the chart and its + alignment can be modified. + When the legend is detached, it can be resized and positioned freely. + + \table + \row + \li \inlineimage examples_legend_detach.png + \li \inlineimage examples_legend_detach2.png + \endtable + + Here we turn the legend visible and set its alignment to the bottom of the chart. + + \snippet legend/mainwidget.cpp 1 + + This snippet shows how to detach the legend from the chart. After detaching, we turn its background to visible and set a different color to it. This makes it easier to see how the items inside the legend are arranged in detached mode. + + \snippet legend/mainwidget.cpp 2 + + Here we attach the legend back to the chart. The background is turned invisible. + + \snippet legend/mainwidget.cpp 3 + + This shows how we set the detached legend dimensions. After setting the new values, we call update to show changes on screen. + + \snippet legend/mainwidget.cpp 4 +*/ diff --git a/src/charts/doc/src/examples-legendmarkers.qdoc b/src/charts/doc/src/examples-legendmarkers.qdoc new file mode 100644 index 00000000..35ae5254 --- /dev/null +++ b/src/charts/doc/src/examples-legendmarkers.qdoc @@ -0,0 +1,43 @@ +/*! + \example legendmarkers + \title LegendMarkers Example + \ingroup qtcharts_examples + + \brief The example shows how to make use of legend markers. + + In this example we create an application which uses the QLegendMarker clicked signal to show/hide the corresponding series + in a chart. The connect marker button connects a clicked signal from all markers in a legend to the handleMarkerClicked slot. + + \image examples_legendmarkers.png + + Our application has buttons for adding or removing a series in a chart and a button to connect or disconnect the legend markers clicked signal to our handler. + In the image above we have connected the markers and clicked on one of them. + + \snippet legendmarkers/mainwidget.cpp 1 + + Here we connect the markers in the legend to our handler. To avoid connecting the same marker more than once, we first disconnect it. + + \snippet legendmarkers/mainwidget.cpp 2 + + Here we disconnect all markers from our handler. + + \snippet legendmarkers/mainwidget.cpp 3 + + In our handler we first cast the sender of the event to the QLegendMarker. + + \snippet legendmarkers/mainwidget.cpp 4 + + Then we check the type of the marker. This is required if we want to access the detailed methods of the marker and cast it to the correct type. + If all we need is the pointer to QAbstractSeries, the casting isn't necessary. In case of a pie or bar series, we may need the pointer to a related QPieSlice or QBarSet. + + \snippet legendmarkers/mainwidget.cpp 5 + + We want to toggle the visibility of the series, when the marker is clicked. To do so, we get the pointer to a related series from the marker and toggle its visibility. + Since the legend marker follows the visibility of the series by default, we also set the marked back to visible. If we don't do so, the marker will be + invisible in the legend and we can't click on it anymore. + + \snippet legendmarkers/mainwidget.cpp 6 + + Instead of making the marker invisible when the series is hidden, we dim the color of the marker. Here we do it by modifying the color of the laberBrush. + +*/ diff --git a/src/charts/doc/src/examples-lineandbarchart.qdoc b/src/charts/doc/src/examples-lineandbarchart.qdoc new file mode 100644 index 00000000..d3f69e76 --- /dev/null +++ b/src/charts/doc/src/examples-lineandbarchart.qdoc @@ -0,0 +1,48 @@ +/*! + \example lineandbar + \title Line and BarChart Example + \ingroup qtcharts_examples + + \brief The example shows how to combine different charts and set the axes. + + In the example we combine a linechart with + a barchart and use the category axis as a common axis for both. + + \image examples_lineandbar.png + + Here we create data for our bar series. + + \snippet lineandbar/main.cpp 1 + + We create a bar series and append sets to it. + The first values of each set are grouped together in the first category, the second values in the second category and so on. + + \snippet lineandbar/main.cpp 2 + + Then we create a line series and add data to it. To make the data match with the barchart, we use the index as an x-value for our line series, so that + first point is at (0,value) second at (1,value) and so on. + + \snippet lineandbar/main.cpp 8 + + Here we create the chart and add both series to it. + + \snippet lineandbar/main.cpp 3 + + To make the chart show the series properly, we have to create custom axes for the series. If we don't create custom axes, then each series will get scaled to + use the maximum area of the chart (like in single series case) and the result will be incorrect. With custom axes we set the range of both series to follow the + same axis. For the x-axis we use the QBarCategoryAxis and for the y-axis we use QValuesAxis. + + \snippet lineandbar/main.cpp 4 + + And we also want to show the legend. + + \snippet lineandbar/main.cpp 5 + + Finally we add the chart onto a view. + + \snippet lineandbar/main.cpp 6 + + Now it is ready to be shown in a window. + + \snippet lineandbar/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-linechart.qdoc b/src/charts/doc/src/examples-linechart.qdoc new file mode 100644 index 00000000..d425788a --- /dev/null +++ b/src/charts/doc/src/examples-linechart.qdoc @@ -0,0 +1,30 @@ +/*! + \example linechart + \title LineChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple line chart. + + \image examples_linechart.png + + To create a line chart, a QLineSeries instance is needed. Let's create one. + + \snippet linechart/main.cpp 1 + + Then we add data to the series. We can use the append() member function or use the stream operator. + + \snippet linechart/main.cpp 2 + + To present the data on the chart we need a QChart instance. We add the series to it, create the default axes, and set the title of the chart. + + \snippet linechart/main.cpp 3 + + Then we create a QChartView object with QChart as a parameter. This way we don't need to create a QGraphicsView scene ourselves. We also set the Antialiasing on to have the rendered lines look nicer. + + \snippet linechart/main.cpp 4 + + The chart is ready to be shown. + + \snippet linechart/main.cpp 5 + +*/ diff --git a/src/charts/doc/src/examples-logvalueaxis.qdoc b/src/charts/doc/src/examples-logvalueaxis.qdoc new file mode 100644 index 00000000..f37db92e --- /dev/null +++ b/src/charts/doc/src/examples-logvalueaxis.qdoc @@ -0,0 +1,30 @@ +/*! + \example logvalueaxis + \title Logarithmic Axis Example + \ingroup qtcharts_examples + + \brief The example shows how to use QLogValueAxis. + + \image examples_logvalueaxis.png + + Create a QLineSeries instance and add some data to it. + + \snippet logvalueaxis/main.cpp 1 + + To present the data on the chart we need a QChart instance. Add the series to it, hide the legend and set the title of the chart. + + \snippet logvalueaxis/main.cpp 2 + + Create the axes. Add them to the chart and attach to the series. + + \snippet logvalueaxis/main.cpp 3 + + Then create a QChartView object with QChart as a parameter. Enable antialiasing to have the rendered line look nicer. + + \snippet logvalueaxis/main.cpp 4 + + The chart is ready to be shown. + + \snippet logvalueaxis/main.cpp 5 + +*/ diff --git a/src/charts/doc/src/examples-modeldata.qdoc b/src/charts/doc/src/examples-modeldata.qdoc new file mode 100644 index 00000000..507aa4cb --- /dev/null +++ b/src/charts/doc/src/examples-modeldata.qdoc @@ -0,0 +1,59 @@ +/*! + \example modeldata + \title Model Data Example + \ingroup qtcharts_examples + + \brief This example shows how to use the QAbstractItemModel derived model as the data for the + series. + + \image examples_modeldata.png + + Let's start by creating an instance of the CustomTableModel class. + The CustomTableModel class is derived from QAbstractTableModel and it was created for the purpose of this example. + The constructor of this class populates the internal data store of the model with the data that is suitable for our chart example. + + \snippet modeldata/tablewidget.cpp 1 + + We now have a model with data that we would like to display both on the chart and in a QTableView. + First, we create QTableView and tell it to use the model as a data source. To make the data cells fill the table view we also change headers resize mode. + + \snippet modeldata/tablewidget.cpp 2 + + Now we need the QChart instance to display the same data on the chart. + We also enable animations. It makes it easier to see how modifying the model's data affect the chart. + + \snippet modeldata/tablewidget.cpp 3 + + The code below creates new line series and gives it a name. The following line creates an instance of QVXYModelMapper class. + The next two lines specify that X-coordinates are taken from the model's column(Qt::Vertical) with index 0. The Y-coordinates are taken from the model's column with index 1. + To create a connection between the series and the model we set both of those objects to QVXYModelMapper. + + Finally, the series is added to the chart. + + \snippet modeldata/tablewidget.cpp 4 + + To show in QTableView which data corresponds with which series this example uses table coloring. + When a series is added to the chart it is assigned a color based on the currently selected theme. + The code below extracts that color from the series and uses it to create a colored QTableView. + The coloring of the view is not a part of the QChart functionality. + + \snippet modeldata/tablewidget.cpp 5 + + The same operations are done with a second series. Notice that for this series different columns of the same model are mapped. + + \snippet modeldata/tablewidget.cpp 6 + + \snippet modeldata/tablewidget.cpp 7 + + To avoid setting up the QGraphicsScene we use the QChartView class that does it for us. + QChart object pointer is used as a parameter of the QChartView constructor. + To make the chart look nicer, Antialiasing is turned on and the minimum size of the chartView widget is set. + + \snippet modeldata/tablewidget.cpp 8 + + Finally we place both widgets in a layout and use the layout as the application layout. + + \snippet modeldata/tablewidget.cpp 9 + + The application is ready. Try modifying the data in the table view and see how it affects the chart. +*/ diff --git a/src/charts/doc/src/examples-multiaxis.qdoc b/src/charts/doc/src/examples-multiaxis.qdoc new file mode 100644 index 00000000..4d82e2f5 --- /dev/null +++ b/src/charts/doc/src/examples-multiaxis.qdoc @@ -0,0 +1,37 @@ +/*! + \example multiaxis + \title Multiple Axes Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple chart with two vertical axes. One for each + series. + + \image examples_multiaxis.png + + Create the QChart instance, hide the legend of the chart, and set its title. + + \snippet multiaxis/main.cpp 1 + + Create a QValueAxis instance that will be used as a horizontal axis by both series and add it the bottom of the chart. + The axis can be shared between many series, but each series can have only one vertical and horizontal axis. + + \snippet multiaxis/main.cpp 2 + + Create the first series, and add the data to it. Finally, add the series to the chart. Instantiate its own Y-axis, add it to the chart. Then attach both the common X-axis and the series specific Y-axis. + In this example the color of the axis line is set to be the same as the color of the series to make it possible to distinguish which axis is attached to which series. + + \snippet multiaxis/main.cpp 3 + + Similarly prepare another series. This time a different axis type is used. Additionally grid lines color is also set to be the same as the color of the series. + + \snippet multiaxis/main.cpp 4 + + Create a QChartView object with QChart as a parameter. Enable Antialiasing to have the rendered splines look nicer. + + \snippet multiaxis/main.cpp 5 + + The chart is ready to be shown. + + \snippet multiaxis/main.cpp 6 + +*/ diff --git a/src/charts/doc/src/examples-nesteddonuts.qdoc b/src/charts/doc/src/examples-nesteddonuts.qdoc new file mode 100644 index 00000000..697a59b4 --- /dev/null +++ b/src/charts/doc/src/examples-nesteddonuts.qdoc @@ -0,0 +1,50 @@ +/*! + \example nesteddonuts + \title Nested donuts example + \ingroup qtcharts_examples + + \brief This example shows how to create a nested donuts chart using the QPieSeries API. + \image examples_nesteddonuts.png + + Let's start by creating a QChartView instance and enabling the Antialiasing on it. A QChart object is then obtained from the QChartView instance. + The legend is disabled and the title of the chart is set. Last line enables the animations of the chart. + + \snippet nesteddonuts/widget.cpp 1 + + Three variables are defined that will be used to define the donut chart. Min and max size define the relative size of the whole donut. + minSize is the relative inner size of the smallest donut. maxSize is the relative outer size of the biggest donut. + + \snippet nesteddonuts/widget.cpp 2 + + The following block of code defines the individual donuts and their slices. First a new QPieSeries object is created. + The number of slices in each donut is randomized. + The internal for loop creates the slices with a random value and label same as the value. + Next the label of the slice is set to be visible and its color is set to white. + To make the example more interesting the hovered signal of the slice is connected to widget's slot, of which the inner workings are explained later. + Finally the slice is added to the donut. The donut's size is adjusted to achieve the nesting of the donuts. + Then the donut is added to the widget's list of donuts and to the chart. + + \snippet nesteddonuts/widget.cpp 3 + + Finally the widget is placed in a layout used by the application. + + \snippet nesteddonuts/widget.cpp 4 + + To make the example more interesting the donuts are rotated randomly every 1.25 sec. + + \snippet nesteddonuts/widget.cpp 5 + + The widget's updatedRotation slot is defined below. + It goes through all of the donuts and modifies their current rotation by a random value. + + \snippet nesteddonuts/widget.cpp 6 + + The earlier mentioned explodeSlice slot code is provided below. + If the slice is set to exploded, then stop the timer that controls the donuts rotation. + Then the slice's start and end angles are obtained from the slice. + To highlight the selected slice all the other donuts that lie outward from the one that contains the selected slice + have their start and end angles modified so that they wouldn't "block" the way for the hightlighted slice. + If the slice is no longer selected return to the original state. + + \snippet nesteddonuts/widget.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-percentbarchart.qdoc b/src/charts/doc/src/examples-percentbarchart.qdoc new file mode 100644 index 00000000..d1316e80 --- /dev/null +++ b/src/charts/doc/src/examples-percentbarchart.qdoc @@ -0,0 +1,55 @@ +/*! + \example percentbarchart + \title PercentBarChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple percent bar chart. + + A percent bar chart shows the data in sets as a percentage of + all sets per category. + + Creating percent bar charts is just like creating a regular \l {BarChart Example} {bar chart}, except that for a + percent bar charts, we use the QPercentBarSeries api instead of QBarSeries. Also, in the + \l {BarChart Example} {bar chart} we used the nice numbers algorithm to make the y-axis numbering look better. With + the percent bar chart there is no need for that, because the maximum y-axis value is always 100. + + \image examples_percentbarchart.png + + The barsets are used in same way in all barcharts. + To illustrate the difference between various barcharts, we use the same data in all examples. + The data visualized by the bar chart is defined by QBarSet instances. Here we create the sets and append data + to them. The data is appended here with the << operator. Alternatively the append method could be used. + + \snippet percentbarchart/main.cpp 1 + + We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories. + The first values of each set are grouped together in the first category, the second values in the second category etc. + + \snippet percentbarchart/main.cpp 2 + + Here we create the chart object and add the series to it. We set the title of the chart with setTitle, and then turn on animations of the series by calling + setAnimationOptions(QChart::SeriesAnimations) + + \snippet percentbarchart/main.cpp 3 + + To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with a list of categories and + set it to be the x-axis of the chart. The chart takes ownership of the axis. For the y-axis we use the default axis, which is created and scaled + to series data by calling createDefaultAxes of the chart. Note that createDefaultAxes must be called before we set the category axis. + Otherwise the default axis will override the category axis. + + \snippet percentbarchart/main.cpp 4 + + We also want to show the legend. To do so, we get the legend pointer from the chart and set it to visible. We also place the legend to bottom of + the chart by setting its alignment to Qt::AlignBottom. + + \snippet percentbarchart/main.cpp 5 + + Finally we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet percentbarchart/main.cpp 6 + + The chart is ready to be shown. We set the chart to be central widget of the window. + We also set the size for the chart window and show it. + + \snippet percentbarchart/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-piechart.qdoc b/src/charts/doc/src/examples-piechart.qdoc new file mode 100644 index 00000000..1ae2b3ea --- /dev/null +++ b/src/charts/doc/src/examples-piechart.qdoc @@ -0,0 +1,9 @@ +/*! + \example piechart + \title Piechart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple pie chart and do some customizations to + a pie slice. + \image examples_piechart.png +*/ diff --git a/src/charts/doc/src/examples-piechartcustomization.qdoc b/src/charts/doc/src/examples-piechartcustomization.qdoc new file mode 100644 index 00000000..8a6915c3 --- /dev/null +++ b/src/charts/doc/src/examples-piechartcustomization.qdoc @@ -0,0 +1,8 @@ +/*! + \example piechartcustomization + \title Pie chart customization example + \ingroup qtcharts_examples + + \brief This example shows how the look and feel of a pie chart can be customized. + \image piechart_customization.png +*/ diff --git a/src/charts/doc/src/examples-piechartdrilldown.qdoc b/src/charts/doc/src/examples-piechartdrilldown.qdoc new file mode 100644 index 00000000..f53d9745 --- /dev/null +++ b/src/charts/doc/src/examples-piechartdrilldown.qdoc @@ -0,0 +1,9 @@ +/*! + \example piechartdrilldown + \title Piechart Drilldown Example + \ingroup qtcharts_examples + + \brief The example shows how to implement a piechart with drilldown effect. + \image examples_piechartdrill1.png + \image examples_piechartdrill2.png +*/ diff --git a/src/charts/doc/src/examples-polarchart.qdoc b/src/charts/doc/src/examples-polarchart.qdoc new file mode 100644 index 00000000..9d27aafa --- /dev/null +++ b/src/charts/doc/src/examples-polarchart.qdoc @@ -0,0 +1,34 @@ +/*! + \example polarchart + \title Polar Chart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple polar chart with multiple different series. + + It also shows how to implement scrolling and zooming of the polar chart as well as + visually demonstrate how polar charts and cartesian charts relate to each other. + + \image examples_polarchart.png + + Creating a polar chart is done with a QPolarChart instance instead of a QChart instance. + + \snippet polarchart/main.cpp 1 + + Axes are created similarly to cartesian charts, but when axes are added to the chart, + you can use polar orientations instead of alignments. + + \snippet polarchart/main.cpp 2 + + Zooming and scrolling of a polar chart is logically nearly identical to zooming and scrolling of a cartesian chart. + The main difference is that when scrolling along the X-axis (angular axis), the angle is used instead of the number of pixels. + Another difference is that zooming to a rectangle cannot be done. + + \snippet polarchart/chartview.cpp 1 + + The same axes and series can be used in both cartesian and polar charts, though not simultaneously. + To switch between chart types, you first need to remove the series and axes from the old chart, and then add + them to the new chart. If you want to preserve the axis ranges, those need to be copied, too. + + \snippet polarchart/chartview.cpp 2 + +*/ diff --git a/src/charts/doc/src/examples-qmlaxes.qdoc b/src/charts/doc/src/examples-qmlaxes.qdoc new file mode 100644 index 00000000..88ab61fc --- /dev/null +++ b/src/charts/doc/src/examples-qmlaxes.qdoc @@ -0,0 +1,32 @@ +/*! + \example qmlaxes + \title Qml Axes + \ingroup qtcharts_examples + + \brief This is a demonstration of how to use axes in your QML application. + + \table + \row + \li \br + We begin with a chart that has a line series and a scatter series with random + data. Both series use the same axes. + \br + \br + \snippet qmlaxes/qml/qmlaxes/View1.qml 1 + \li \inlineimage examples_qmlaxes1.png + \row + \li \br + The next example shows a chart with some accurate historical data that makes us to use a DateTimeAxis. + \br + \br + \snippet qmlaxes/qml/qmlaxes/View2.qml 1 + \li \inlineimage examples_qmlaxes2.png + \row + \li \br + And the final example with a chart that uses a CategoryAxis to make the data easier to understand. + \br + \br + \snippet qmlaxes/qml/qmlaxes/View3.qml 1 + \li \inlineimage examples_qmlaxes3.png + \endtable +*/ diff --git a/src/charts/doc/src/examples-qmlchart.qdoc b/src/charts/doc/src/examples-qmlchart.qdoc new file mode 100644 index 00000000..8696461c --- /dev/null +++ b/src/charts/doc/src/examples-qmlchart.qdoc @@ -0,0 +1,125 @@ +/*! + \example qmlchart + \title Qml charts example + \ingroup qtcharts_examples + + \brief This basic demonstration shows how to use the different chart types by using qml. + + Creating each chart type begins with the creation of a ChartView. + + \table + \row + \li \br + To create a pie, we use the PieSeries API together with a few PieSlices: + \br + \br + \snippet qmlchart/qml/qmlchart/View1.qml 1 + \li \inlineimage examples_qmlchart1.png + \endtable + + \table + \row + \li \br + To create a chart with a line series: + \br + \br + \snippet qmlchart/qml/qmlchart/View2.qml 1 + \li \inlineimage examples_qmlchart2.png + \endtable + + \table + \row + \li \br + And spline series: + \br + \br + \snippet qmlchart/qml/qmlchart/View3.qml 1 + \li \inlineimage examples_qmlchart3.png + \endtable + + \table + \row + \li \br + Then we create a chart that illustrates the NHL All-Star player selections by using + three area series: + \br + \br + \snippet qmlchart/qml/qmlchart/View4.qml 1 + \dots + \li \inlineimage examples_qmlchart4.png + \endtable + + \table + \row + \li \br + Then a couple of scatter series: + \br + \br + \snippet qmlchart/qml/qmlchart/View5.qml 1 + \dots + \li \inlineimage examples_qmlchart5.png + \endtable + + And a few different bar series: + \table + \row + \li \br + \br + \br + \snippet qmlchart/qml/qmlchart/View6.qml 1 + \li \inlineimage examples_qmlchart6.png + \endtable + \table + \row + \li \br + \br + \br + \snippet qmlchart/qml/qmlchart/View7.qml 1 + \li \inlineimage examples_qmlchart7.png + \endtable + \table + \row + \li \br + \br + \br + \snippet qmlchart/qml/qmlchart/View8.qml 1 + \li \inlineimage examples_qmlchart8.png + \endtable + \table + \row + \li \br + \br + \br + \snippet qmlchart/qml/qmlchart/View9.qml 1 + \li \inlineimage examples_qmlchart9.png + \endtable + \table + \row + \li \br + \br + \br + \snippet qmlchart/qml/qmlchart/View10.qml 1 + \li \inlineimage examples_qmlchart10.png + \endtable + \table + \row + \li \br + \br + \br + \snippet qmlchart/qml/qmlchart/View11.qml 1 + \li \inlineimage examples_qmlchart11.png + \endtable + + \table + \row + \li \br + And finally an example demonstrating how to create a donut chart with two pie + series: + \br + \br + \snippet qmlchart/qml/qmlchart/View12.qml 1 + \li \inlineimage examples_qmlchart12.png + \endtable + + Additionally, antialiasing is set with the qml property in Qt Quick 2. +*/ diff --git a/src/charts/doc/src/examples-qmlcustomizations.qdoc b/src/charts/doc/src/examples-qmlcustomizations.qdoc new file mode 100644 index 00000000..3d09009d --- /dev/null +++ b/src/charts/doc/src/examples-qmlcustomizations.qdoc @@ -0,0 +1,28 @@ +/*! + \example qmlcustomizations + \title Qml Customizations + \ingroup qtcharts_examples + + \image examples_qmlcustomizations.png + + \brief This application shows you how to customize different visual properties of a ChartView + and series. + + This example shows a wheel of fortune by customizing a pie series. + + First we create the ChartView and a couple of series. + \snippet qmlcustomizations/qml/qmlcustomizations/main.qml 1 + + The application data is generated in Component.onCompleted of the main rectangle: + \snippet qmlcustomizations/qml/qmlcustomizations/main.qml 2 + + The following customizations are done repeatedly with a timer. To highlight one of the pie + slices at time we modify its exploded property: + \snippet qmlcustomizations/qml/qmlcustomizations/main.qml 3 + + Then an animation using a scatter series with one data point: + \snippet qmlcustomizations/qml/qmlcustomizations/main.qml 4 + + When the wheel of fortune has stopped, we make the active slice blink by modifying its colors. + \snippet qmlcustomizations/qml/qmlcustomizations/main.qml 5 +*/ diff --git a/src/charts/doc/src/examples-qmlcustomlegend.qdoc b/src/charts/doc/src/examples-qmlcustomlegend.qdoc new file mode 100644 index 00000000..b8f307ef --- /dev/null +++ b/src/charts/doc/src/examples-qmlcustomlegend.qdoc @@ -0,0 +1,43 @@ +/*! + \example qmlcustomlegend + \title Qml Custom Legend + \ingroup qtcharts_examples + + \brief This example shows you how to create your own custom legend. + + This application shows you how to create your own custom legend instead of using the + built-in legend of ChartView API. + + \table + \row + \li \br + The main view of the application shows a stacked area chart. This is how one of + \br + the stacked areas is created. See ChartViewStacked.qml and AnimatedAreaSeries.qml. + \br + \br + \snippet qmlcustomlegend/qml/qmlcustomlegend/ChartViewStacked.qml 1 + \li \inlineimage examples_qmlcustomlegend1.png + \row + \li \br + Hovering with mouse on top of the legend will highlight the hovered series. + \br + (see CustomLegend.qml). + \br + \br + \snippet qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 1 + \snippet qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 2 + \dots + \snippet qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 3 + \li \inlineimage examples_qmlcustomlegend2.png + \row + \li \br + You can also select one of the stacked areas for a closer look as a line series by + \br + a mouse click (see ChartViewHighlighted.qml). + \br + \br + \snippet qmlcustomlegend/qml/qmlcustomlegend/ChartViewHighlighted.qml 1 + \li \inlineimage examples_qmlcustomlegend3.png + \endtable +*/ diff --git a/src/charts/doc/src/examples-qmlf1legends.qdoc b/src/charts/doc/src/examples-qmlf1legends.qdoc new file mode 100644 index 00000000..da7a73b2 --- /dev/null +++ b/src/charts/doc/src/examples-qmlf1legends.qdoc @@ -0,0 +1,23 @@ +/*! + \example qmlf1legends + \title Qml F1 Legends + \ingroup qtcharts_examples + + \image examples_qmlf1legends.png + + \brief This application demonstrates how to use XmlListModel as a datasource for a Chart. + + Let's define an empty ChartView first: + \snippet qmlf1legends/qml/qmlf1legends/main.qml 1 + + Our XmlListModel uses hard-coded test data. In a real application the data source would be a + timing system. + \snippet qmlf1legends/qml/qmlf1legends/SpeedsXml.qml 1 + \dots + \snippet qmlf1legends/qml/qmlf1legends/SpeedsXml.qml 2 + \snippet qmlf1legends/qml/qmlf1legends/main.qml 2 + + The data is parsed with a timer. The line series representing each driver are created on the + fly. + \snippet qmlf1legends/qml/qmlf1legends/main.qml 3 +*/ diff --git a/src/charts/doc/src/examples-qmloscilloscope.qdoc b/src/charts/doc/src/examples-qmloscilloscope.qdoc new file mode 100644 index 00000000..eb6c5f43 --- /dev/null +++ b/src/charts/doc/src/examples-qmloscilloscope.qdoc @@ -0,0 +1,47 @@ +/*! + \example qmloscilloscope + \title QML Oscilloscope + \ingroup qtcharts_examples + + \image examples_qmloscilloscope.png + + \brief The example shows how to implement application with strict performance requirements + using the Qt Charts QML API. + + The oscilloscope application demonstrates how to use the Qt Charts QML API to implement an + application with strict performance requirements. The application uses generated data with + configurable characteristics to mimic a simple oscilloscope user interface. To find out the + actual screen refresh performance of the application, you can set QML_SHOW_FRAMERATE = 1 to + your run environment settings to get the framerate shown in the application output console. + To do so go to Projects - Run - Run environment in Qt Creator and select Add. Then you can + experiment with the different configurable options of the example application to find the + configuration that gives you the best performance in your environment. + + Note: You can try if enabling OpenGL improves the performance with the following startup + parameter: + \code + -graphicssystem opengl + \endcode + + The application window is shared by control and scope views: + \snippet qmloscilloscope/qml/qmloscilloscope/main.qml 1 + \dots + \snippet qmloscilloscope/qml/qmloscilloscope/main.qml 2 + + ControlView implements the buttons used for configuring. ScopeView uses a ChartView to show + a chart with two line series: + \snippet qmloscilloscope/qml/qmloscilloscope/ScopeView.qml 1 + \dots + + The data of the line series is updated with a QML timer. In a real life application the + updating could be triggered with a signal from Qt C++ code. + \snippet qmloscilloscope/qml/qmloscilloscope/ScopeView.qml 2 + + The oscilloscope also allows you to switch the type of the series used for visualizing the + signal sources. This is implemented by dynamically destroying and creating series: + \snippet qmloscilloscope/qml/qmloscilloscope/ScopeView.qml 3 + + \note QML_SHOW_FRAMERATE environment variable doesn't work with Qt Quick 2. + From Qt 5.1.0 on, the QSG_RENDER_TIMING environment variable can be used + similarly to display rendering time. +*/ diff --git a/src/charts/doc/src/examples-qmlpolarchart.qdoc b/src/charts/doc/src/examples-qmlpolarchart.qdoc new file mode 100644 index 00000000..59115cd1 --- /dev/null +++ b/src/charts/doc/src/examples-qmlpolarchart.qdoc @@ -0,0 +1,35 @@ +/*! + \example qmlpolarchart + \title Qml Polar Chart + \ingroup qtcharts_examples + + \brief This is a demonstration on how to use a polar chart in your QML application. + + \table + \row + \li \br + We begin with a chart that has a spline series and a scatter series with random + data. Both series use the same axes. + \br + \br + \snippet qmlpolarchart/qml/qmlpolarchart/View1.qml 1 + \li \inlineimage examples_qmlpolarchart1.png + \row + \li \br + The next example shows a chart with some accurate historical data for which we need + to use a DateTimeAxis + and a AreaSeries. + \br + \br + \snippet qmlpolarchart/qml/qmlpolarchart/View2.qml 1 + \li \inlineimage examples_qmlpolarchart2.png + \row + \li \br + And the final example with a chart that uses a CategoryAxis to make the data easier + to understand. + \br + \br + \snippet qmlpolarchart/qml/qmlpolarchart/View3.qml 1 + \li \inlineimage examples_qmlpolarchart3.png + \endtable +*/ diff --git a/src/charts/doc/src/examples-qmlweather.qdoc b/src/charts/doc/src/examples-qmlweather.qdoc new file mode 100644 index 00000000..87e9010b --- /dev/null +++ b/src/charts/doc/src/examples-qmlweather.qdoc @@ -0,0 +1,34 @@ +/*! + \example qmlweather + \title Qml Weather + \ingroup qtcharts_examples + + \image examples_qmlweather.png + + \brief This is a basic demonstration showing how to use the different chart types by using qml. + + By default the application uses static test data to mimic a weather forecast. You can also + obtain an application id from http://www.worldweatheronline.com/ to get access to weather API + provided by World Weather Online. You can then give your application id as a parameter to the + Qml Weather executable to make it use live data. + + For example: + \code + bin\qmlweather.exe 1234567890abcdef123456 + \endcode + + The example application uses a ChartView and a some series to visualize weather data: + \snippet qmlweather/qml/qmlweather/main.qml 1 + \snippet qmlweather/qml/qmlweather/main.qml 2 + + To get data with weather forecast data, we make an HTTP GET request to World Weather Online. We + request the response in JSON data format. + \snippet qmlweather/qml/qmlweather/main.qml 3 + + The JSON response contains an array of forecast data: + \snippet qmlweather/qml/qmlweather/main.qml 4 + + That is then used as input data for our series and a ListModel we use as a container for weather + icon URLs: + \snippet qmlweather/qml/qmlweather/main.qml 5 +*/ diff --git a/src/charts/doc/src/examples-scatterchart.qdoc b/src/charts/doc/src/examples-scatterchart.qdoc new file mode 100644 index 00000000..66ef518c --- /dev/null +++ b/src/charts/doc/src/examples-scatterchart.qdoc @@ -0,0 +1,39 @@ +/*! + \example scatterchart + \title ScatterChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple scatter chart. + + \image examples_scatterchart.png + + To create scatter charts, a QScatterSeries instance is needed. Here we create a scatter series + instance, and set the type and width of outline for the scatter points. + + \snippet scatterchart/chartview.cpp 1 + + We add the data to be shown. We can use the append() member function or use the stream operator. + + \snippet scatterchart/chartview.cpp 2 + + We can define the brush of the scatter series to be an image. Here the image is a star created + using QPainterPath. + + \snippet scatterchart/chartview.cpp 3 + + In the end we enable anti-aliasing, set the chart title, and add the scatter series onto the + chart. We also disable drop shadow, because it would not look good on an application with only + chart view shown. + + \snippet scatterchart/chartview.cpp 4 + + The image used as a brush for the scatter series may contain several colors. Therefore we need + to set the desired color explicitly by setting the brush for the legend marker items. + + \snippet scatterchart/chartview.cpp 5 + + The chart is ready to be shown. + + \snippet scatterchart/main.cpp 4 + +*/ diff --git a/src/charts/doc/src/examples-scatterinteractions.qdoc b/src/charts/doc/src/examples-scatterinteractions.qdoc new file mode 100644 index 00000000..e616e086 --- /dev/null +++ b/src/charts/doc/src/examples-scatterinteractions.qdoc @@ -0,0 +1,10 @@ +/*! + \example scatterinteractions + \title ScatterInteractions Example + \ingroup qtcharts_examples + + \brief This example shows how to create a simple scatter chart and how to interact with the + chart. + + \image examples_scatterinteractions.png +*/ diff --git a/src/charts/doc/src/examples-splinechart.qdoc b/src/charts/doc/src/examples-splinechart.qdoc new file mode 100644 index 00000000..50c634fc --- /dev/null +++ b/src/charts/doc/src/examples-splinechart.qdoc @@ -0,0 +1,34 @@ +/*! + \example splinechart + \title SplineChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple spline chart. + + \image examples_splinechart.png + + To create spline charts we need to put our data into QSplineSeries. QSplineSeries automatically + calculates spline segment control points that are needed to properly draw the spline. + + \snippet splinechart/main.cpp 1 + + Now let's add some data points to the series. + + \snippet splinechart/main.cpp 2 + + The data series has been populated. To display it on a chart we create a QChart object and add + the data series to it. We also set the title and the values range on the y-axis, so that our + chart's visibility is better. + + \snippet splinechart/main.cpp 3 + + Then we create a QChartView object with QChart as a parameter. This way we don't need to create + a QGraphicsView scene ourselves. We also set the Antialiasing on to have the rendered lines + look nicer. + + \snippet splinechart/main.cpp 4 + + Finally, we set the QChartView as the windows's central widget. + + \snippet splinechart/main.cpp 5 +*/ diff --git a/src/charts/doc/src/examples-stackedbarchart.qdoc b/src/charts/doc/src/examples-stackedbarchart.qdoc new file mode 100644 index 00000000..1e9d8928 --- /dev/null +++ b/src/charts/doc/src/examples-stackedbarchart.qdoc @@ -0,0 +1,53 @@ +/*! + \example stackedbarchart + \title StackedBarChart Example + \ingroup qtcharts_examples + + \brief The example shows how to create a simple stacked bar chart. + + The stacked bar chart shows the data in sets as bars stacked on top of each other. The stacking + is done per category. The example shows how to create a simple stacked bar chart. Stacked bar + chart shows the data in sets as bars that are stacked on top of each other. The stacking is done + per category. Creating a stacked bar chart is just like creating a regular \l {BarChart Example} + {bar chart}, except that for a stacked bar chart, we use the QStackedBarSeries API instead of + QBarSeries. + + \image examples_stackedbarchart.png + + The barsets are used in same way in all barcharts. + To illustrate the difference between various barcharts, we use same data in all examples. + Data, which the barchart visualizes, is defined by the QBarSet instances. Here we create the sets and append data + to them. The data is appended here with << operator. Alternatively the append method could be used. + + \snippet stackedbarchart/main.cpp 1 + + We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories. + The first values of each set are grouped together in the first category, the second values in the second category etc. + + \snippet stackedbarchart/main.cpp 2 + + Here we create the chart object and add the series to it. We set the title for the chart with setTitle, and then turn on animations of the series by calling + setAnimationOptions(QChart::SeriesAnimations). + + \snippet stackedbarchart/main.cpp 3 + + To have categories displayed on the axis, we need to create a QBarCategoryAxis. Here we create a category axis with list of categories and + set it to be the x-axis of the chart. The chart takes ownership of the axis. For the y-axis we use default axis, which is created and scaled to series data + by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will + override the category axis. + + \snippet stackedbarchart/main.cpp 4 + + We also want to show the legend. To do so, we get the legend pointer from the chart and set it to visible. We also place the legend to the bottom of the chart by setting its alignment to Qt::AlignBottom. + + \snippet stackedbarchart/main.cpp 5 + + Finally, we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet stackedbarchart/main.cpp 6 + + The chart is ready to be shown. We set the chart to be the central widget of the window. + We also set the size for the chart window and show it. + + \snippet stackedbarchart/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-stackedbarchartdrilldown.qdoc b/src/charts/doc/src/examples-stackedbarchartdrilldown.qdoc new file mode 100644 index 00000000..0bfe5fd2 --- /dev/null +++ b/src/charts/doc/src/examples-stackedbarchartdrilldown.qdoc @@ -0,0 +1,50 @@ +/*! + \example stackedbarchartdrilldown + \title StackedBarChart Drilldown Example + \ingroup qtcharts_examples + + \brief The example shows how to implement drilldown using a stacked barchart. + + In the drilldown example we create a stacked bar chart, which shows the harvest of various chili + peppers during season. In season view the harvest is grouped by month. To drill down to weekly + view, right-click the selected month. On weekly view, the harvest of the month clicked is shown + by week. + + The season view looks like this: + \image examples_stackedbarchartdrilldown1.png + + Clicking on a month shows that month's harvest: + \image examples_stackedbarchartdrilldown2.png + + First we define a drilldown series class, which adds categories to the stacked bar series and mapping for categories to other drilldown series. + The purpose of the drilldown series is to contain knowledge of the drilldown structure. The mapDrilldownSeries function maps the category to a given series. We can request the mapping for a category with the drilldownSeries(int category) function. + + \snippet stackedbarchartdrilldown/drilldownseries.h 1 + + Next we define our own drilldown chart, which implements the handler for the mouse click. All QBarSeries derived classes send out the clicked(QBarSet*, int) signal when a series is clicked with the mouse. The parameter QBarSet contains the pointer to the clicked bar set and parameter int contains the index of the clicked category. + + \snippet stackedbarchartdrilldown/drilldownchart.h 1 + + Now we have our drilldown classes and we can start using them. + First create the chart. + + \snippet stackedbarchartdrilldown/main.cpp 1 + + We define the categories from which the drilldown series will be constructed. + + \snippet stackedbarchartdrilldown/main.cpp 2 + + To create the drilldown structure, we first create our top level series, which we call seasonSeries. For each month in seasonSeries we create a drilldown series called weeklySeries which contains more detailed data for that month. + In weeklySeries, we use the drilldown handler to bring us back to seasonSeries. To do so we add mapping to the series. The seasonSeries is mapped to weeklySeries for each month. Every weeklySeries is mapped back to the seasonSeries. + To make mapping work, we connect the clicked signals from our series to the drilldownChart. + + \snippet stackedbarchartdrilldown/main.cpp 3 + + When we have our drilldown structure ready, we can add the data to it. Here we generate a random crop for each plant in each week. The monthly crop is calculated from weekly crops and is set as value to the monthly series. + + \snippet stackedbarchartdrilldown/main.cpp 4 + + Here we set the chart to show the top level series initially. + + \snippet stackedbarchartdrilldown/main.cpp 5 +*/ diff --git a/src/charts/doc/src/examples-temperaturerecords.qdoc b/src/charts/doc/src/examples-temperaturerecords.qdoc new file mode 100644 index 00000000..ce1c5998 --- /dev/null +++ b/src/charts/doc/src/examples-temperaturerecords.qdoc @@ -0,0 +1,46 @@ +/*! + \example temperaturerecords + \title Temperature records example + \ingroup qtcharts_examples + + \brief The example shows how to create a bar chart with negative bars. + + For our example we use temperature data. + + \image examples_temperaturerecords.png + + First we create two barsets and append the data to them. One set represents the minimum temperatures and another the maximum temperatures. + + \snippet temperaturerecords/main.cpp 1 + + We create the series and append the barsets to it. The series takes ownership of the barsets. + + \snippet temperaturerecords/main.cpp 2 + + Here we create the chart object and add the series to it. We set the title for the chart with setTitle, and then turn on animations of the series by calling + setAnimationOptions(QChart::SeriesAnimations) + + \snippet temperaturerecords/main.cpp 3 + + To have categories displayed on an axis, we need to create a QBarCategoryAxis. Here we create a category axis with a list of categories and + set it to be the x-axis of the chart. The chart takes ownership of the axis. For y-axis we use the default axis, which is created and scaled to the series data + by calling createDefaultAxes of the chart. We change the range for the y-axis, since this gives nicer result than with autoscaling. + + Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will override the category axis. + + \snippet temperaturerecords/main.cpp 4 + + We also want to show the legend. To do so, we get the legend pointer from the chart and set it to visible. We also place the legend to the bottom + of the chart by setting its alignment to Qt::AlignBottom. + + \snippet temperaturerecords/main.cpp 5 + + Finally we add the chart onto a view. We also turn on the antialiasing for the chartView. + + \snippet temperaturerecords/main.cpp 6 + + Chart is ready to be shown. We set the chart to be the central widget of the window. + We also set the size for the chart window and show it. + + \snippet temperaturerecords/main.cpp 7 +*/ diff --git a/src/charts/doc/src/examples-zoomlinechart.qdoc b/src/charts/doc/src/examples-zoomlinechart.qdoc new file mode 100644 index 00000000..f0ec866a --- /dev/null +++ b/src/charts/doc/src/examples-zoomlinechart.qdoc @@ -0,0 +1,33 @@ +/*! + \example zoomlinechart + \title Zoom Line Example + \ingroup qtcharts_examples + + \brief The example shows how to create your own custom zooming effect + + The example shows how to create your own custom zooming effect with QRubberBand by using a mouse + and how to use touch gestures for paning and zooming. + \image examples_zoomlinechart1.png + \image examples_zoomlinechart2.png + + Let's first create a line series with some example data. + \snippet zoomlinechart/main.cpp 1 + + Then we create a custom chart view by deriving from QChartView: + \snippet zoomlinechart/chartview.h 1 + + We override mouse and key event handling + \snippet zoomlinechart/chartview.h 2 + + Then we implement a custom logic for mouse and key events. For example pressing the '+' key will zoom in and pressing + the '-' key will zoom out. + \snippet zoomlinechart/chartview.cpp 1 + + We also create our own QChart: + \snippet zoomlinechart/chart.h 1 + + Where we can handle the gestures: + \snippet zoomlinechart/chart.cpp 1 + + Note that you will need to call grabGesture() to both QMainWindow and QChart. +*/ diff --git a/src/charts/doc/src/index.qdoc b/src/charts/doc/src/index.qdoc new file mode 100644 index 00000000..15408f24 --- /dev/null +++ b/src/charts/doc/src/index.qdoc @@ -0,0 +1,61 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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 QtCharts module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise 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 +** +****************************************************************************/ + +/*! + \title Qt Charts + \page index.html + \keyword About + + Qt Charts is a part of the Qt Enterprise addons package. It provides a set of easy to use chart + components which are available for Qt customers. It uses the Qt Graphics View + Framework, therefore charts can be easily integrated to modern user interfaces. Qt Charts can + be used as QWidgets, QGraphicsWidget, or QML types. Users can easily create impressive + graphs by selecting one of the charts themes. + + \section1 Getting Started + + To import Qt Charts QML types, add the following import statement to your \c .qml file: + + \snippet doc_src_qmlcharts.cpp 0 + + If you intend to use Qt Charts C++ classes in your application, use the + following include and using directives: + + \snippet doc_src_qtcharts.cpp 0 + + \note If you are only using a few classes from this module, we recommend including only those + specific classes instead of the whole module. + + To link against the Qt Charts module, add this line to your \c qmake project file: + + \snippet doc_src_qtcharts.pro 0 + + See the \l{Qt Charts Getting Started}{Getting started} page for further information on + how to use Qt Charts in your application. + + \section1 References + \list + \li \l{Qt Charts C++ Classes} + \li \l{Qt Charts QML Types} + \endlist + + Qt Charts comes with the following examples: + + \annotatedlist qtcharts_examples + +*/ diff --git a/src/charts/doc/src/qtcharts.qdoc b/src/charts/doc/src/qtcharts.qdoc new file mode 100644 index 00000000..16194833 --- /dev/null +++ b/src/charts/doc/src/qtcharts.qdoc @@ -0,0 +1,200 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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 QtCharts module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise 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 +** +****************************************************************************/ + +/*! + \module Qt Charts + \title Qt Charts C++ Classes + \ingroup modules + + \brief C++ classes for the Qt Charts API. + + Charts API is built on top of Qt Graphics View Framework. Charts can be displayed as QGraphicsWidget using the QChart class. However + there is also the convenience class QChartView, which is QWidget based. These enable us to quickly use Qt Charts as a normal Qt widget. + + Each chart type is represented by the QAbstractSeries derived class. To create charts, the users have to use an instance of the related + series class and add it to a QChart instance. + \code + QLineSeries* series = new QLineSeries(); + series->add(0, 6); + series->add(2, 4); + ... + chartView->chart()->addSeries(series); + chartView->chart()->createDefaultAxes(); + \endcode +*/ + +/*! + \qmlmodule QtCharts 2.0 + \title Qt Charts QML Types + \ingroup qmlmodules + + \brief QML types for the Qt Charts API. + + The Qt Charts QML API is an intuitive and simple way to show charts in your QML + applications. + + \table + \row + \li \br + Use the following QML to create a simple pie chart: + \br + \br + \snippet qmlpiechart/qml/qmlpiechart/main.qml 1 + \snippet qmlpiechart/qml/qmlpiechart/main.qml 2 + \snippet qmlpiechart/qml/qmlpiechart/main.qml 3 + \li \inlineimage examples_qmlpiechart.png + \endtable + + \note Since Qt Creator 3.0 the project created with Qt Quick Application wizard based on + Qt Quick 2 template uses QGuiApplication by default. As Qt Charts utilizes Qt Graphics View + Framework for drawing, QApplication must be used. The project created with the wizard is + usable with Qt Charts after the QGuiApplication is replaced with QApplication. + + \section1 QML Types +*/ + +/*! + \group charts_examples + \ingroup all-examples + \title Qt Charts Examples + + \brief Examples for the Qt Charts. + + For some code examples, see one of the Qt Charts examples: + + \section1 Examples + + \annotatedlist qtcharts_examples +*/ + +/*! + \group qtcharts_getting_started + \title Qt Charts Getting Started + + \section1 Installing the Qt Charts module + + Use the \c {Package Manager} in \c {Maintenance Tool} or the \c {Online installer} to install + the Qt Charts module. The module can be found under \c {Qt Enterprise Add-Ons} in the + package manager. + + After installation Qt Charts documentation and examples are available in Qt Creator. + Examples can be found on the examples page of Qt Creator by selecting the Qt Charts + component from the drop-down menu. + + The source code is installed into the QtCharts folder under EnterpriseAddOns. + + \section1 Building Qt Charts + + To build the Qt Charts module from source code yourself, set up a command prompt with + an environment for building Qt applications, navigate to the directory containing + \c {qtcharts.pro}, and configure the project with qmake: + \code + qmake + \endcode + + After running qmake, build the project with make: + \table + \header + \li OS \li Make command + \row + \li Linux \li make + \row + \li Windows (MinGw) \li mingw32-make + \row + \li Windows (MSVC) \li nmake + \row + \li OSX \li make + \endtable + + The above generates the default makefiles for your configuration, which is typically + the release build if you are using precompiled binary Qt distribution. To build both debug + and release, or one specifically, use one of the following qmake lines instead. + + For debug builds: + \code + qmake CONFIG+=debug + make + \endcode + or + \code + qmake CONFIG+=debug_and_release + make debug + \endcode + + For release builds: + \code + qmake CONFIG+=release + make + \endcode + or + \code + qmake CONFIG+=debug_and_release + make release + \endcode + + For both builds (Windows/OS X only): + \code + qmake CONFIG+="debug_and_release build_all" + make + \endcode + + After building, install the module to your Qt directory: + \code + make install + \endcode + + If you want to uninstall the module: + \code + make uninstall + \endcode + + To build a statically linked version of the Qt Charts module, give the following commands: + + \snippet doc_src_qtcharts.cpp 1 + + \section1 Running examples + + Qt Charts examples are found under the \c examples subdirectory. To build and run a single + example, in this case qmlpolarchart, navigate to the example directory and enter the following + commands: + + \snippet doc_src_qtcharts.cpp 2 + + \note On some platforms, such as Windows, the executable can be generated under debug or + release folders, depending on your build. + + \section1 Creating a simple application + + To create a simple application, start by creating a new Qt Gui Application project in Qt + Creator and add this line to the \c .pro file of the project: + + \snippet doc_src_qtcharts.pro 0 + + In the \c main.cpp file, include the module headers and declare namespace usage: + + \snippet doc_src_qtcharts.cpp 0 + + \note Since Qt Creator 3.0 the project created with Qt Quick Application wizard based on + Qt Quick 2 template uses QGuiApplication by default. As Qt Charts utilizes Qt Graphics View + Framework for drawing, QApplication must be used. The project created with the wizard is + usable with Qt Charts after the QGuiApplication is replaced with QApplication. + + For further code examples, see one of the Qt Charts examples: + + \annotatedlist qtcharts_examples +*/ diff --git a/src/charts/doc/style/offline.css b/src/charts/doc/style/offline.css new file mode 100644 index 00000000..7a728b49 --- /dev/null +++ b/src/charts/doc/style/offline.css @@ -0,0 +1,722 @@ +@media screen +{ + + .qchart + { + width:1000px; + margin-left: auto; + margin-right: auto; + margin-top: 50px; + max-width:100%; + overflow-x: auto; + } + + .qchart img + { + float:left; + } + + .qchart table + { + width:1000px; + margin-top: 50px; + max-width:100%; + } + +/* basic elements */ + html + { + color: #000000; + min-width: 1000px; + background: #FFFFFF; + } + table + { + border-collapse: collapse; + border-spacing: 0; + } + fieldset, img + { + border: 0; + max-width:100%; + } + address, caption, cite, code, dfn, em, strong, th, var, optgroup + { + font-style: inherit; + font-weight: inherit; + } + del, ins + { + text-decoration: none; + } + li + { + list-style: none; + } + ol li + { + list-style: decimal; + } + caption, th + { + text-align: left; + } + h1, h2, h3, h4, h5, h6 + { + font-size: 100%; + } + q:before, q:after + { + content: ''; + } + abbr, acronym + { + border: 0; + font-variant: normal; + } + sup, sub + { + vertical-align: baseline; + } + tt, .qmlreadonly span, .qmldefault span + { + word-spacing:0.5em; + } + legend + { + color: #000000; + } + strong + { + font-weight: bold; + } + em + { + font-style: italic; + } + + body + { + margin-left: 0.5em; + margin-right: 0.5em; + } + a + { + color: #00732F; + text-decoration: none; + } + hr + { + background-color: #E6E6E6; + border: 1px solid #E6E6E6; + height: 1px; + width: 100%; + text-align: left; + margin: 1.5em 0 1.5em 0; + } + + pre + { + border: 1px solid #DDDDDD; + -moz-border-radius: 0.7em 0.7em 0.7em 0.7em; + -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em; + border-radius: 0.7em 0.7em 0.7em 0.7em; + margin: 0 1.5em 1em 1em; + padding: 1em 1em 1em 1em; + overflow-x: auto; + } + table, pre + { + -moz-border-radius: 0.7em 0.7em 0.7em 0.7em; + -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em; + border-radius: 0.7em 0.7em 0.7em 0.7em; + background-color: #F6F6F6; + border: 1px solid #E6E6E6; + border-collapse: separate; + margin-bottom: 2.5em; + } + pre { + font-size: 90%; + display: block; + overflow:hidden; + } + thead + { + margin-top: 0.5em; + font-weight: bold + } + th + { + padding: 0.5em 1.5em 0.5em 1.5em; + background-color: #E1E1E1; + border-left: 1px solid #E6E6E6; + } + td + { + padding: 0.25em 1.5em 0.25em 2em; + } + + td.rightAlign + { + padding: 0.25em 0.5em 0.25em 1em; + } + table tr.odd + { + border-left: 1px solid #E6E6E6; + background-color: #F6F6F6; + color: #66666E; + } + table tr.even + { + border-left: 1px solid #E6E6E6; + background-color: #ffffff; + color: #66666E; + } + + div.float-left + { + float: left; margin-right: 2em + } + div.float-right + { + float: right; margin-left: 2em + } + + span.comment + { + color: #008B00; + font-style: italic + } + span.string, span.char + { + color: #000084; + } + span.number + { + color: #a46200; + } + span.operator + { + color: #202020; + } + span.keyword + { + color: #840000; + } + span.name + { + color: black + } + span.type + { + font-weight: bold + } + span.type a:visited + { + color: #0F5300; + } + span.preprocessor + { + color: #404040 + } +/* end basic elements */ + +/* font style elements */ + .heading + { + font-weight: bold; + font-size: 125%; + } + .subtitle + { + font-size: 110% + } + .small-subtitle + { + font-size: 100% + } + .red + { + color:red; + } +/* end font style elements */ + +/* global settings*/ + .header, .footer + { + display: block; + clear: both; + overflow: hidden; + } +/* end global settings*/ + +/* header elements */ + .header .qtcharts + { + color: #00732F; + font-weight: bold; + font-size: 200%; + text-align: center; + margin: 10px 0px + } + + .header .qtref + { + color: #00732F; + font-weight: bold; + font-size: 100%; + text-align: center; + } + + .header .content + { + /* margin-bottom: 0.5em*/ + } + + .header .content img + { + display: block; + margin-left: auto; + margin-right: auto; + width: 100px; + } + + .naviNextPrevious + { + display: none + } + .header .breadcrumb + { + font-size: 100%; + padding: 0.5em 0 0.5em 1em; + margin: 0; + /*background-color: #393735;*/ + font-weight: bold; + background: #7FBA2E url(../images/bg.png) repeat-x; + height: 20px; + border-bottom: 1px solid #d1d1d1; + } + + .header .breadcrumb ul + { + margin: 0; + padding: 0; + } + + .header .content + { + word-wrap: break-word; + } + + .header .breadcrumb ul li + { + float: left; + /*background: url(../images/breadcrumb.png) no-repeat 0 3px;*/ + padding-left: 1.5em; + margin-left: 1.5em; + } + + .header .breadcrumb ul li.last + { + font-weight: normal; + } + + .header .breadcrumb ul li a + { + color: #ffffff; + } + + .header .breadcrumb ul li a:hover + { + color: #00732F; + text-decoration: none; + } + + .header .breadcrumb ul li.first + { + background-image: none; + padding-left: 0; + margin-left: 0; + } + + .header .content ol li { + background: none; + margin-bottom: 1.0em; + margin-left: 1.2em; + padding-left: 0 + } + + .header .content li + { + background: url(../images/bullet_sq.png) no-repeat 0 5px; + margin-bottom: 1em; + padding-left: 1.2em; + } + +/* end header elements */ + +/* content elements */ + .content h1 + { + font-weight: bold; + font-size: 150% + } + + .content h2 + { + font-weight: bold; + font-size: 135%; + width: 100%; + } + .content h3 + { + font-weight: bold; + font-size: 120%; + width: 100%; + } + .content table p + { + margin: 0 + } + .content ul + { + padding-left: 2.5em; + } + .content li + { + padding-top: 0.25em; + padding-bottom: 0.25em; + } + .content ul img { + vertical-align: middle; + } + + .content a:visited + { + color: #4c0033; + text-decoration: none; + } + + .content a:visited:hover + { + color: #4c0033; + text-decoration: underline; + } + + a:hover + { + color: #4c0033; + text-decoration: underline; + } + descr p a + { + text-decoration: underline; + } + + .descr p a:visited + { + text-decoration: underline; + } + + .alphaChar{ + width:95%; + background-color:#F6F6F6; + border:1px solid #E6E6E6; + -moz-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + font-size:12pt; + padding-left:10px; + margin-top:10px; + margin-bottom:10px; + } + .flowList{ + /*vertical-align:top;*/ + /*margin:20px auto;*/ + + column-count:3; + -webkit-column-count:3; + -moz-column-count:3; +/* + column-width:100%; + -webkit-column-width:200px; + -col-column-width:200px; +*/ + column-gap:41px; + -webkit-column-gap:41px; + -moz-column-gap:41px; + + column-rule: 1px dashed #ccc; + -webkit-column-rule: 1px dashed #ccc; + -moz-column-rule: 1px dashed #ccc; + } + + .flowList dl{ + } + .flowList dd{ + /*display:inline-block;*/ + margin-left:10px; + min-width:250px; + line-height: 1.5; + min-width:100%; + min-height:15px; + } + + .flowList dd a{ + } + + .content .flowList p{ + padding:0px; + } + + .content .alignedsummary + { + margin: 15px; + } + + + .qmltype + { + text-align: center; + font-size: 120%; + } + .qmlreadonly + { + padding-left: 5px; + float: right; + color: #254117; + } + + .qmldefault + { + padding-left: 5px; + float: right; + color: red; + } + + .qmldoc + { + } + + .generic .alphaChar{ + margin-top:5px; + } + + .generic .odd .alphaChar{ + background-color: #F6F6F6; + } + + .generic .even .alphaChar{ + background-color: #FFFFFF; + } + + .memItemRight{ + padding: 0.25em 1.5em 0.25em 0; + } + .highlightedCode + { + margin: 1.0em; + } + .annotated td { + padding: 0.25em 0.5em 0.25em 0.5em; + } + + .header .content .toc ul + { + padding-left: 0px; + } + + .content .toc h3 { + border-bottom: 0px; + margin-top: 10px; + } + + .content .toc h3 a:hover { + color: #00732F; + text-decoration: none; + } + + .content .toc .level2 + { + margin-left: 1.5em; + } + + .content .toc .level3 + { + margin-left: 3.0em; + } + + .content ul li + { + background: url(../images/bullet_sq.png) no-repeat 0 0.7em; + padding-left: 1em + } + + .content .toc li + { + background: url(../images/bullet_dn.png) no-repeat 0 5px; + padding-left: 1em + } + + .relpage + { + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + border: 1px solid #DDDDDD; + padding: 25px 25px; + clear: both; + } + .relpage ul + { + float: none; + padding: 1.5em; + } + + h3.fn, span.fn + { + -moz-border-radius:7px 7px 7px 7px; + -webkit-border-radius:7px 7px 7px 7px; + border-radius:7px 7px 7px 7px; + background-color: #F6F6F6; + border-width: 1px; + border-style: solid; + border-color: #E6E6E6; + font-weight: bold; + word-spacing:3px; + padding:3px 5px; + } + + .functionIndex { + font-size:12pt; + word-spacing:10px; + margin-bottom:10px; + background-color: #F6F6F6; + border-width: 1px; + border-style: solid; + border-color: #E6E6E6; + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + width:100%; + } + + .centerAlign + { + text-align:center; + } + + .rightAlign + { + text-align:right; + } + + .leftAlign + { + text-align:left; + } + + .topAlign{ + vertical-align:top + } + + .functionIndex a{ + display:inline-block; + } + +/* end content elements */ +/* footer elements */ + + .footer + { + color: #393735; + font-size: 0.75em; + text-align: center; + padding-top: 1.5em; + padding-bottom: 1em; + background-color: #E6E7E8; + margin: 0; + } + .footer p + { + margin: 0.25em + } + .small + { + font-size: 0.5em; + } +/* end footer elements */ + + .item { + float: left; + position: relative; + width: 100%; + overflow: hidden; + } + + + .item .primary { + margin-right: 220px; + position: relative; + } + + .item hr { + margin-left: -220px; + } + + .item .secondary { + float: right; + width: 200px; + position: relative; + } + + .item .cols { + clear: both; + display: block; + } + + .item .cols .col { + float: left; + margin-left: 1.5%; + } + + .item .cols .col.first { + margin-left: 0; + } + + .item .cols.two .col { + width: 45%; + } + + .item .box { + margin: 0 0 10px 0; + } + + .item .box h3 { + margin: 0 0 10px 0; + } + + .cols.unclear { + clear:none; + } +} + +/* end of screen media */ + +/* start of print media */ + +@media print +{ + input, textarea, .header, .footer, .toolbar, .feedback, .wrapper .hd, .wrapper .bd .sidebar, .wrapper .ft, #feedbackBox, #blurpage, .toc, .breadcrumb, .toolbar, .floatingResult + { + display: none; + background: none; + } + .content + { + background: none; + display: block; + width: 100%; margin: 0; float: none; + } +} +/* end of print media */ |
