summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
blob: ee0c2427a7b226ac87ff64d3aa1eac693635c757 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/****************************************************************************
**
** 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 AbstractGraph3D
  \inqmlmodule QtDataVisualization
  \since QtDataVisualization 1.0
  \ingroup datavisualization_qml
  \brief Base type for 3D visualizations.

  This type is the base type for all 3D visualizations in QtDataVisualization.

  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.

  \sa Bars3D, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes}
 */

/*!
  \qmlproperty AbstractGraph3D.SelectionMode AbstractGraph3D::selectionMode
  Active selection mode in the visualization.
 */

/*!
  \qmlproperty AbstractGraph3D.ShadowQuality AbstractGraph3D::shadowQuality
  Shadow quality.
 */

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