Revision control

- /****************************************************************************
- **
- ** Copyright (C) 2016 The Qt Company Ltd.
- ** Contact: https://www.qt.io/licensing/
- **
- ** This file is part of the documentation of the Qt Toolkit.
- **
- ** $QT_BEGIN_LICENSE:FDL$
- ** 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 Free Documentation License Usage
- ** Alternatively, this file may be used under the terms of the GNU Free
- ** Documentation License version 1.3 as published by the Free Software
- ** Foundation and appearing in the file included in the packaging of
- ** this file. Please review the following information to ensure
- ** the GNU Free Documentation License version 1.3 requirements
- ** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
- ** $QT_END_LICENSE$
- **
- ****************************************************************************/
+ // Copyright (C) 2016 The Qt Company Ltd.
+ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
* \qmltype Bars3D
* \inherits AbstractGraph3D
* \inqmlmodule QtDataVisualization
* \since QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \brief 3D bar graph.
*
* This type enables developers to render bar graphs in 3D with Qt Quick 2.
*
* You will need to import data visualization module to use this type:
*
* \snippet doc_src_qmldatavisualization.cpp 0
*
* After that you can use Bars3D in your qml files:
*
* \snippet doc_src_qmldatavisualization.cpp 1
*
* See \l{Qt Quick 2 Bars Example} for more thorough usage example.
*
* \sa Bar3DSeries, ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes}
*/
/*!
* \qmlproperty CategoryAxis3D Bars3D::rowAxis
* The active row axis.
*
* If an axis is not given, a temporary default axis with no labels is created.
* This temporary axis is destroyed if another axis is explicitly set to the
* same orientation.
*/
/*!
* \qmlproperty ValueAxis3D Bars3D::valueAxis
* The active value axis.
*
* If an axis is not given, a temporary default axis with no labels and an
* automatically adjusting range is created.
* This temporary axis is destroyed if another axis is explicitly set to the
* same orientation.
*/
/*!
* \qmlproperty CategoryAxis3D Bars3D::columnAxis
* The active column axis.
*
* If an axis is not given, a temporary default axis with no labels is created.
* This temporary axis is destroyed if another axis is explicitly set to the
* same orientation.
*/
/*!
* \qmlproperty bool Bars3D::multiSeriesUniform
* Defines whether bars are to be scaled with proportions set to a single series bar even
* if there are multiple series displayed. If set to \c {true}, \l{barSpacing}{bar spacing} will
* be correctly applied only to the X-axis. Preset to \c false by default.
*/
/*!
* \qmlproperty real Bars3D::barThickness
* The bar thickness ratio between the X and Z dimensions. The value \c 1.0
* means that the bars are as wide as they are deep, whereas \c 0.5
* makes them twice as deep as they are wide.
*/
/*!
* \qmlproperty size Bars3D::barSpacing
* Bar spacing in X and Z dimensions.
*
* Preset to \c {(1.0, 1.0)} by default. Spacing is affected by the
* barSpacingRelative property.
*/
/*!
* \qmlproperty bool Bars3D::barSpacingRelative
* Whether spacing is absolute or relative to bar thickness.
*
* If \c true, the value of \c 0.0 means that the bars are placed
* side-to-side, \c 1.0 means that a space as wide as the thickness of one bar
* is left between the bars, and so on. Preset to \c true.
*/
/*!
* \qmlproperty size Bars3D::barSeriesMargin
* \since 6.3
*
* Margin between series columns in X and Z dimensions. Preset to \c {(0.0, 0.0)} by default.
* Sensible values are on the range [0,1).
*/
/*!
* \qmlproperty Bar3DSeries Bars3D::selectedSeries
* The selected series or \c null. If \l {QAbstract3DGraph::selectionMode}{selectionMode} has
* the \c SelectionMultiSeries flag set, this property holds the series that
* owns the selected bar.
*/
/*!
* \qmlproperty list<Bar3DSeries> Bars3D::seriesList
* \qmldefault
* The series of the graph.
* By default, this property contains an empty list.
* To set the series, either use the addSeries() function or define them as children of the graph.
*/
/*!
* \qmlproperty Bar3DSeries Bars3D::primarySeries
* The primary series of the graph. It
* is used to determine the row and column axis labels when the labels are not explicitly
* set to the axes.
*
* If the specified series is not yet added to the graph, setting it as the
* primary series will also implicitly add it to the graph.
*
* If the primary series itself is removed from the graph, this property
* resets to default.
*
* If the series is null, this property resets to default.
* Defaults to the first added series or zero if no series are added to the graph.
*/
/*!
* \qmlproperty real Bars3D::floorLevel
*
* The floor level for the bar graph in Y-axis data coordinates.
*
* The actual floor level will be restricted by the Y-axis minimum and maximum
* values.
* Defaults to zero.
*/
/*!
* \qmlmethod void Bars3D::addSeries(Bar3DSeries series)
* Adds the \a series to the graph. A graph can contain multiple series, but only one set of axes,
* so the rows and columns of all series must match for the visualized data to be meaningful.
* If the graph has multiple visible series, only the first one added will
* generate the row or column labels on the axes in cases where the labels are not explicitly set
* to the axes. If the newly added series has specified a selected bar, it will be highlighted and
* any existing selection will be cleared. Only one added series can have an active selection.
* \sa AbstractGraph3D::hasSeries()
*/
/*!
* \qmlmethod void Bars3D::removeSeries(Bar3DSeries series)
* Remove the \a series from the graph.
* \sa AbstractGraph3D::hasSeries()
*/
/*!
* \qmlmethod void Bars3D::insertSeries(int index, Bar3DSeries series)
* Inserts the \a series into the position \a index in the series list.
* If the \a series has already been added to the list, it is moved to the
* new \a index.
* \note When moving a series to a new \a index that is after its old index,
* the new position in list is calculated as if the series was still in its old
* index, so the final index is actually the \a index decremented by one.
* \sa AbstractGraph3D::hasSeries()
*/