ChartIQ-Flutter-SDK
Flutter SDK for the ChartIQ JavaScript library.
The ChartIQ Flutter SDK supports a basic charting application. The SDK can be extended to support more elaborate implementations by adding code to invoke ChartIQ library functions directly or by creating a bridge file similar to nativeSdkBridge.js (in the mobile/js folder of your ChartIQ library).
Contact us at support@chartiq.com to request sample code and guidance on how to extend the SDK.
Requirements
-
A copy of the ChartIQ JavaScript library (works best with version 9.1.2).
- If you do not have a copy of the library or need a different version, please contact your account manager or visit our Request Follow-Up Site.
-
Flutter 3.10.6 or later
-
Dart 3.0.6 or later
-
Android 8.1 Oreo (API level 27) or later
-
iOS 10.3 or later
App
The example folder of this repository contains both Android and iOS app that was built using the SDK. Customize the apps to quickly create your own Flutter charting application.
App screen shots
Getting started
With Flutter:
$ flutter pub add chart_iq
This will add a line to your package's pubspec.yaml (and run an implicit flutter pub get).
Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:chart_iq/chart_iq.dart';
ChartIQView(
chartIQUrl: _chartIQUrl, // url to ChartIQ library
onPullInitialData: (dataCallback) {
// Provide initial data for chart
},
onPullUpdateData: (dataCallback) {
// Provide update data for chart
},
onPullPaginationData: (dataCallback) {
// Provide pagination data for chart
},
onChartIQViewCreated: (controller) {
// ChartIQView created and ready to use
},
)
IOS installation additional step
Go to the example/ios folder and run pod install
cd example/ios
pod install
API documentation
The Flutter sdk utilizes the existing mobile sdk that we have to offer.
Questions and support
Contact our development support team at support@chartiq.com.
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
Apache2