echarts_flutter_plus 0.0.1
echarts_flutter_plus: ^0.0.1 copied to clipboard
Flutter plugin for rendering Apache ECharts charts on web.
echarts_flutter_plus #
A Flutter plugin to seamlessly embed and display powerful Apache ECharts charts on Flutter Web.
Features #
- Full integration of Apache ECharts for Flutter Web.
- Supports rendering various chart types including line, bar, pie, sunburst, tree, and more.
- Pass any ECharts option JSON string to fully customize your charts.
- Handles asynchronous loading of the ECharts JavaScript library from CDN.
- Supports dynamic updates and chart reloads.
- Provides custom error handling with error widgets.
- Lightweight and easy to use Flutter widget.
Widget Props #
Parameter | Type | Description | Default |
---|---|---|---|
option |
String (required) |
JSON string of the ECharts option to render the chart | — |
width |
double |
Chart width in pixels | 400 |
height |
double |
Chart height in pixels | 300 |
theme |
String? |
Optional ECharts theme name | null |
enableLogger |
bool |
Print debug logs in browser console | false |
errorBuilder |
Widget Function(BuildContext, Object, StackTrace?)? |
Widget builder for displaying errors | null |
loadTimeoutSeconds |
int |
Seconds before ECharts load timeout triggers an error | 12 |
reload |
int |
Increment to force chart reload | 0 |
containerAttributes |
Map<String, String>? |
Extra HTML container attributes | null |
initOptions |
JSAny? |
Extra ECharts JS initialization options (advanced) | null |
Parameters and Settings #
A string containing the JSON configuration for the chart, based on the Apache ECharts documentation.
Getting Started #
Installation #
Add this to your pubspec.yaml
dependencies section:
dependencies:
echarts_flutter_plus: ^0.0.1
Now in your Dart code, you can use:
import 'package:echarts_flutter_plus/echarts_flutter_plus.dart';
Details see pub.dev.
Usage #
Import the package in your Dart code:
import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:echarts_flutter_plus/echarts_flutter_plus.dart';
final option = {
'xAxis': {
'type': 'category',
'data': ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],
},
'yAxis': {
'type': 'value',
},
'series': [
{
'type': 'line',
'data': [820, 932, 901, 934],
},
],
};
class SimpleChartDemo extends StatelessWidget {
const SimpleChartDemo({super.key});
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(title: Text('ECharts Demo')),
body: Center(
child: EChartsWebView(
option: jsonEncode(option),
width: 400,
height: 300,
),
),
);
}
}
Error Handling #
You can customize how errors are displayed by providing the errorBuilder
property:
EChartsWebView(
option: jsonEncode(yourOption),
errorBuilder: (context, error, stackTrace) {
return Center(child: Text('Error loading chart: $error'));
},
);
Development & Contribution #
Contributions, bug reports, and feature requests are welcome!
Please open issues or pull requests on GitHub repository.
Acknowledgments #
This plugin loads Apache ECharts, which is licensed under the Apache License 2.0.
If you use this plugin, you are also subject to the Apache 2.0 license for the ECharts library itself.
License #
This plugin is licensed under the MIT License.