Giter Site home page Giter Site logo

compose-multiplatform-charts's Introduction

Compose multiplatform charts

Charts for Kotlin Multiplatform projects

Library contains several chart composables for usage in Kotlin Multiplatform projects. Currently supported platforms are Desktop and Android.

Brought with  ❤️ by   Netguru logo

Installation

Using local build

Go to charts folder and run assemble[Debug|Release]. This results in an aar file which can then be copied/imported to your project as any other aar artifact.

Using maven dependency

TBA

Usage

The library provides following components:

Most of the components have arguments like:

  • data - depends on chart type it's complex dataset or few primitives arguments
  • colors - gives the possibility to change colors of the chart. In some cases the colors are stored in datasets (like in BarChart or LineChart). See theming section to set same appearance to all charts.
  • config - allows to personalize charts. Depends on chart type it can modify different parts of component. See documentation of specific chart
  • animation - the way how chart should appear at the first time

BarChart

Bar chart

Before using component the BarChartData has to be prepared:

val barChartData = BarChartData(
    categories = listOf(
        BarChartCategory(
            name = "Bar Chart 1",
            entries = listOf(
                BarChartEntry(
                    x = "primary",
                    y = 17f,
                    color = Color.Yellow,
                ),
                BarChartEntry(
                    x = "secondary",
                    y = 30f,
                    color = Color.Red,
                ),
            )
        ),
        BarChartCategory(
            name = "Bar Chart 2",
            entries = listOf(
                BarChartEntry(
                    x = "primary",
                    y = -5f,
                    color = Color.Yellow,
                ),
                BarChartEntry(
                    x = "secondary",
                    y = -24f,
                    color = Color.Red,
                ),
            )
        ),
    )
)
BarChart(
    data = barChartData,
    config = BarChartConfig(
        thickness = 14.dp,
        cornerRadius = 7.dp,
    ),
    modifier = Modifier.height(500.dp),
    animation = ChartAnimation.Sequenced(),
)

There is another component called BarChartWithLegend. It renders bar chart with legend.

BubbleChart

Bubble chart

Before using component the list of Bubble has to be prepared:

val bubbles = listOf(
    Bubble(
        name = "first",
        value = 1.2f,
        icon = Icons.Default.Album,
        color = Color.Yellow
    ),
    Bubble(
        name = "second",
        value = 4.6f,
        icon = Icons.Default.House,
        color = Color.Green
    ),
    Bubble(
        name = "third",
        value = 6.9f,
        icon = Icons.Default.Bed,
        color = Color.Blue
    ),
)
BubbleChart(
    bubbles = bubbles,
    modifier = Modifier.size(300.dp),
    animation = ChartAnimation.Sequenced(),
)

Dial

Dial chart

Dial(
    value = 22,
    minValue = -20,
    maxValue = 50,
    modifier = Modifier.fillMaxWidth(),
    animation = ChartAnimation.Simple {
        spring(
            dampingRatio = Spring.DampingRatioMediumBouncy,
            stiffness = Spring.StiffnessLow
        )
    },
    config = DialConfig(
        thickness = 20.dp,
        roundCorners = true,
    ),
    mainLabel = {
        Column(
            horizontalAlignment = Alignment.CenterHorizontally
        ) {
            Text(
                text = "$it°C",
                style = MaterialTheme.typography.h4,
                color = Color.Yellow
            )
            Text(
                text = "outside temperature",
                style = MaterialTheme.typography.body2,
                modifier = Modifier.padding(top = 12.dp)
            )
        }
    }
)

There is another component ProcentageDial. It accepts only one data argument percentage in [0-100] range.

GasBottle

Gas bottle chart

GasBottle(
    percentage = 75f,
    modifier = Modifier.size(width = 200.dp, height = 300.dp),
    animation = ChartAnimation.Simple {
        spring(
            dampingRatio = Spring.DampingRatioMediumBouncy,
            stiffness = Spring.StiffnessVeryLow
        )
    }
)

LineChart

Line chart

Before using component the LineChartData has to be prepared:

val lineData = remember {
    LineChartData(
        series = (1..3).map {
            LineChartSeries(
                dataName = "data $it",
                lineColor = listOf(
                    Color.Yellow,
                    Color.Red,
                    Color.Blue,
                )[it - 1],
                listOfPoints = (1..10).map { point ->
                    LineChartPoint(
                        x = DateTime.now().minus(TimeSpan(point * 24 * 60 * 60 * 1000.0)).unixMillisLong,
                        y = (1..15).random().toFloat(),
                    )
                }
            )
        },
    )
}
LineChart(
    lineChartData = lineData,
    modifier = Modifier.height(300.dp),
    xAxisLabel = {
        Text(
            fontSize = 12.sp,
            text = DateTime.fromUnix(it as Long).format("yyyy-MM-dd"),
            textAlign = TextAlign.Center
        )
    },
    overlayHeaderLabel = {
        Text(
            text = DateTime.fromUnix(it as Long).format("yyyy-MM-dd"),
            style = MaterialTheme.typography.overline
        )
    },
    animation = ChartAnimation.Sequenced()
)

