Lightweight-charts-android

The Android Lightweight Charts is an Android wrapper of the TradingView Lightweight Charts library.

Requirements

• minSdkVersion 23
• Installed Android System WebView or Chrome WebView provider with ES2020 support. Lightweight Charts 5.x is ESM/ES2020-only.

Build notes

• The Gradle build publishes only the release library variant.
• gradle.properties contains Android Gradle Plugin compatibility opt-outs that preserve legacy wrapper behavior during the AGP 9 migration.
• The library asset merge tasks run :lightweightlibrary:npmBuild, which uses npm ci when lightweightlibrary/package-lock.json is present and rebuilds the JavaScript bridge bundles from lightweightlibrary/lib.

v5 Compatibility Notes

• TimeScaleApi.coordinateToLogical(...) and MouseEventParams.logical keep the v4 integer logical-index shape. Use coordinateToLogicalFloat(...) and MouseEventParams.logicalFloat when you need the fractional logical indexes exposed by Lightweight Charts 5.x.

How to use

In /build.gradle

allprojects {
    repositories {
        google()
        mavenCentral()
    }
}

In /gradle_module/build.gradle

dependencies {
    //...
    implementation 'com.tradingview:lightweightcharts:5.2.0'
}

The wrapper keeps the existing v4-shaped helpers where possible and adds v5-native APIs for unified addSeries, multiple panes, marker primitives, text/image watermarks, price-scale ranges, logical ranges, double-click events, screenshot top-layer options, and conflation-related options. Custom plugin authoring wrappers are intentionally not exposed yet.

Add view to the layout.

<androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent">

        <com.tradingview.lightweightcharts.view.ChartsView
            android:id="@+id/charts_view"
            android:layout_width="0dp"
            android:layout_height="0dp"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toRightOf="parent"
            app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

Configure the chart layout.

charts_view.api.applyOptions {
    layout = layoutOptions {
        background = SolidColor(Color.LTGRAY.toIntColor())
        textColor = Color.BLACK.toIntColor()
    }
    localization = localizationOptions {
        locale = "ru-RU"
        priceFormatter = PriceFormatter(template = "{price:#2:#3}$")
        timeFormatter = TimeFormatter(
            locale = "ru-RU",
            dateTimeFormat = DateTimeFormat.DATE_TIME
        )
    }
}

Add any series to the chart and store a reference to it.

lateinit var histogramSeries: SeriesApi
charts_view.api.addHistogramSeries(
    onSeriesCreated = { series ->
        histogramSeries = series
    }
)

Add data to the series.

val data = listOf(
    HistogramData(Time.BusinessDay(2019, 6, 11), 40.01f),
    HistogramData(Time.BusinessDay(2019, 6, 12), 52.38f),
    HistogramData(Time.BusinessDay(2019, 6, 13), 36.30f),
    HistogramData(Time.BusinessDay(2019, 6, 14), 34.48f),
    WhitespaceData(Time.BusinessDay(2019, 6, 15)),
    WhitespaceData(Time.BusinessDay(2019, 6, 16)),
    HistogramData(Time.BusinessDay(2019, 6, 17), 41.50f),
    HistogramData(Time.BusinessDay(2019, 6, 18), 34.82f)
)
histogramSeries.setData(data)

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at LICENSE file. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This software incorporates several parts of tslib (https://github.com/Microsoft/tslib, (c) Microsoft Corporation) that are covered by the Apache License, Version 2.0.

This license requires specifying TradingView as the product creator. You shall add the "attribution notice" from the NOTICE file and a link to https://www.tradingview.com/ to the page of your website or mobile application that is available to your users. As thanks for creating this product, we'd be grateful if you add it in a prominent place.