Koala Plot Core/io.github.koalaplot.core.xygraph

Package-level declarations

Types

AnchorPoint

sealed class AnchorPoint

AxisModel

interface AxisModel<T>

An interface for classes representing a plot axis.

AxisState

interface AxisState

Holds the offsets for major and minor ticks within an axis.

AxisStyle

data class AxisStyle(val color: Color = Color.Black, val majorTickSize: Dp = 0.dp, val minorTickSize: Dp = 0.dp, val tickPosition: TickPosition = TickPosition.None, val lineWidth: Dp = 1.dp, val labelRotation: Int = 0)

Styling configuration for an Axis.

CategoryAxisModel

class CategoryAxisModel<T>(categories: List<T>, firstCategoryIsZero: Boolean = false, val minimumMajorTickSpacing: Dp = 50.dp) : AxisModel<T>

An axis that uses arbitrary category objects instead of numbers as its values. It is a discrete axis.

DefaultPoint

data class DefaultPoint<X, Y>(val x: X, val y: Y) : Point<X, Y>

Default implementation of the Point interface.

DoubleLinearAxisModel

class DoubleLinearAxisModel(val range: ClosedFloatingPointRange<Double>, zoomRangeLimit: Double = (range.endInclusive - range.start) * ZoomRangeLimitDefault, minimumMajorTickIncrement: Double = (range.endInclusive - range.start) * MinimumMajorTickIncrementDefault, val minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true) : ILinearAxisModel<Double>

An AxisModel that uses Double values and is linear.

FloatLinearAxisModel

class FloatLinearAxisModel(val range: ClosedFloatingPointRange<Float>, zoomRangeLimit: Float = (range.endInclusive - range.start) * ZoomRangeLimitDefault, minimumMajorTickIncrement: Float = (range.endInclusive - range.start) * MinimumMajorTickIncrementDefault, val minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true) : AxisModel<Float> , ILinearAxisModel<Float>

An AxisModel that uses Float values and is linear.

ILinearAxisModel

interface ILinearAxisModel<T : Comparable<T>, Number> : AxisModel<T>

IntLinearAxisModel

class IntLinearAxisModel(val range: IntRange, zoomRangeLimit: Int = range.last - range.first, minimumMajorTickIncrement: Int = ( (range.last - range.first) * MinimumMajorTickIncrementDefault ).toInt(), val minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true) : ILinearAxisModel<Int>

An AxisModel that uses Int values and is linear.

LinearAxisModel

class ~~LinearAxisModel~~(val range: ClosedFloatingPointRange<Float>, zoomRangeLimit: Float = (range.endInclusive - range.start) * ZoomRangeLimitDefault, minimumMajorTickIncrement: Float = (range.endInclusive - range.start) * MinimumMajorTickIncrementDefault, val minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true) : AxisModel<Float>

An AxisModel that uses Float values and is linear.

LogAxisModel

class LogAxisModel(range: ClosedRange<Int>, val minimumMajorTickSpacing: Dp = 50.dp) : AxisModel<Float>

A logarithmic axis.

LongLinearAxisModel

class LongLinearAxisModel(val range: LongRange, zoomRangeLimit: Long = range.last - range.first, minimumMajorTickIncrement: Long = ( (range.last - range.first) * MinimumMajorTickIncrementDefault ).toLong(), val minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true) : ILinearAxisModel<Long>

An AxisModel that uses Long values and is linear.

Point

interface Point<X, Y>

Represents a point on a 2-d plot.

TickPosition

enum TickPosition : Enum<TickPosition>

Specifies the position of axis ticks.

TickValues

interface TickValues<T>

The major and minor tick values for an axis.

XYGraphScope

interface XYGraphScope<X, Y> : HoverableElementAreaScope

A scope for XY plots providing axis and state context.

Functions

autoScaleRange

fun List<Double>.autoScaleRange(): ClosedFloatingPointRange<Double>