PieChart

Line chart

Before using component the list of PieChartData has to be prepared:

val data = listOf(
    PieChartData(
        name = "Data 1",
        value = 10.0,
        color = Color.Yellow,
    ),
    PieChartData(
        name = "Data 2",
        value = 20.0,
        color = Color.Green,
    ),
    PieChartData(
        name = "Data 3",
        value = 30.0,
        color = Color.Blue,
    ),
    PieChartData(
        name = "Data 4",
        value = 40.0,
        color = Color.Red,
    )
)
PieChart(
    data = data,
    modifier = Modifier.size(300.dp),
    config = PieChartConfig(
        thickness = 40.dp
    ),
)

By default the thickness is Dp.Infinity, it means the chart will be fully filled.

Theming

The easiest way to set the same colors for all charts is to provide ChartColors in the app theme.

private val chartColors = ChartColors(
    primary = Color.Green,
    grid = Color.LightGray,
    surface = Color.White,
    fullGasBottle = Color.Green,
    emptyGasBottle = Color.Red,
    overlayLine = Color.Magenta
)

@Composable
fun AppTheme(
    darkTheme: Boolean = isSystemInDarkTheme(),
    content: @Composable () -> Unit,
) {
    CompositionLocalProvider(
        // ...
        LocalChartColors provides chartColors,
    ) {
        MaterialTheme(
            // ...
            content = content,
        )
    }
}

There is also default ChartColors provided by the library. It uses the default color set from MaterialTheme.

LocalChartColors provides ChartDefaults.chartColors()

Each chart has its own color set which can be used like:

BarChart(
    data = barChartData,
    colors = BarChartColors(grid = Color.LightGray)
)

Also there is possibility to use ChartColors inside the specific chart:

BarChart(
    data = barChartData,
    colors = ChartColors(...).barChartColors,
)

Security Issues

Reporting Security Vulnerabilities

Contributing

Contributing guidelines

License

This library is available as open source under the terms of the MIT License.

compose-multiplatform-charts's People

Contributors

bpedryc avatar eziosoft avatar mateusz-suchowiecki avatar primoz-ivancic-ng avatar tarapaty avatar ynsok avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

compose-multiplatform-charts's Issues

Publish to Maven Central?

This is a great library! Why don't you publish to maven central to let people try it more conveniently? The process is not complicated.

Cannot import aar in common main

Hi added .aar in libs folder inside src of common main and added it in sourcesets

