commonMain.com.aay.compose.radarChart.RadarChart.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of chart Show documentation
Multiplatform library for desktop and android
The newest version!
package com.aay.compose.radarChart

import androidx.compose.foundation.Canvas
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.graphics.drawscope.DrawScope
import androidx.compose.ui.text.AnnotatedString
import androidx.compose.ui.text.ExperimentalTextApi
import androidx.compose.ui.text.TextMeasurer
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.rememberTextMeasurer
import com.aay.compose.radarChart.model.NetLinesStyle
import com.aay.compose.radarChart.model.Polygon
/**
 * Composable function to render a radar chart with configurable radar labels, net lines, and polygons.
 *
 * @param radarLabels List of labels for the radar chart's axes.
 * @param labelsStyle TextStyle for configuring the appearance of radar labels.
 * @param netLinesStyle Style for configuring the appearance of the radar net lines.
 * @param scalarSteps Number of scalar steps for the radar chart.
 * @param scalarValue Scalar value to determine the scale of the radar chart.
 * @param scalarValuesStyle TextStyle for configuring the appearance of scalar value labels.
 * @param polygons List of polygons to be displayed on the radar chart.
 * @param modifier Modifier for configuring the layout and appearance of the radar chart.
 *
 * @see Polygon
 * @see NetLinesStyle
 */
@OptIn(ExperimentalTextApi::class)
@Composable
fun RadarChart(
    radarLabels: List,
    labelsStyle: TextStyle,
    netLinesStyle: NetLinesStyle,
    scalarSteps: Int,
    scalarValue: Double,
    scalarValuesStyle: TextStyle,
    polygons: List,
    modifier: Modifier = Modifier
) {

    val textMeasurer = rememberTextMeasurer()

    validateRadarChartConfiguration(radarLabels, scalarValue, polygons, scalarSteps)

    Canvas(modifier = modifier) {

        val labelWidth = measureMaxLabelWidth(radarLabels, labelsStyle, textMeasurer)
        val radius = (size.minDimension / 2) - (labelWidth + 10.toDp().toPx())
        val labelRadius = (size.minDimension / 2) - (labelWidth / 2)
        val numLines = radarLabels.size
        val radarChartConfig =
            calculateRadarConfig(labelRadius, radius, size, numLines, scalarSteps)

        drawRadarNet(netLinesStyle, radarChartConfig)

        polygons.forEach {
            drawPolygonShape(
                this,
                it,
                radius,
                scalarValue,
                Offset(size.width / 2, size.height / 2),
                scalarSteps
            )
        }

        drawAxisData(
            labelsStyle,
            scalarValuesStyle,
            textMeasurer,
            radarChartConfig,
            radarLabels,
            scalarValue,
            scalarSteps,
            polygons[0].unit
        )

    }

}

private fun validateRadarChartConfiguration(
    radarLabels: List,
    scalarValue: Double,
    polygons: List,
    scalarSteps: Int
) {
    require(scalarSteps > 0) { "Scalar steps must be a positive value" }
    require(scalarValue > 0.0) { "Scalar value must be greater than 0" }
    require(radarLabels.size >= 3) { "At least 3 radar labels are required" }

    for (polygon in polygons) {
        require(polygon.values.size == radarLabels.size) {
            "Number of polygon values must match the number of radar labels"
        }
        polygon.values.forEachIndexed { index, value ->
            require(value in 0.0..scalarValue) {
                "Polygon value at index $index must be between 0 and scalar value ($scalarValue)"
            }
        }
    }
}

@OptIn(ExperimentalTextApi::class)
private fun DrawScope.measureMaxLabelWidth(
    radarLabels: List,
    labelsStyle: TextStyle,
    textMeasurer: TextMeasurer
): Float {
    return textMeasurer.measure(
        AnnotatedString(
            text = radarLabels.maxByOrNull { it.length } ?: "",
        ), style = labelsStyle
    ).size.width.toDp().toPx()
}