summaryrefslogtreecommitdiffstats
path: root/README
blob: f450b8b8cc180252b266872fcdee0acf4be09cc1 (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
-------------------------------------------------
Qt Data Visualization 0.1.0 (Techonology preview)
-------------------------------------------------

Qt Data Visualization module provides multiple graph types to visualize data in 3D space
both with C++ and Qt Quick 2.

System Requirements
===================

- Qt 5.1 or newer
- OpenGL 2.1 or newer (recommended) or OpenGL ES2 (reduced feature set)

Building
========
Configure project with qmake and build project with make:
    (Linux) make
    (Windows with MinGw) mingw32-make
    (Visual Studio) nmake
    (OSX) make

If you want to install the module to your Qt directory use:
    make install

If you want to uninstall the module
    make uninstall

Building as a statically linked library
=======================================

The same as above applies you will just have to add static to the CONFIG:
    qmake CONFIG+=static

Documentation
=============
Pregenerated documentation can be found from doc folder for both Qt Assistant
(qtdatavisualization.qch) and in HTML format (qtdatavisualization subfolder).

The documentation can also be generated with:
    make docs

Please refer to the generated documentation for more information:
    doc/qtdatavisualization/qtdatavisualization-index.html

Known Issues
============

The technology preview version is still missing some features entirely, while some
others may be only partially implemented. Here are some known issues:

- Scatter graphs can only show zero centered axis ranges properly.
- Value axis range of a bar graph with negative values need to be zero
  centered to display properly.
- Selection API is missing for surface graphs.
- Shadows do not work for surface graphs.
- Mac: Graphs drawn half the size on Retina displays.
- Using multiple graphs in one application crashes on application shutdown
  unless the last graph to have active context is deleted last.
- Android doesn't support both widgets and OpenGL simulataneously, so only
  the Qt Quick 2 API is usable in practice in Android.
- Shadows are not supported with OpenGL ES2 (including Angle builds in Windows).