diff options
Diffstat (limited to 'src/datavisualization/doc')
18 files changed, 142 insertions, 36 deletions
diff --git a/src/datavisualization/doc/images/q3dbars-minimal.png b/src/datavisualization/doc/images/q3dbars-minimal.png Binary files differindex 21dcf5b3..3e94ccae 100644 --- a/src/datavisualization/doc/images/q3dbars-minimal.png +++ b/src/datavisualization/doc/images/q3dbars-minimal.png diff --git a/src/datavisualization/doc/images/q3dscatter-minimal.png b/src/datavisualization/doc/images/q3dscatter-minimal.png Binary files differindex fc5f8c62..d5f8198c 100644 --- a/src/datavisualization/doc/images/q3dscatter-minimal.png +++ b/src/datavisualization/doc/images/q3dscatter-minimal.png diff --git a/src/datavisualization/doc/images/q3dsurface-minimal.png b/src/datavisualization/doc/images/q3dsurface-minimal.png Binary files differindex 2ef8b104..af82c9bb 100644 --- a/src/datavisualization/doc/images/q3dsurface-minimal.png +++ b/src/datavisualization/doc/images/q3dsurface-minimal.png diff --git a/src/datavisualization/doc/qtdatavisualization.qdocconf b/src/datavisualization/doc/qtdatavisualization.qdocconf index 7a7fa0b1..81922313 100644 --- a/src/datavisualization/doc/qtdatavisualization.qdocconf +++ b/src/datavisualization/doc/qtdatavisualization.qdocconf @@ -12,8 +12,9 @@ imagedirs += ../images \ images sourcedirs += .. -depends += qtcore \ - qtgui +depends += qtcore qtgui qtdeclarative + +indexes += $QTDIR/doc/html/qt.index qhp.projects = qtdatavisualization @@ -47,7 +48,7 @@ qhp.qtdatavisualization.subprojects.types.sortPages = true HTML.footer = \ "<div class=\"footer\">\n" \ " <p>\n" \ - " <acronym title=\"Copyright\">©</acronym> 2013 Digia. Qt and Qt logos are\n" \ + " <acronym title=\"Copyright\">©</acronym> 2014 Digia. Qt and Qt logos are\n" \ " trademarks of of Digia Corporation in Finland and/or other countries worldwide.\n" \ " </p>\n" \ " All other trademarks are property of their respective owners.\n" \ diff --git a/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp index 2b4a0aed..64757d58 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** diff --git a/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp index 15820bf1..531ce242 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** diff --git a/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp index 245be2f4..92dd34ed 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** diff --git a/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp b/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp index 5a539e62..9a2d1b3d 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** @@ -57,9 +57,9 @@ int main(int argc, char **argv) //! [3] Q3DBars *graph = new Q3DBars(); - graph->setTheme(new Q3DTheme(Q3DTheme::ThemePrimaryColors)); - graph->theme()->setBaseColor(Qt::red); - graph->theme()->setSingleHighlightColor(Qt::yellow); + graph->activeTheme()->setType(Q3DTheme::ThemePrimaryColors); + graph->activeTheme()->setBaseColor(Qt::red); + graph->activeTheme()->setSingleHighlightColor(Qt::yellow); //! [3] } diff --git a/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp index 623f7f6f..8c38ca82 100644 --- a/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp +++ b/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp index 6a336422..458eeb45 100644 --- a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp +++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro index 81555f88..15ae2f65 100644 --- a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro +++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc index c37d98a4..d593c1e9 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** @@ -18,7 +18,7 @@ /*! \title Qt Data Visualization - \page qtdatavisualization-index.html + \page index.html \brief Provides functionality for 3D visualization. Qt Data Visualization module provides a way to visualize data in 3D. @@ -33,8 +33,7 @@ \li QML2 support \li Customizable axes for data - control viewable data window with axis ranges \li Customizable input handling - \li Customizable scene handling - full control of viewports - (upcoming feature - not fully supported in alpha) + \li Customizable scene handling \li Customizable themes \endlist diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index 7493709f..df503eb4 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** @@ -28,6 +28,15 @@ Note that this type is uncreatable, but contains properties that are shared between the 3D visualizations. + \note QML doesn't support the type of anti-aliasing used by Qt Data Visualization graphs + by default. Setting the \c antialiasing property doesn't affect graphs. To enable + anti-aliasing for graphs, a custom surface format must be set up for the QQuickView + before showing it. You can use the convenience function + \c{QtDataVisualization::qDefaultSurfaceFormat()} to create the custom surface format object. + + For AbstractGraph3D enums, see \l QAbstract3DGraph::SelectionFlag and + \l QAbstract3DGraph::ShadowQuality + \sa Bars3D, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} */ @@ -42,11 +51,43 @@ */ /*! + \qmlproperty Scene3D AbstractGraph3D::scene + Read only Q3DScene that can be used to access e.g. camera object. + */ + +/*! \qmlproperty AbstractInputHandler3D AbstractGraph3D::inputHandler Input handler. You can disable default input handlers by setting this property to \c null. */ /*! \qmlproperty Theme3D AbstractGraph3D::theme - Theme of the graph. + The active theme of the graph. */ + +/*! + \qmlproperty bool AbstractGraph3D::clearWindowBeforeRendering + + Indicates if the graph should also clear the whole window before rendering the graph, + including the areas outside the graph. + Since the graphs are drawn first under other QML items, the regular QML window clearing + before rendering is suppressed when there are any graphs in the window; the graphs + handle the clearing themselves instead. + If you have any other items besides graphs that do similar + custom drawing under other QML items, you need to set this property to false on all graphs + drawn to same window with the other custom items, or it is likely that the + other custom items do not render properly. + Defaults to true. + + \note This property should be set to the same value for all graphs in the same window. + Otherwise some graphs may not show. + + \note If window clearing before rendering is suppressed, any areas of the window not fully + covered with opaque items may not draw properly. + */ + +/*! + * \qmlmethod void AbstractGraph3D::clearSelection() + * Clears selection from all attached series. + */ + diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc index edeb5530..aaafe217 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** @@ -46,7 +46,7 @@ /*! * \qmlproperty CategoryAxis3D Bars3D::rowAxis - * A user-defined row axis. + * 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 same orientation. @@ -54,7 +54,7 @@ /*! * \qmlproperty ValueAxis3D Bars3D::valueAxis - * A user-defined value axis. + * The active value axis. * * If an axis is not given, a temporary default axis with no labels and automatically adjusting * range is created. @@ -63,12 +63,18 @@ /*! * \qmlproperty CategoryAxis3D Bars3D::columnAxis - * A user-defined column axis. + * 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 same orientation. */ +/*! + * \qmlproperty bool Bars3D::multiSeriesUniform + * This property controls if 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 + * affect only X-axis correctly. It is preset to \c false by default. + */ /*! * \qmlproperty real Bars3D::barThickness @@ -87,7 +93,7 @@ */ /*! - * \qmlproperty list<QBar3DSeries> Bars3D::seriesList + * \qmlproperty list<Bar3DSeries> Bars3D::seriesList * \default * This property holds the series of the graph. * By default, this property contains an empty list. @@ -95,7 +101,20 @@ */ /*! - * \qmlmethod void Bars3D::addSeries(QBar3DSeries *series) + * \qmlproperty Bar3DSeries Bars3D::primarySeries + * Specifies the \a series that is the primary series of the graph. The primary series + * is used to determine the row and column axis labels when the labels are not explicitly + * set to the axes. + * If the specified \a series is not already 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 \a series is null, this property resets to default. + * Defaults to the first added series or zero if no series are added to the graph. + */ + +/*! + * \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 @@ -105,6 +124,16 @@ */ /*! - * \qmlmethod void Bars3D::removeSeries(QBar3DSeries *series) + * \qmlmethod void Bars3D::removeSeries(Bar3DSeries series) * Remove the \a series from the graph. */ + +/*! + * \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. + */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc index b6f0781f..d0ef5747 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc index 0a8e1674..b969c536 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** @@ -46,7 +46,7 @@ /*! \qmlproperty ValueAxis3D Scatter3D::axisX - A user-defined X axis. + The active X axis. If an axis is not given, a temporary default axis with no labels and automatically adjusting range is created. @@ -55,7 +55,7 @@ /*! \qmlproperty ValueAxis3D Scatter3D::axisY - A user-defined Y axis. + The active Y axis. If an axis is not given, a temporary default axis with no labels and automatically adjusting range is created. @@ -64,7 +64,7 @@ /*! \qmlproperty ValueAxis3D Scatter3D::axisZ - A user-defined Z axis. + The active Z axis. If an axis is not given, a temporary default axis with no labels and automatically adjusting range is created. diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc index b28d30a7..3011336b 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** @@ -46,7 +46,7 @@ /*! \qmlproperty ValueAxis3D Surface3D::axisX - A user-defined X axis. + The active X axis. If an axis is not given, a temporary default axis with no labels and automatically adjusting range is created. @@ -55,7 +55,7 @@ /*! \qmlproperty ValueAxis3D Surface3D::axisY - A user-defined Y axis. + The active Y axis. If an axis is not given, a temporary default axis with no labels and automatically adjusting range is created. @@ -64,7 +64,7 @@ /*! \qmlproperty ValueAxis3D Surface3D::axisZ - A user-defined Z axis. + The active Z axis. If an axis is not given, a temporary default axis with no labels and automatically adjusting range is created. diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index 9c951877..c85b9dbb 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc +** Copyright (C) 2014 Digia Plc ** All rights reserved. ** For any questions to Digia, please use contact form at http://qt.digia.com ** @@ -17,6 +17,16 @@ ****************************************************************************/ /*! + \namespace QtDataVisualization + \inmodule QtDataVisualization + + QtDataVisualization namespace holds all the classes and enumerations in the QtDataVisualization + module. + + \generatelist{classesbymodule QtDataVisualization} +*/ + +/*! \module QtDataVisualization \title Qt Data Visualization C++ Classes \ingroup modules @@ -286,3 +296,29 @@ When multiple series are added to a graph, selecting an item in one of them will clear the selection on other series. */ + +/*! + * \fn QSurfaceFormat QtDataVisualization::qDefaultSurfaceFormat(bool antialias = true) + * \relates QAbstract3DGraph + * + * Anti-aliasing is turned on by default on C++ and turned off on QML, except in OpenGL ES2 + * environments, where anti-aliasing is not supported by Qt Data Visualization. + * This convenience function can be used to construct a suitable surface format for use by + * Qt Data Visualization graphs. + * The \a{antialias} parameter specifies whether or not anti-aliasing is activated. + * Give the surface format returned by this function to the graph constructor (C++) or set + * it as the window format for QQuickView (QML) before calling show on it. + * + * For example, disable anti-aliasing on C++ application: + * + * \code + * Q3DBars *graph = new Q3DBars(QtDataVisualization::qDefaultSurfaceFormat(false)); + * \endcode + * + * For example, enable anti-aliasing on QML application: + * + * \code + * QtQuick2ApplicationViewer viewer; + * viewer.setFormat(QtDataVisualization::qDefaultSurfaceFormat()); + * \endcode + */ |
