summaryrefslogtreecommitdiffstats
path: root/doc/src/declarativepolarchart.qdocinc
diff options
context:
space:
mode:
authorTitta Heikkala <titta.heikkala@digia.com>2013-10-23 14:55:35 +0300
committerTitta Heikkala <titta.heikkala@digia.com>2013-10-28 10:19:05 +0200
commit2ce3423968b53608871b5fd75c202c0699f569b4 (patch)
tree2dbc27f2e1ef877de545d5c105d224180d6b1f79 /doc/src/declarativepolarchart.qdocinc
parentc98d8af1763df3e8f3c2b8b2117ebcd882b6b16d (diff)
Fix Charts documentation
The documentation structure is changed so that it can be generated with both Qt5 and Qt4. Also the erroneous VBarModelMapper is removed from VBoxPlotModelMapper documentation. Task-number: QTRD-2492, QTRD-2495 Change-Id: I45028915ca55f6ff1170db58518a8f08ac4158fb Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Diffstat (limited to 'doc/src/declarativepolarchart.qdocinc')
-rw-r--r--doc/src/declarativepolarchart.qdocinc20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/src/declarativepolarchart.qdocinc b/doc/src/declarativepolarchart.qdocinc
new file mode 100644
index 00000000..778b0897
--- /dev/null
+++ b/doc/src/declarativepolarchart.qdocinc
@@ -0,0 +1,20 @@
+PolarChartView element is the parent that is responsible for showing different chart series types
+in a polar chart.
+
+Polar charts support line, spline, area, and scatter series, and all axis types
+supported by those series.
+
+\note When setting ticks to an angular ValueAxis, keep in mind that the first and last tick
+are co-located at 0/360 degree angle.
+
+\note If the angular distance between two consecutive points in a series is more than 180 degrees,
+any line connecting the two points becomes meaningless, so choose the axis ranges accordingly
+when displaying line, spline, or area series.
+
+The following QML shows how to create a polar chart with two series:
+\snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View1.qml 1
+
+\beginfloatleft
+\image demos_qmlpolarchart1.png
+\endfloat
+\clearfloat