chartopia

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 26 Open GitHub ↗

A Kotlin/Compose Multiplatform library that offers different types of charts to display data.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Maven Central Version](https://img.shields.io/maven-central/v/io.github.tweener/chartopia?color=orange)](https://central.sonatype.com/artifact/io.github.tweener/chartopia)
[![Kotlin](https://img.shields.io/badge/kotlin-2.1.21-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![Compose](https://img.shields.io/badge/compose-1.8.0-blue.svg?logo=jetpackcompose)](https://www.jetbrains.com/lp/compose-multiplatform)
![gradle-version](https://img.shields.io/badge/gradle-8.11.1-blue?logo=gradle)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)

[![Website](https://img.shields.io/badge/Author-vivienmahe.com-purple)](https://vivienmahe.com/)
[![X/Twitter](https://img.shields.io/twitter/follow/VivienMahe)](https://twitter.com/VivienMahe)

<br>

![Black background](https://github.com/user-attachments/assets/5f4e807b-3d98-4049-9574-a1d097e3e4c8)
![White background](https://github.com/user-attachments/assets/c01de8b6-b96f-4d81-8429-5d74b4a32d67)

---

# Chartopia

**Chartopia** is a Kotlin/Compose Multiplatform library that provides a variety of customizable charts to visually represent data.

<br>

Be sure to show your support by starring ⭐️ this repository, and feel free to [contribute](#-contributing) if you're interested!

---

## 🌟 Features

- 🍩 **DonutChart**: A circular chart for visualizing proportional data, with smooth animations and extensive customization options. Add a list of segments to represent categories, making it perfect for percentages or distribution comparisons.
- 📈 **LineChart**: A versatile chart for displaying trends and patterns, fully customizable with animated transitions. Supports multiple lines on the same chart, enabling clear and effective comparisons of different datasets on shared axes.

---

## 🛠️ Installation

Add the dependency in your common module's commonMain `sourceSet`:

In your `settings.gradle.kts` file, add Maven Central to your repositories:
```Groovy
repositories {
    mavenCentral()
}
```

Then add Chartopia dependency to your module:

- With version catalog, open `libs.versions.toml`:
```Groovy
[versions]
chartopia = "2.0.0" // Check latest version

[libraries]
chartopia = { group = "io.github.tweener", name = "chartopia", version.ref = "chartopia" }
```

Then in your module `build.gradle.kts` add:
```Groovy
dependencies {
    implementation(libs.chartopia)
}
```

- Without version catalog, in your module `build.gradle.kts` add:
```Groovy
dependencies {
    val chartopia_version = "2.0.0" // Check latest version

implementation("io.github.tweener:chartopia:$chartopia_version")
}
```

The latest version is: [![Maven Central Version](https://img.shields.io/maven-central/v/io.github.tweener/chartopia?color=orange)](https://central.sonatype.com/artifact/io.github.tweener/chartopia)

## 🧑‍💻 Usage

### 🍩 Donut chart
A [`DonutChart`](https://github.com/Tweener/chartopia/blob/main/chartopia/src/commonMain/kotlin/com/tweener/chartopia/type/donut/DonutChart.kt) requires a list of [Segment](https://github.com/Tweener/chartopia/blob/main/chartopia/src/commonMain/kotlin/com/tweener/chartopia/type/donut/model/Segment.kt)s, with the first segment starting from the given `startAngleFromOrigin` in degrees.
Each segment is defined by an **angle**, its **color** and an optional **progress** option.

_See [`.degrees`](https://github.com/Tweener/KMPKit/blob/main/kmpkit/src/commonMain/kotlin/com/tweener/kmpkit/kotlinextensions/FloatExtensions.kt#L15) to easily use float angles in degrees._

```Kotlin
val green = Color(0xFF04C700)
val orange = Color(0xFFFF8850)
val red = Color(0xFFFF3434)
val darkRed = Color(0xFFA40000)
val yellow = Color(0xFFFFF534)
val darkYellow = Color(0xFF746F0E)
val blue = Color(0xFF3437FF)

DonutChart(
    segments = listOf(
        Segment(angle = 40f.degrees, progress = 0.33f, baseColor = green),
        Segment(angle = 20f.degrees, progress = 0.7f, baseColor = yellow, backgroundColor = darkYellow),
        Segment(angle = 90f.degrees, progress = 0.66f, baseColor = green),
        Segment(angle = 60f.degrees, progress = 0.7f, baseColor = red, backgroundColor = darkRed),
        Segment(angle = 50f.degrees, progress = 0.8f, baseColor = orange),
        Segment(angle = 100f.degrees, progress = 1f, baseColor = blue),
    ),
    startAngleFromOrigin = 270f.degrees,
    sizes = DonutChartDefault.chartSizes(strokeWidth = 12.dp, selectedStrokeWidth = 22.dp),
    animationDurationMillis = 800,
)
```
This code gives the following output:

### 📈 Line chart
A [`LineChart`](https://github.com/Tweener/chartopia/blob/main/chartopia/src/commonMain/kotlin/com/tweener/chartopia/type/line/LineChart.kt) is a versatile chart used to visualize data points connected by straight or curved lines. It is ideal for displaying trends, relationships, or changes over time.

```Kotlin
LineChart(
    modifier = Modifier
        .fillMaxWidth()
        .height(200.dp),
    lines = lines,
    xAxis = xAxis,
    yAxis = yAxis,
    textStyle = MaterialTheme.typography.labelLarge,
    gridVisibility = LineChartDefaults.gridVisibility(
        showXAxis = true,
        showYAxis = true,
    ),
    colors = LineChartDefaults.chartColors(
        xAxisValues = MaterialTheme.colorScheme.onBackground,
        xAxisGrid = MaterialTheme.colorScheme.outline,
        yAxisValues = MaterialTheme.colorScheme.onBackground,
        yAxisGrid = MaterialTheme.colorScheme.outline,
    ),
    sizes = LineChartDefaults.chartSizes(
        axisStrokeWidth = 1.dp,
        axisDashOn = 8.dp,
        axisDashOff = 8.dp,
        axisXValuesPadding = Size.Padding.Small,
        axisYValuesPadding = Size.Padding.ExtraSmall,
    )
)
```
Some examples of output with straight or curved lines:

![linechart](https://github.com/user-attachments/assets/060464f5-ff2e-4e05-881f-a6e3ce52740d)

---

## 👨‍💻 Contributing

We love your input and welcome any contributions! Please read our [contribution guidelines](https://github.com/Tweener/chartopia/blob/master/CONTRIBUTING.md) before submitting a pull request.

---

## 🙏 Credits

- Logo by [Freeicons](https://freeicons.io/university-3/economy-data-chart-business-graph-icon-511816)

---

## 📜 Licence

Chartopia is licensed under the [Apache-2.0](https://github.com/Tweener/chartopia?tab=Apache-2.0-1-ov-file#readme).

chartopia

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README