-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.md
123 lines (80 loc) · 4.63 KB
/
README.md
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# chart_engine
[](https://pub.dartlang.org/packages/chart_engine)
[](https://dart.dev/null-safety)
[](https://github.com/Colossus-Services/chart_engine/actions/workflows/dart.yml)
[](https://github.com/Colossus-Services/chart_engine/releases)
[](https://github.com/Colossus-Services/chart_engine/network)
[](https://github.com/Colossus-Services/chart_engine/commits/master)
[](https://github.com/Colossus-Services/chart_engine/pulls)
[](https://github.com/Colossus-Services/chart_engine)
[](https://github.com/Colossus-Services/chart_engine/blob/master/LICENSE)
[][live_example]
Chart generator with interchangeable chart engines, like ChartJS and ApexCharts.
## Engines
- [ApexCharts (v3.26.0)](https://apexcharts.com/).
- [ChartJS (v2.9.4)](https://www.chartjs.org/).
NOTE: You don't need to read any specific documentation of any engine to use `chart_engine`,
since any Chart configuration needed to generate your Chart will be
automatically handled by this package (see the [example][example]).
## Usage
A simple example using ApexCharts (ChartsJS is commented):
```dart
import 'dart:html';
//import 'package:chart_engine/chart_engine_chartjs.dart';
import 'package:chart_engine/chart_engine_apexcharts.dart';
void main() async {
var series = ChartSeries(
['Jan','Feb','Mar'],
{
'A': [10,20,5] ,
'B': [15,25,55] ,
'C': [100,130,140]
}
) ;
series.title = 'Chart Example' ;
series.xTitle = 'Months' ;
series.yTitle = 'Count' ;
series.options.fillLines = true ;
series.options.straightLines = true ;
//var charEngine = ChartEngineChartJS() ;
var charEngine = ChartEngineApexCharts() ;
await charEngine.load() ;
charEngine.renderLineChart( querySelector('#output') , series ) ;
}
```
## Live Example
You can see [here a live example][live_example]
[live_example]: https://colossus-services.github.io/chart_engine/example/www/
If your prefer you can experiment with the example from the source code.
## Example from Sources
Get the source
```
$> git clone https://github.com/Colossus-Services/chart_engine.git
```
...and see the [Web Example][example] (just follow the README file for instructions).
[example]: https://github.com/Colossus-Services/chart_engine/tree/master/example
## Loading Engines JavaScript Libraries
This Dart package already bundles the JavaScript libraries of each supported engine.
When an implementation of `ChartEngine` is instantiated, the corresponding JavaScript library is automatically loaded
and no extra code is needed in your Dart files or HTML files.
The loading processes is made by the package [amdjs.dart][amdjs.dart]. It loads
the JavaScript libraries using AMD framework when an AMD implementation is present and detected,
or injecting a tag ```<script src='lib-x.js'></script>``` as fallback.
[amdjs.dart]: https://github.com/gmpassos/amdjs.dart
## ChartJS and Moment
You don't need to load Moment JS library to use Time Series Charts when using ChartJS engine.
We implement a fallback Date adapter, using Dart code interoperability,
based in Dart DateTime and DateFormat implementations. ;-P
## Features and bugs
Please file feature requests and bugs at the [issue tracker][tracker].
[tracker]: https://github.com/Colossus-Services/chart_engine/issues
## Colossus.Services
This is an open-source project from [Colossus.Services][colossus]:
the gateway for smooth solutions.
[colossus]: https://colossus.services/
## Author
Graciliano M. Passos: [gmpassos@GitHub][gmpassos_github].
[gmpassos_github]: https://github.com/gmpassos
## License
[Apache License - Version 2.0][apache_license]
[apache_license]: https://www.apache.org/licenses/LICENSE-2.0.txt