summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorsauimone <samu.uimonen@digia.com>2012-07-05 12:15:46 +0300
committersauimone <samu.uimonen@digia.com>2012-07-05 12:15:46 +0300
commit279ec664ffede403ab9c945710adbbf05ed01561 (patch)
treed5ae656bfb87e9141ffe29e2faeddca979092d8c /README
parent8fb25c9f2d873e687c5def7e7cd908f537401922 (diff)
updated README
Diffstat (limited to 'README')
-rw-r--r--README60
1 files changed, 20 insertions, 40 deletions
diff --git a/README b/README
index 0d39b63b..1fc80575 100644
--- a/README
+++ b/README
@@ -1,8 +1,8 @@
--------------------------------
-Commercial Charts Add-on Beta
+Commercial Charts Add-on 1.0.0
--------------------------------
-Whats in Qt Commercial Charts
+What’s in Qt Commercial Charts
=============================
Directory structure:
@@ -50,50 +50,30 @@ The same as above applies you will just have to add staticlib to the CONFIG:
Documentation
=============
+Documentation can be found from doc/html directory.
-The documentation can be generated with "make docs". It will be placed
-into "doc/html" in the build directory.
+The documentation can also be generated with "make docs".
KNOWN ISSUES
============
-* The beta version of Qt Commercial Charts is still under development and thus
- should not be used in e.g. product development
-* The Charts API might change between the Beta and the first official release
-* Mutliple axis are not suported at the moment.
* Logartmic, polar axis are not supported at the moment.
-* If using QAbstractiItemModel derived model with QBarSeries, data manipulation
- with QBarSeries/QBarSet APIs does not synchronize the data into the model
-* Model support requires more thorough testing.
-* Some QObject properties are missing
-* Some notifications missing from QObject properties
-* Legend layout does not work correctly with several labels
-* Animations with Bar Charts can cause crashes in certain situations
* Automatic scaling of the axes is only done when you add a series on a chart
-* The QML Bindings are still under development
-* Mouse and touch interactions not complete on the QML API
-* Missing documentation for QML API; the QML demo applications serve as
- documentation instead
-* Setting bar width is not possible on QBarSeries derived classes (the width
- is affected with setMargin, but it has limitations)
* API for Animations state (signaling started, finished) and setting duration
etc. is missing
-* In QBarSeries API bar margin related methods will be replaced with bar width
- in final release
-* OSX specific issue: after running 'make install' you need to fix the library
- location of libQtCommercialChart.1.dylib to match the actual installation
- path. For example:
- sudo install_name_tool -id
- /usr/local/Trolltech/Qt-4.8.0/lib/libQtCommercialChart.1.dylib
- /usr/local/Trolltech/Qt-4.8.0/lib/libQtCommercialChart.1.dylib
+* Layout in QBarCategoriesAxis can cause categories to overlap
+* Only one Y and X axis can be visible at the same time
+* Unit label for axes is not implemented
+* In some cases (e.g. long texts) can cause some issues with layout
+* When setting new QBarCategoriesAxis to existing chart, axis doesn't initialise properly
+
+Main Changes between Beta and Final
+===================================
+* QML examples and documentation has been added
+* Axis implementation has been refactored in order to support more flexible axis schemes in future.
+* Setting Multiple axes is now possible and you can select which one is visible.
+* In future it's possible to display several axes at the same time.
+* QBarCategoriesAxis and QValuesAxis classes have been added.
+* QBarSeries change to QGroupedBarSeries introduced in Beta has been reverted.
+* “Getting Started” documentation has been added.
+* Chart layout management has been refactored.
-Main changes between Technology Preview and Beta release
-========================================================
-* QBarSeries now enables defining both values and bar placement in X-Axis.
- Previous implementation of QBarSeries is now new series type:
- QGroupedBarSeries
-* QML API now defined and mostly implemented
-* Q_PROPERTY definitions have been added to the API
-* Model API&nbsp; refactored and moved from Series Classes to separate Model
- Mapper Classes
-* First version of Qt Designer plugin included
-* Example for handling Gestures included (ZoomLineChart example)