ChartIQ-Android-SDK

Native Android SDK for the ChartIQ JavaScript library.

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.

Requirements

• A copy of the ChartIQ JavaScript library (works best with versions 9.6.0 or 9.8.0).

  • 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.

  • For previous JavaScript version support, please refer to the Releases section.

• Android 8.1 Oreo (API level 27) or later

Important: This SDK requires additional configuration to be able to work with the remote npm registry introduced in version 9.5.1.

Installation

Gradle

Add the Maven repository to your project-level build.gradle file:

allprojects {
    repositories {
// Other repositories
        mavenCentral()
    }
}

Add the library dependency to your app-level build.gradle file:

Groovy DSL (build.gradle)

dependencies {
    implementation 'io.github.chartiq:sdk:3.8.0'
}

Kotlin DSL (build.gradle.kts)

dependencies {
    implementation('io.github.chartiq:sdk:3.8.0')
}

App

The demo folder of this repository contains an app that was built using the SDK. Customize the app to quickly create your own Android charting application.

The app is also available on Google Play.

App screen shots

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 (which is compatible with ChartIQ versions 7.0.5–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.

End of ChartIQ feature upgrades As of ChartIQ version 8.8.0, only the single_page_demo demo will be updated with the latest ChartIQ features. tabs_demo will still be supported but not have the latest released features integrated into the demo.

Getting started

See the Getting Started on Mobile: Android tutorial for instructions on installing the app and using the SDK.

Customization

For information on changing the appearance of the app, see our customization tutorial.

API documentation

• App/SDK

• ChartIQ JavaScript library

Questions and support

Contact our development support team at support@chartiq.com.

Contributing to this project

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!

License

This project is licensed under the Apache-2.0 License - see the LICENSE.md file for details.

Publishing

This SDK is published to Maven Central using the new Central Publisher Portal. For detailed publishing instructions, see PUBLISHING.md.

Quick Publish

1. Set up Central Portal account at https://central.sonatype.com/
2. Configure credentials in gradle.properties
3. Run: ./gradlew publish