Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
# ChartIQ-Android-SDK

Native Android SDK for the [ChartIQ JavaScript library](https://documentation.chartiq.com).

This SDK has been designed to support a basic application and may need to be extended to support more elaborate implementations. This can be done by adding additional code to invoke JavaScript functions directly. Feel free to contact us and request sample code and guidance on how to extend the SDK.
The ChartIQ Android 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.

**End of legacy app support**

The Android app has been totally reengineered for improved usability and functionality using Kotlin. As a result, there is no upgrade path from the [legacy app](https://github.com/ChartIQ/Charting-Library---Android-Sample-App-Legacy) (which is compatible with ChartIQ versions 7.0.5&ndash;7.5.0) to the new app/SDK. To take advantage of the major improvements offered by the new mobile app, upgrade to Version 8.2.0 or later of the library and reimplement any custom functionality from your legacy app in the new app.

## Requirements

- Version 8.2.0+ of the ChartIQ library.
Version 8.2.0 or later of the ChartIQ library.

Please contact info@cosaic.io if you do not already have a license or evaluation version of the library.
Go to our <a href="https://cosaic.io/chartiq-sdk-library-download/" target="_blank">download site</a> to obtain a free 30-day trial version of the library, or send us an email at <info@cosaic.io>, and we'll send you an evaluation version.

## Sample app

A sample app using this SDK can be found in this repository. Just open the Android project in Android Studio and locate the demo folder.
The [demo](https://github.com/ChartIQ/ChartIQ-Android-SDK/tree/main/demo) folder of this repository contains a sample app that was built using the SDK. Customize the app to quickly create your own Android charting application.

## Questions and support

- Our development support team can be reached at [support@chartiq.com](mailto:support@chartiq.com).
- Our JavaScript documentation can be found at https://documentation.chartiq.com
Contact our development support team at <support@chartiq.com>.

See our JavaScript documentation at https://documentation.chartiq.com.

## Contributing to this project

If you wish to contribute to this project please fork it and send us a pull request.
We'd love to see what it is you want to do with our charting tools!
Contribute to this project. Fork it and send us a pull request. We'd love to see what you can do with our charting tools on Android!