summaryrefslogtreecommitdiffstats
path: root/src/charts/doc/src/examples-horizontalpercentbarchart.qdoc
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2023-06-05 18:41:58 +0300
committerNicholas Bennett <nicholas.bennett@qt.io>2023-06-15 15:26:38 +0000
commit5852d85f2743c62f9d79c17043b9b48826f5ffc3 (patch)
treeea21ae0b70fbf563907210553228ee31572817d6 /src/charts/doc/src/examples-horizontalpercentbarchart.qdoc
parent2ae46ef08f6a10a0d44557bb592db06be667f2bb (diff)
Docs: Rework example documentation into charts widget gallery example
Removed example commands, fixed snippets to point to new locations, added page commands that have the existing html address and added \ingroup commands to create a table that points to the new pages. Removed examples documentation with no code walk-through. Move example documentation source files to example folder. Fixes: QTBUG-114221 Pick-to: 6.6 6.5 6.5.2 Change-Id: I7ab3b56457df4d33b52be6fd0022e7a92809d82c Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Diffstat (limited to 'src/charts/doc/src/examples-horizontalpercentbarchart.qdoc')
-rw-r--r--src/charts/doc/src/examples-horizontalpercentbarchart.qdoc64
1 files changed, 0 insertions, 64 deletions
diff --git a/src/charts/doc/src/examples-horizontalpercentbarchart.qdoc b/src/charts/doc/src/examples-horizontalpercentbarchart.qdoc
deleted file mode 100644
index e17c468d..00000000
--- a/src/charts/doc/src/examples-horizontalpercentbarchart.qdoc
+++ /dev/null
@@ -1,64 +0,0 @@
-// Copyright (C) 2016 The Qt Company Ltd.
-// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
-
-/*!
- \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
-
- \include examples-run.qdocinc
-
- \section1 Creating Horizontal Percent Bar Charts
-
- 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 add it to the chart on the left-hand side, acting as the
- y-axis. The chart takes ownership of the axis. For x-axis we use a value
- axis, aligned to the bottom.
-
- \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
-*/