/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Charts module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \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
    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
*/
