summaryrefslogtreecommitdiffstats
path: root/README
blob: 1fc80575725a68a357d94578409eb1d4513f8add (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
--------------------------------
Commercial Charts Add-on 1.0.0
--------------------------------

What’s in Qt Commercial Charts
=============================

Directory structure:

src/
    Source code of the Qt Commercial Charts
plugins/
    QML bindings plugin and QtCreator plugin
examples/
    Some examples of using Qt Commercial Charts
demos/
    More versatile example applications showing how to customize charts,
    combine several chart types and implement interaction in charts
doc/
    Documentation
licenses/
    Licensing infromation

Building
========

Configure project with qmake. On Windows by default both debug and release
versions are built. On other platforms you need to specify the version
(default is debug):
    (Windows) qmake
    (Other platforms) qmake CONFIG+=release

Build poject with make:
    (Linux) make
    (Windows with MinGw) mingw32-make
    (Visual Studio) nmake
    (OSX) make

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

If you want to uninstall the libraries
    make uninstall

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

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

Documentation
=============
Documentation can be found from doc/html directory.

The documentation can also be generated with "make docs".

KNOWN ISSUES
============
* Logartmic, polar axis are not supported at the moment.
* Automatic scaling of the axes is only done when you add a series on a chart
* API for Animations state (signaling started, finished) and setting duration
  etc. is missing
* 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.