sourceSets {
val commonMain by getting {
dependencies {
implementation(compose.runtime)
implementation(compose.foundation)
implementation(compose.material)
implementation(compose.materialIconsExtended)
@OptIn(org.jetbrains.compose.ExperimentalComposeLibrary::class)
implementation(compose.components.resources)
implementation(files("./src/libs/charts-debug.aar"))

        }
    }

Still impossible to call it. is it normal?

Offset is unspecified

Kotlin: 1.9.20
Compose: compose-bom:2023.10.01
Android Studio Giraffe | 2022.3.1 Patch 4
Build #AI-223.8836.35.2231.11090377, built on November 14, 2023
FATAL EXCEPTION: main
java.lang.IllegalStateException: Offset is unspecified
        at androidx.compose.ui.geometry.Offset.getX-impl(Offset.kt:67)
        at com.netguru.multiplatform.charts.pie.PieChartKt.findNextGapPoint-0AR0LA0(PieChart.kt:180)
        at com.netguru.multiplatform.charts.pie.PieChartKt.calculateClipPath(PieChart.kt:155)
        at com.netguru.multiplatform.charts.pie.PieChartKt.access$calculateClipPath(PieChart.kt:1)
        at com.netguru.multiplatform.charts.pie.PieChartKt$PieChart$1.invoke(PieChart.kt:87)
        at com.netguru.multiplatform.charts.pie.PieChartKt$PieChart$1.invoke(PieChart.kt:86)
        at androidx.compose.ui.draw.DrawBackgroundModifier.draw(DrawModifier.kt:116)
        at androidx.compose.ui.node.LayoutNodeDrawScope.drawDirect-x_KDEd0$ui_release(LayoutNodeDrawScope.kt:105)
        at androidx.compose.ui.node.LayoutNodeDrawScope.draw-x_KDEd0$ui_release(LayoutNodeDrawScope.kt:86)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:365)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutModifierNodeCoordinator.performDraw(LayoutModifierNodeCoordinator.kt:182)
        at androidx.compose.ui.node.LayoutNodeDrawScope.drawContent(LayoutNodeDrawScope.kt:66)
        at androidx.compose.foundation.BackgroundNode.draw(Background.kt:155)
        at androidx.compose.ui.node.LayoutNodeDrawScope.drawDirect-x_KDEd0$ui_release(LayoutNodeDrawScope.kt:105)
        at androidx.compose.ui.node.LayoutNodeDrawScope.draw-x_KDEd0$ui_release(LayoutNodeDrawScope.kt:86)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:365)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:922)
        at androidx.compose.ui.node.InnerNodeCoordinator.performDraw(InnerNodeCoordinator.kt:174)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:922)
        at androidx.compose.ui.node.InnerNodeCoordinator.performDraw(InnerNodeCoordinator.kt:174)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.access$drawContainedDrawModifiers(NodeCoordinator.kt:54)
        at androidx.compose.ui.node.NodeCoordinator$invoke$1.invoke(NodeCoordinator.kt:384)
        at androidx.compose.ui.node.NodeCoordinator$invoke$1.invoke(NodeCoordinator.kt:383)
        at androidx.compose.runtime.snapshots.Snapshot$Companion.observe(Snapshot.kt:2299)
        at androidx.compose.runtime.snapshots.SnapshotStateObserver$ObservedScopeMap.observe(SnapshotStateObserver.kt:467)
        at androidx.compose.runtime.snapshots.SnapshotStateObserver.observeReads(SnapshotStateObserver.kt:230)
        at androidx.compose.ui.node.OwnerSnapshotObserver.observeReads$ui_release(OwnerSnapshotObserver.kt:133)
        at androidx.compose.ui.node.NodeCoordinator.invoke(NodeCoordinator.kt:383)
        at androidx.compose.ui.node.NodeCoordinator.invoke(NodeCoordinator.kt:54)
        at androidx.compose.ui.platform.RenderNodeApi29.record(RenderNodeApi29.android.kt:209)
        at androidx.compose.ui.platform.RenderNodeLayer.updateDisplayList(RenderNodeLayer.android.kt:305)
        at androidx.compose.ui.platform.RenderNodeLayer.drawLayer(RenderNodeLayer.android.kt:246)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:349)
        at androidx.compose.ui.node.LayoutModifierNodeCoordinator.performDraw(LayoutModifierNodeCoordinator.kt:182)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutModifierNodeCoordinator.performDraw(LayoutModifierNodeCoordinator.kt:182)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:922)
        at androidx.compose.ui.node.InnerNodeCoordinator.performDraw(InnerNodeCoordinator.kt:174)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutModifierNodeCoordinator.performDraw(LayoutModifierNodeCoordinator.kt:182)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.access$drawContainedDrawModifiers(NodeCoordinator.kt:54)
        at androidx.compose.ui.node.NodeCoordinator$invoke$1.invoke(NodeCoordinator.kt:384)
        at androidx.compose.ui.node.NodeCoordinator$invoke$1.invoke(NodeCoordinator.kt:383)
        at androidx.compose.runtime.snapshots.Snapshot$Companion.observe(Snapshot.kt:2299)
        at androidx.compose.runtime.snapshots.SnapshotStateObserver$ObservedScopeMap.observe(SnapshotStateObserver.kt:467)
        at androidx.compose.runtime.snapshots.SnapshotStateObserver.observeReads(SnapshotStateObserver.kt:230)
        at androidx.compose.ui.node.OwnerSnapshotObserver.observeReads$ui_release(OwnerSnapshotObserver.kt:133)
        at androidx.compose.ui.node.NodeCoordinator.invoke(NodeCoordinator.kt:383)
        at androidx.compose.ui.node.NodeCoordinator.invoke(NodeCoordinator.kt:54)
        at androidx.compose.ui.platform.RenderNodeApi29.record(RenderNodeApi29.android.kt:209)
        at androidx.compose.ui.platform.RenderNodeLayer.updateDisplayList(RenderNodeLayer.android.kt:305)
        at androidx.compose.ui.platform.RenderNodeLayer.drawLayer(RenderNodeLayer.android.kt:246)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:349)
        at androidx.compose.ui.node.LayoutModifierNodeCoordinator.performDraw(LayoutModifierNodeCoordinator.kt:182)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutModifierNodeCoordinator.performDraw(LayoutModifierNodeCoordinator.kt:182)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:922)
        at androidx.compose.ui.node.InnerNodeCoordinator.performDraw(InnerNodeCoordinator.kt:174)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.draw(NodeCoordinator.kt:354)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:922)
        at androidx.compose.ui.node.InnerNodeCoordinator.performDraw(InnerNodeCoordinator.kt:174)
        at androidx.compose.ui.node.NodeCoordinator.drawContainedDrawModifiers(NodeCoordinator.kt:362)
        at androidx.compose.ui.node.NodeCoordinator.access$drawContainedDrawModifiers(NodeCoordinator.kt:54)
        at androidx.compose.ui.node.NodeCoordinator$invoke$1.invoke(NodeCoordinator.kt:384)
        at androidx.compose.ui.node.NodeCoordinator$invoke$1.invoke(NodeCoordinator.kt:383)
        at androidx.compose.runtime.snapshots.Snapshot$Companion.observe(Snapshot.kt:2299)
        at androidx.compose.runtime.snapshots.SnapshotStateObserver$ObservedScopeMap.observe(SnapshotStateObserver.kt:467)
        at androidx.compose.runtime.snapshots.SnapshotStateObserver.observeReads(SnapshotStateObserver.kt:230)
        at androidx.compose.ui.node.OwnerSnapshotObserver.observeReads$ui_release(OwnerSnapshotObserver.kt:133)
        at androidx.compose.ui.node.NodeCoordinator.invoke(NodeCoordinator.kt:383)
        at androidx.compose.ui.node.NodeCoordinator.invoke(NodeCoordinator.kt:54)
        at androidx.compose.ui.platform.RenderNodeApi29.record(RenderNodeApi29.android.kt:209)
        at androidx.compose.ui.platform.RenderNodeLayer.updateDisplayList(RenderNodeLayer.android.kt:305)
        at androidx.compose.ui.platform.AndroidComposeView.dispatchDraw(AndroidComposeView.android.kt:1138)
        at android.view.View.draw(View.java:23892)
        at android.view.View.updateDisplayListIfDirty(View.java:22756)
        at android.view.ViewGroup.recreateChildDisplayList(ViewGroup.java:4540)
        at android.view.ViewGroup.dispatchGetDisplayList(ViewGroup.java:4513)
        at android.view.View.updateDisplayListIfDirty(View.java:22712)
        at android.view.ViewGroup.recreateChildDisplayList(ViewGroup.java:4540)
        at android.view.ViewGroup.dispatchGetDisplayList(ViewGroup.java:4513)
        at android.view.View.updateDisplayListIfDirty(View.java:22712)
        at android.view.ViewGroup.recreateChildDisplayList(ViewGroup.java:4540)
        at android.view.ViewGroup.dispatchGetDisplayList(ViewGroup.java:4513)
        at android.view.View.updateDisplayListIfDirty(View.java:22712)
        at android.view.ViewGroup.recreateChildDisplayList(ViewGroup.java:4540)
        at android.view.ViewGroup.dispatchGetDisplayList(ViewGroup.java:4513)
        at android.view.View.updateDisplayListIfDirty(View.java:22712)
        at android.view.ThreadedRenderer.updateViewTreeDisplayList(ThreadedRenderer.java:694)
        at android.view.ThreadedRenderer.updateRootDisplayList(ThreadedRenderer.java:700)
        at android.view.ThreadedRenderer.draw(ThreadedRenderer.java:798)
        at android.view.ViewRootImpl.draw(ViewRootImpl.java:4939)
        at android.view.ViewRootImpl.performDraw(ViewRootImpl.java:4643)
        at android.view.ViewRootImpl.performTraversals(ViewRootImpl.java:3822)
        at android.view.ViewRootImpl.doTraversal(ViewRootImpl.java:2465)
        at android.view.ViewRootImpl$TraversalRunnable.run(ViewRootImpl.java:9305)
        at android.view.Choreographer$CallbackRecord.run(Choreographer.java:1339)
        at android.view.Choreographer$CallbackRecord.run(Choreographer.java:1348)
        at android.view.Choreographer.doCallbacks(Choreographer.java:952)
        at android.view.Choreographer.doFrame(Choreographer.java:882)
        at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:1322)
        at android.os.Handler.handleCallback(Handler.java:958)
        at android.os.Handler.dispatchMessage(Handler.java:99)
        at android.os.Looper.loopOnce(Looper.java:205)
        at android.os.Looper.loop(Looper.java:294)
        at android.app.ActivityThread.main(ActivityThread.java:8177)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:552)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:971)

Compose Web support?

I'm looking for a good-looking Kotlin chart library for Compose Web.

Would you be considering supporting this (experimental) platform? From the structure of the code, it looks like support could be added almost for free, but I don't know whether some components/APIs would be missing on Compose Web (wasm), so it's hard to be sure.

Ok

Is your feature request related to a problem? What motivated You to create this request?
A clear and concise description of what the problem is, e.g., I'm always frustrated when [...]

Describe the solution you'd like to see
A clear and concise description of what you want to happen.

Additional context
Add any other context or screenshots about the feature request here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.