##// END OF EJS Templates
updated README
sauimone -
r1665:279ec664ffed
parent child
Show More
@@ -1,99 +1,79
1 --------------------------------
1 --------------------------------
2 Commercial Charts Add-on Beta
2 Commercial Charts Add-on 1.0.0
3 --------------------------------
3 --------------------------------
4
4
5 Whats in Qt Commercial Charts
5 Whats in Qt Commercial Charts
6 =============================
6 =============================
7
7
8 Directory structure:
8 Directory structure:
9
9
10 src/
10 src/
11 Source code of the Qt Commercial Charts
11 Source code of the Qt Commercial Charts
12 plugins/
12 plugins/
13 QML bindings plugin and QtCreator plugin
13 QML bindings plugin and QtCreator plugin
14 examples/
14 examples/
15 Some examples of using Qt Commercial Charts
15 Some examples of using Qt Commercial Charts
16 demos/
16 demos/
17 More versatile example applications showing how to customize charts,
17 More versatile example applications showing how to customize charts,
18 combine several chart types and implement interaction in charts
18 combine several chart types and implement interaction in charts
19 doc/
19 doc/
20 Documentation
20 Documentation
21 licenses/
21 licenses/
22 Licensing infromation
22 Licensing infromation
23
23
24 Building
24 Building
25 ========
25 ========
26
26
27 Configure project with qmake. On Windows by default both debug and release
27 Configure project with qmake. On Windows by default both debug and release
28 versions are built. On other platforms you need to specify the version
28 versions are built. On other platforms you need to specify the version
29 (default is debug):
29 (default is debug):
30 (Windows) qmake
30 (Windows) qmake
31 (Other platforms) qmake CONFIG+=release
31 (Other platforms) qmake CONFIG+=release
32
32
33 Build poject with make:
33 Build poject with make:
34 (Linux) make
34 (Linux) make
35 (Windows with MinGw) mingw32-make
35 (Windows with MinGw) mingw32-make
36 (Visual Studio) nmake
36 (Visual Studio) nmake
37 (OSX) make
37 (OSX) make
38
38
39 If you want to install the libraries to your Qt library directory use:
39 If you want to install the libraries to your Qt library directory use:
40 make install
40 make install
41
41
42 If you want to uninstall the libraries
42 If you want to uninstall the libraries
43 make uninstall
43 make uninstall
44
44
45 Building as a statically linked library
45 Building as a statically linked library
46 =======================================
46 =======================================
47
47
48 The same as above applies you will just have to add staticlib to the CONFIG:
48 The same as above applies you will just have to add staticlib to the CONFIG:
49 qmake CONFIG+=staticlib
49 qmake CONFIG+=staticlib
50
50
51 Documentation
51 Documentation
52 =============
52 =============
53 Documentation can be found from doc/html directory.
53
54
54 The documentation can be generated with "make docs". It will be placed
55 The documentation can also be generated with "make docs".
55 into "doc/html" in the build directory.
56
56
57 KNOWN ISSUES
57 KNOWN ISSUES
58 ============
58 ============
59 * The beta version of Qt Commercial Charts is still under development and thus
60 should not be used in e.g. product development
61 * The Charts API might change between the Beta and the first official release
62 * Mutliple axis are not suported at the moment.
63 * Logartmic, polar axis are not supported at the moment.
59 * Logartmic, polar axis are not supported at the moment.
64 * If using QAbstractiItemModel derived model with QBarSeries, data manipulation
65 with QBarSeries/QBarSet APIs does not synchronize the data into the model
66 * Model support requires more thorough testing.
67 * Some QObject properties are missing
68 * Some notifications missing from QObject properties
69 * Legend layout does not work correctly with several labels
70 * Animations with Bar Charts can cause crashes in certain situations
71 * Automatic scaling of the axes is only done when you add a series on a chart
60 * Automatic scaling of the axes is only done when you add a series on a chart
72 * The QML Bindings are still under development
73 * Mouse and touch interactions not complete on the QML API
74 * Missing documentation for QML API; the QML demo applications serve as
75 documentation instead
76 * Setting bar width is not possible on QBarSeries derived classes (the width
77 is affected with setMargin, but it has limitations)
78 * API for Animations state (signaling started, finished) and setting duration
61 * API for Animations state (signaling started, finished) and setting duration
79 etc. is missing
62 etc. is missing
80 * In QBarSeries API bar margin related methods will be replaced with bar width
63 * Layout in QBarCategoriesAxis can cause categories to overlap
81 in final release
64 * Only one Y and X axis can be visible at the same time
82 * OSX specific issue: after running 'make install' you need to fix the library
65 * Unit label for axes is not implemented
83 location of libQtCommercialChart.1.dylib to match the actual installation
66 * In some cases (e.g. long texts) can cause some issues with layout
84 path. For example:
67 * When setting new QBarCategoriesAxis to existing chart, axis doesn't initialise properly
85 sudo install_name_tool -id
68
86 /usr/local/Trolltech/Qt-4.8.0/lib/libQtCommercialChart.1.dylib
69 Main Changes between Beta and Final
87 /usr/local/Trolltech/Qt-4.8.0/lib/libQtCommercialChart.1.dylib
70 ===================================
71 * QML examples and documentation has been added
72 * Axis implementation has been refactored in order to support more flexible axis schemes in future.
73 * Setting Multiple axes is now possible and you can select which one is visible.
74 * In future it's possible to display several axes at the same time.
75 * QBarCategoriesAxis and QValuesAxis classes have been added.
76 * QBarSeries change to QGroupedBarSeries introduced in Beta has been reverted.
77 * �Getting Started� documentation has been added.
78 * Chart layout management has been refactored.
88
79
89 Main changes between Technology Preview and Beta release
90 ========================================================
91 * QBarSeries now enables defining both values and bar placement in X-Axis.
92 Previous implementation of QBarSeries is now new series type:
93 QGroupedBarSeries
94 * QML API now defined and mostly implemented
95 * Q_PROPERTY definitions have been added to the API
96 * Model API  refactored and moved from Series Classes to separate Model
97 Mapper Classes
98 * First version of Qt Designer plugin included
99 * Example for handling Gestures included (ZoomLineChart example)
General Comments 0
You need to be logged in to leave comments. Login now