##// END OF EJS Templates
Updated README...
Titta Heikkala -
r2744:d83c3ab5c084
parent child
Show More
@@ -1,117 +1,73
1 ----------------------
1 ---------------
2 Qt Charts Add-on 1.4.0
2 Qt Charts 2.0.0
3 ----------------------
3 ---------------
4
4
5 What's in Qt Charts
5 Qt Charts module provides a set of easy to use chart components. It uses
6 the Qt Graphics View Framework, therefore charts can be easily integrated
7 to modern user interfaces.
8
9 System Requirements
6 ===================
10 ===================
7
11
8 Directory structure:
12 - Qt 5.4 or newer
9
13 - For QML applications QtQuick 2 is required
10 src/
14 - Manipulating Qt Charts graphs with QML Designer requires Qt Creator 3.2 or newer
11 Source code of the Qt Charts
12 plugins/
13 QML bindings plugins and QtCreator plugin
14 examples/
15 Some examples of using Qt Charts
16 demos/
17 More versatile example applications showing how to customize charts,
18 combine several chart types and implement interaction in charts
19 doc/
20 Documentation
21 licenses/
22 Licensing information
23
15
24 Building
16 Building
25 ========
17 ========
26
18
27 Please note that if you have already installed a previous version of
19 Configure the project with qmake:
28 Qt Charts, you should first uninstall it with
20 qmake
29 make uninstall
30
21
31 Configure project with qmake and build project with make:
22 After running qmake, build the project with make:
32 (Linux) make
23 (Linux) make
33 (Windows with MinGw) mingw32-make
24 (Windows with MinGw) mingw32-make
34 (Visual Studio) nmake
25 (Windows with Visual Studio) nmake
35 (OSX) make
26 (OS X) make
36
27
28 The above generates the default makefiles for your configuration, which is typically
29 the release build if you are using precompiled binary Qt distribution. To build both
30 debug and release, or one specifically, use one of the following qmake lines instead.
31
37 For debug builds:
32 For debug builds:
38 qmake CONFIG+=debug; make
33 qmake CONFIG+=debug
34 make
39 or
35 or
40 qmake CONFIG+=debug_and_release; make debug
36 qmake CONFIG+=debug_and_release
37 make debug
41
38
42 For release builds:
39 For release builds:
43 qmake CONFIG+=release; make
40 qmake CONFIG+=release
41 make
44 or
42 or
45 qmake CONFIG+=debug_and_release; make release
43 qmake CONFIG+=debug_and_release
46
44 make release
47 For both builds:
48 qmake CONFIG+="debug_and_release build_all"; make
49
45
50 If you want to leave out demos and examples from the build you can use
46 For both builds (Windows/OS X only):
51 the following config with qmake:
47 qmake CONFIG+="debug_and_release build_all"
52 CONFIG+=nomake_demos_examples
48 make
53 For some embedded environments, such as VxWorks, all examples and demos
54 may not be applicable. There it's recommended to use the above mentioned
55 config option.
56
49
57 If you want to install the libraries to your Qt library directory use:
50 After building, install the module to your Qt directory:
58 make install
51 make install
59
52
60 If you want to uninstall the libraries:
53 If you want to uninstall the module:
61 make uninstall
54 make uninstall
62
55
63 Building as a statically linked library
56 Building as a statically linked library
64 =======================================
57 =======================================
65
58
66 The same as above applies, you will just have to add staticlib to the CONFIG:
59 The same as above applies, you will just have to add static to the CONFIG:
67 qmake CONFIG+=staticlib
60 qmake CONFIG+=static
68
61
69 Documentation
62 Documentation
70 =============
63 =============
71
64
72 Documentation can be found from doc/html and doc/qch directories. The documentation
65 The documentation can be generated with:
73 can also be generated with:
74 make docs
66 make docs
75
67
76 The documentation provided with Charts is generated with qdoc and the creation of the
68 The documentation is generated into the doc folder under the build folder.
77 documentation is prioritized for Qt5. We recommend building the documentation using Qt5,
69 Both Qt Assistant (qtcharts.qch) and in HTML format (qtcharts subfolder)
78 if you want to do it yourself. Creating the documentation using Qt4 also works, but some
70 documentation is generated.
79 pages are not generated correctly, such as the 'List of All Members' page for all C++ and
71
80 QML APIs in .qch documentation.
72 Please refer to the generated documentation for more information:
81
73 doc/qtcharts/index.html
82 Main Changes between 1.3.1 and 1.4.0
83 ====================================
84
85 - New: Added possibility to set brush image for AreaSeries, BarSet, BoxPlotSeries,
86 BoxSet, PieSlice and ScatterSeries by specifying 'brushFilename'
87 - New: Added possibility to show series point values for line, spline and scatter series
88 - New: Added possibility to position the bar value labels
89
90 Bug Fixes and minor new features
91 ================================
92
93 - New: Added count property for QBoxPlotSeries
94 - New: Added option to set markers in legend in reverse order
95 - New: Install the plugins.qmltypes file for Qt Quick 2 requested by Qt Creator
96 - New: Added clear function for BarCategoryAxis
97 - Fixed: Assert failure with percent bar series zero values
98 - Fixed: Updated files generated with Qt Creator for demos
99 - Fixed: DeclarativeChart::legend property marked as constant
100 - Fixed: Crash with ScatterChartItem mouse events
101 - Fixed: Build for iOS and for building the QtQuick2 plugin statically
102 - Fixed: Setting values for BarSet using Qt.point
103 - Fixed: Bar category rendering for empty category
104 - Fixed: QBoxSet color setting
105 - Fixed: Mouse event handling for pie
106 - Fixed: Legend truncation
107 - Fixed: Scatter series color
108 - Fixed: Crash in ChartDataSet::attachAxis()
109 - Fixed: Added missing library directory
110 - Fixed: Added Charts directory to include path
111 - Fixed: NOMINMAX definition
112
113 Known issues
114 ============
115
116 - Zooming too far or too close may eventually freeze the zooming and scrolling.
117 - Qt Quick 1 is not supported on iOS.
General Comments 0
You need to be logged in to leave comments. Login now