summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarek Rosa <marek.rosa@digia.com>2012-12-11 14:08:36 +0200
committerMarek Rosa <marek.rosa@digia.com>2012-12-11 14:08:36 +0200
commit01d2a7083c004a1a1518f6109f786ea77f77dd20 (patch)
treeab2ed435f69406ff04a67f46f4f4b3ffbc907ea6 /doc
parent8d156e43373821d8e05539da76edc678f0ede39c (diff)
logvalueaxis and multiaxis examples documented
Diffstat (limited to 'doc')
-rw-r--r--doc/src/examples-logvalueaxis.qdoc30
-rw-r--r--doc/src/examples-multiaxis.qdoc36
-rw-r--r--doc/src/examples.qdoc11
3 files changed, 76 insertions, 1 deletions
diff --git a/doc/src/examples-logvalueaxis.qdoc b/doc/src/examples-logvalueaxis.qdoc
new file mode 100644
index 00000000..fd9899f4
--- /dev/null
+++ b/doc/src/examples-logvalueaxis.qdoc
@@ -0,0 +1,30 @@
+/*!
+ \example examples/logvalueaxis
+ \title Logarithmic axis example
+ \subtitle
+
+ The example shows how to use QLogValueAxis.
+
+ \image examples_logvalueaxis.png
+
+ Create QLineSeries instance and add some data to it.
+
+ \snippet ../examples/logvalueaxis/main.cpp 1
+
+ To present the data on the char we need QChart instance. Add the series to it, hide the legend and set the title of the chart.
+
+ \snippet ../examples/logvalueaxis/main.cpp 2
+
+ Create the axes. Add them to the chart and attach to the series.
+
+ \snippet ../examples/logvalueaxis/main.cpp 3
+
+ Then create a QChartView object with QChart as a parameter. Enable antialiasing to have the rendered line look nicer.
+
+ \snippet ../examples/logvalueaxis/main.cpp 4
+
+ Chart is ready to be shown.
+
+ \snippet ../examples/logvalueaxis/main.cpp 5
+
+*/
diff --git a/doc/src/examples-multiaxis.qdoc b/doc/src/examples-multiaxis.qdoc
new file mode 100644
index 00000000..d618ba12
--- /dev/null
+++ b/doc/src/examples-multiaxis.qdoc
@@ -0,0 +1,36 @@
+/*!
+ \example examples/multiaxis
+ \title Multiple axes example
+ \subtitle
+
+ The example shows how to create simple chart with two vertical axes. One for each series.
+
+ \image examples_multiaxis.png
+
+ Create QChart instance, hide the legend of the chart and set its title.
+
+ \snippet ../examples/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.
+ Axis can be sharted between many series, but each series can have only one vertical and horizontal axis.
+
+ \snippet ../examples/multiaxis/main.cpp 2
+
+ Create the first series, 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 ../examples/multiaxis/main.cpp 3
+
+ Similarly prepare another series. This time different axis type is used. Additionally grid lines color is also set to be the same as the color of the series.
+
+ \snippet ../examples/multiaxis/main.cpp 4
+
+ Create a QChartView object with QChart as a parameter. Enanle Antialiasing to have the rendered splines look nicer.
+
+ \snippet ../examples/multiaxis/main.cpp 5
+
+ Chart is ready to be shown.
+
+ \snippet ../examples/multiaxis/main.cpp 6
+
+*/
diff --git a/doc/src/examples.qdoc b/doc/src/examples.qdoc
index 3c9551f6..a2773c9f 100644
--- a/doc/src/examples.qdoc
+++ b/doc/src/examples.qdoc
@@ -70,11 +70,20 @@
</tr>
<tr>
+ <td><a href="examples-logvalueaxis.html">Logarythmic axis</a></td>
<td><a href="examples-modeldata.html">Model Data</a></td>
- <td><a href="examples-percentbarchart.html">Percent Bar Chart</a></td>
</tr>
<tr>
+ <td><a href="examples-logvalueaxis.html"><img src="images/examples_logvalueaxis.png" width="300" alt="Logarythmix axis" /></a></td>
<td><a href="examples-modeldata.html"><img src="images/examples_modeldata.png" width="300" alt="Model Data" /></a></td>
+ </tr>
+
+ <tr>
+ <td><a href="examples-multiaxis.html">Multiple axes</a></td>
+ <td><a href="examples-percentbarchart.html">Percent Bar Chart</a></td>
+ </tr>
+ <tr>
+ <td><a href="examples-multiaxis.html"><img src="images/examples_multiaxis.png" width="300" alt="Multiple axes" /></a></td>
<td><a href="examples-percentbarchart.html"><img src="images/examples_percentbarchart.png" width="300" alt="Percent Bar Chart" /></a></td>
</tr>