diff options
Diffstat (limited to 'src/datavisualization/doc')
4 files changed, 401 insertions, 0 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc new file mode 100644 index 00000000..c132e251 --- /dev/null +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -0,0 +1,79 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc +** All rights reserved. +** For any questions to Digia, please use contact form at http://qt.digia.com +** +** This file is part of the QtDataVisualization module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.digia.com +** +****************************************************************************/ + +/*! + \qmltype AbstractDeclarative + \inmodule QtDataVisualization + + This type is the base class for all 3D visualizations in Qt Quick 2. + + It resides in the data visualization module that can be imported like this: + + \snippet doc_src_qmldatavisualization.cpp 0 + + Note that this type is uncreatable, but contains properties that are shared between + the 3D visualizations. + + + \sa Bars3D, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} + */ + +/*! + \qmlproperty AbstractDeclarative.SelectionMode AbstractDeclarative::selectionMode + Active selection mode in the visualization. + */ +/*! + \qmlproperty AbstractDeclarative.LabelTransparency AbstractDeclarative::labelTransparency + Label transparency. + */ + +/*! + \qmlproperty AbstractDeclarative.ShadowQuality AbstractDeclarative::shadowQuality + Shadow quality. + */ + +/*! + \qmlproperty AbstractDeclarative.CameraPreset AbstractDeclarative::cameraPreset + Camera preset. + */ + +/*! + \qmlproperty AbstractDeclarative.ColorTheme AbstractDeclarative::theme + Theme of the graph. Theme affects visualization colors, label colors, text color, background color, window + color and grid color. Lighting is also adjusted by themes. + */ + +/*! + \qmlproperty font AbstractDeclarative::font + Font used for labels. + */ + +/*! + \qmlproperty bool AbstractDeclarative::gridVisible + Grid visibility. If false, grid lines are not drawn. + */ + +/*! + \qmlproperty bool AbstractDeclarative::backgroundVisible + Background visibility. If false, background is not drawn. + */ + +/*! + \qmlproperty string AbstractDeclarative::itemLabelFormat + Label format of single item labels, e.g. a selected datapoint. + */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc new file mode 100644 index 00000000..b36d6f83 --- /dev/null +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc @@ -0,0 +1,133 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc +** All rights reserved. +** For any questions to Digia, please use contact form at http://qt.digia.com +** +** This file is part of the QtDataVisualization module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.digia.com +** +****************************************************************************/ + +/*! + * \qmltype Bars3D + * \inherits AbstractDeclarative + * \inmodule QtDataVisualization + * + * 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 Barchart Example} for more thorough usage example. + * + * \sa ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} + */ + +/*! + * \qmlmethod void Bars3D::setBarColor(const QColor &baseColor, bool uniform) + * Set bar color using your own color. \a baseColor sets the base color of a bar. The \a uniform + * -flag is used to define if color needs to be uniform throughout bar's length, or will the colors + * be applied by height, starting with dark at the bottom. It is \c true by default. + * + * Calling this method overrides colors from theme. + * + * \sa AbstractDeclarative::theme + * + * \warning This method is subject to change. + */ + +/*! + * \qmlproperty BarDataProxy Bars3D::dataProxy + * The active data proxy. + * + * If a proxy is not given, a temporary default proxy is created and activated. + * This temporary proxy is destroyed if another proxy is explicitly set active via this property. + */ + +/*! + * \qmlproperty CategoryAxis3D Bars3D::rowAxis + * A user-defined 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 same orientation. + */ + +/*! + * \qmlproperty ValueAxis3D Bars3D::valueAxis + * A user-defined value axis. + * + * If an axis is not given, a temporary default axis with no labels and automatically adjusting + * range is created. + * This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + * \qmlproperty CategoryAxis3D Bars3D::columnAxis + * A user-defined 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 same orientation. + */ + + +/*! + * \qmlproperty Bars3D.MeshStyle Bars3D::barType + * Bar object type. + */ + +/*! + * \qmlproperty real Bars3D::barThickness + * Bar thickness ratio between X and Z dimensions. 1.0 means bars are as wide as they are deep, 0.5 + * makes them twice as deep as they are wide. + */ + +/*! + * \qmlproperty size Bars3D::barSpacing + * Bar spacing in X and Z dimensions. + */ + +/*! + * \qmlproperty bool Bars3D::barSpacingRelative + * Relative or absolute bar spacing. + */ + +/*! + * \qmlproperty bool Bars3D::barSmoothingEnabled + * Bar smoothing. If false, bar shading is flat. + */ + +/*! + * \qmlproperty string Bars3D::meshFileName + * Override bar type with a mesh object. + * \note Object needs to be in Wavefront obj format and include vertices, normals and UVs. + * It also needs to be in triangles. + */ + +/*! + * \qmlproperty int Bars3D::rows + * Row count of data window. + */ + +/*! + * \qmlproperty int Bars3D::columns + * Column count of data window. + */ + +/*! + * \qmlproperty point Bars3D::selectedBarPos + * Position of the selected bar in data window. Only one bar can be selected at a time. + * To clear selection, specify an illegal position, e.g. Qt.point(-1.0, -1.0). + */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc new file mode 100644 index 00000000..672dd5b7 --- /dev/null +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -0,0 +1,102 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc +** All rights reserved. +** For any questions to Digia, please use contact form at http://qt.digia.com +** +** This file is part of the QtDataVisualization module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.digia.com +** +****************************************************************************/ + +/*! + \qmltype Scatter3D + \inherits AbstractDeclarative + \inmodule QtDataVisualization + + This type enables developers to render scatter 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 Scatter3D in your qml files: + + \snippet doc_src_qmldatavisualization.cpp 2 + + See \l{Qt Quick 2 Scatter Example} for more thorough usage example. + + \sa ItemModelScatterDataProxy, Bars3D, Surface3D, {Qt Data Visualization C++ Classes} + */ + +/*! + * \qmlmethod void Scatter3D::setObjectColor(const QColor &baseColor, bool uniform) + * Set item color using your own colors. \a baseColor sets the base color of a item. The \a uniform + * -flag is used to define if color needs to be uniform throughout item's length, or will the colors + * be applied by height. It is \c true by default. + * + * Calling this method overrides colors from theme. + * + * \sa AbstractDeclarative::theme + * + * \warning This method is subject to change. + */ + +/*! + \qmlproperty ScatterDataProxy Scatter3D::dataProxy + The active data proxy. + + If a proxy is not given, a temporary default proxy is created and activated. + This temporary proxy is destroyed if another proxy is explicitly set active via this property. + */ + +/*! + \qmlproperty ValueAxis3D Scatter3D::axisX + A user-defined X axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty ValueAxis3D Scatter3D::axisY + A user-defined Y axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty ValueAxis3D Scatter3D::axisZ + A user-defined Z axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty Scatter3D.MeshStyle Scatter3D::objectType + Dot object type. + */ + +/*! + \qmlproperty bool Scatter3D::objectSmoothingEnabled + Dot smoothing. If false, dot shading is flat. + */ + +/*! + \qmlproperty string Scatter3D::meshFileName + Override object type with a mesh object. + \note Object needs to be in Wavefront obj format and include vertices, normals and UVs. + It also needs to be in triangles. + */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc new file mode 100644 index 00000000..069fa9e9 --- /dev/null +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -0,0 +1,87 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc +** All rights reserved. +** For any questions to Digia, please use contact form at http://qt.digia.com +** +** This file is part of the QtDataVisualization module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.digia.com +** +****************************************************************************/ + +/*! + \qmltype Surface3D + \inherits AbstractDeclarative + \inmodule QtDataVisualization + + This type enables developers to render surface plots 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 Surface3D in your qml files: + + \snippet doc_src_qmldatavisualization.cpp 3 + + See \l{Qt Quick 2 Surface Example} for more thorough usage example. + + \sa ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes} + */ + +/*! + \qmlproperty SurfaceDataProxy Surface3D::dataProxy + The active data proxy. + + If a proxy is not given, a temporary default proxy is created and activated. + This temporary proxy is destroyed if another proxy is explicitly set active via this property. + */ + +/*! + \qmlproperty ValueAxis3D Surface3D::axisX + A user-defined X axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty ValueAxis3D Surface3D::axisY + A user-defined Y axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty ValueAxis3D Surface3D::axisZ + A user-defined Z axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty bool Surface3D::smoothSurfaceEnabled + Smoothing of surface. If false, shading of the surface is flat. + */ + +/*! + \qmlproperty bool Surface3D::surfaceGridEnabled + Surface grid visibility. If false, no surface grid is drawn. + */ + +/*! + \qmlproperty var Surface3D::gradient + The current surface gradient. Setting this property replaces the previous gradient. + */ |