Calculates an ClosedFloatingPointRange that can be used with a DoubleLinearAxisModel based on the min/max values of the provided list of Doubles. If the list is empty, returns a range of 0..1.

@JvmName(name = "autoScaleFloatRange")

fun List<Float>.autoScaleRange(): ClosedFloatingPointRange<Float>

Calculates an ClosedFloatingPointRange that can be used with a FloatLinearAxisModel based on the min/max values of the provided list of Floats. If the list is empty, returns a range of 0..1.

fun List<Int>.autoScaleRange(): IntRange

Calculates an IntRange that can be used with a IntLinearAxisModel based on the min/max values of the provided list of Ints. If the list is empty, returns a range of 0..1.

fun List<Long>.autoScaleRange(): LongRange

Calculates a LongRange that can be used with a LongLinearAxisModel based on the min/max values of the provided list of Longs. If the list is empty, returns a range of 0..1.

autoScaleXRange

fun <Y> List<Point<Double, Y>>.autoScaleXRange(): ClosedFloatingPointRange<Double>

fun <Y> List<Point<Float, Y>>.autoScaleXRange(): ClosedFloatingPointRange<Float>

fun <Y> List<Point<Int, Y>>.autoScaleXRange(): IntRange

fun <Y> List<Point<Long, Y>>.autoScaleXRange(): LongRange

Calculates a ClosedFloatingPointRange that can be used with a LinearAxisModel based on the min/max X values of the provided list of Points.

autoScaleYRange

fun <X> List<Point<X, Double>>.autoScaleYRange(): ClosedFloatingPointRange<Double>

fun <X> List<Point<X, Float>>.autoScaleYRange(): ClosedFloatingPointRange<Float>

fun <X> List<Point<X, Int>>.autoScaleYRange(): IntRange

fun <X> List<Point<X, Long>>.autoScaleYRange(): LongRange

Calculates a ClosedFloatingPointRange that can be used with a LinearAxisModel based on the min/max Y values of the provided list of Points.

HorizontalLineAnnotation

@Composable

fun <X, Y> XYGraphScope<X, Y>.HorizontalLineAnnotation(location: Y, lineStyle: LineStyle)

Places a vertical line marker on the plot at the specified x-axis location styled using the provided lineStyle.

Point

fun <X, Y> Point(x: X, y: Y): Point<X, Y>

Creates a new DefaultPoint at the specified coordinates.

rememberAxisStyle

@Composable

fun rememberAxisStyle(color: Color = KoalaPlotTheme.axis.color, majorTickSize: Dp = KoalaPlotTheme.axis.majorTickSize, minorTickSize: Dp = KoalaPlotTheme.axis.minorTickSize, tickPosition: TickPosition = KoalaPlotTheme.axis.xyGraphTickPosition, lineWidth: Dp = KoalaPlotTheme.axis.lineThickness, labelRotation: Int = 0): AxisStyle

Creates and remembers an AxisStyle.

rememberDoubleLinearAxisModel

@Composable

fun rememberDoubleLinearAxisModel(range: ClosedFloatingPointRange<Double>, zoomRangeLimit: Double = (range.endInclusive - range.start) * ZoomRangeLimitDefault, minimumMajorTickIncrement: Double = (range.endInclusive - range.start) * MinimumMajorTickIncrementDefault, minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true): DoubleLinearAxisModel

Create and remember a DoubleLinearAxisModel. See DoubleLinearAxisModel for parameter descriptions.

rememberFloatLinearAxisModel

@Composable

fun rememberFloatLinearAxisModel(range: ClosedFloatingPointRange<Float>, zoomRangeLimit: Float = (range.endInclusive - range.start) * ZoomRangeLimitDefault, minimumMajorTickIncrement: Float = (range.endInclusive - range.start) * MinimumMajorTickIncrementDefault, minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true): FloatLinearAxisModel

Create and remember a FloatLinearAxisModel. See FloatLinearAxisModel for parameter descriptions.

rememberIntLinearAxisModel

@Composable

fun rememberIntLinearAxisModel(range: IntRange, zoomRangeLimit: Int = ((range.last - range.first) * ZoomRangeLimitDefault).toInt(), minimumMajorTickIncrement: Int = ((range.last - range.first) * MinimumMajorTickIncrementDefault).toInt(), minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true): IntLinearAxisModel

Create and remember an IntLinearAxisModel. See IntLinearAxisModel for parameter descriptions.

rememberLinearAxisModel

@Composable

fun ~~rememberLinearAxisModel~~(range: ClosedFloatingPointRange<Float>, zoomRangeLimit: Float = (range.endInclusive - range.start) * ZoomRangeLimitDefault, minimumMajorTickIncrement: Float = (range.endInclusive - range.start) * MinimumMajorTickIncrementDefault, minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true): FloatLinearAxisModel

Create and remember a LinearAxisModel.

rememberLongLinearAxisModel

@Composable

fun rememberLongLinearAxisModel(range: LongRange, zoomRangeLimit: Long = ((range.last - range.first) * ZoomRangeLimitDefault).toLong(), minimumMajorTickIncrement: Long = ((range.last - range.first) * MinimumMajorTickIncrementDefault).toLong(), minimumMajorTickSpacing: Dp = 50.dp, minorTickCount: Int = 4, allowZooming: Boolean = true, allowPanning: Boolean = true): LongLinearAxisModel

Create and remember a LongLinearAxisModel. See LongLinearAxisModel for parameter descriptions.

VerticalLineAnnotation

@Composable

fun <X, Y> XYGraphScope<X, Y>.VerticalLineAnnotation(location: X, lineStyle: LineStyle)

Places a vertical line marker on the plot at the specified x-axis location styled using the provided lineStyle.

XYAnnotation

@Composable

fun <X, Y> XYGraphScope<X, Y>.XYAnnotation(location: Point<X, Y>, anchorPoint: AnchorPoint, modifier: Modifier = Modifier, content: @Composable () -> Unit)

Places a Composable as an annotation on an XYGraph with the Composable's anchorPoint placed at the provided location.

XYGraph

@Composable

fun <X, Y> XYGraph(xAxisModel: AxisModel<X>, yAxisModel: AxisModel<Y>, modifier: Modifier = Modifier, xAxisStyle: AxisStyle = rememberAxisStyle(), xAxisLabels: (X) -> String = { it.toString() }, xAxisTitle: String? = null, yAxisStyle: AxisStyle = rememberAxisStyle(), yAxisLabels: (Y) -> String = { it.toString() }, yAxisTitle: String? = null, horizontalMajorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.majorGridlineStyle, horizontalMinorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.minorGridlineStyle, verticalMajorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.majorGridlineStyle, verticalMinorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.minorGridlineStyle, panZoomEnabled: Boolean = true, content: @Composable XYGraphScope<X, Y>.() -> Unit)

An XYGraph overload that takes Strings for axis labels and titles instead of Composables for use cases where custom styling is not required.

@Composable

fun <X, Y> XYGraph(xAxisModel: AxisModel<X>, yAxisModel: AxisModel<Y>, modifier: Modifier = Modifier, xAxisStyle: AxisStyle = rememberAxisStyle(), xAxisLabels: @Composable (X) -> Unit, xAxisTitle: @Composable () -> Unit = {}, yAxisStyle: AxisStyle = rememberAxisStyle(), yAxisLabels: @Composable (Y) -> Unit, yAxisTitle: @Composable () -> Unit = {}, horizontalMajorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.majorGridlineStyle, horizontalMinorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.minorGridlineStyle, verticalMajorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.majorGridlineStyle, verticalMinorGridLineStyle: LineStyle? = KoalaPlotTheme.axis.minorGridlineStyle, panZoomEnabled: Boolean = true, content: @Composable XYGraphScope<X, Y>.() -> Unit)

Provides a set of X-Y axes and grid for displaying X-Y plots.