Koala Plot Core/io.github.koalaplot.core.polar/AngularValueAxisModel

AngularValueAxisModel

data class AngularValueAxisModel(tickValues: List<AngularValue> = buildList { @Suppress("MagicNumber") for (i in 0..<8) { add((PI * i / 4.0).rad) } }, val angleDirection: AngularAxisModel.AngleDirection = AngularAxisModel.AngleDirection.COUNTERCLOCKWISE, val angleZero: AngularAxisModel.AngleZero = AngularAxisModel.AngleZero.THREE_OCLOCK) : AngularAxisModel<AngularValue>

An AngularAxisModel that uses AngularValues of either Radians or Degrees.

Parameters

tickValues

The angular value of each tick that should be drawn on the plot.

Constructors

Link copied to clipboard
constructor(tickValues: List<AngularValue> = buildList { @Suppress("MagicNumber") for (i in 0..<8) { add((PI * i / 4.0).rad) } }, angleDirection: AngularAxisModel.AngleDirection = AngularAxisModel.AngleDirection.COUNTERCLOCKWISE, angleZero: AngularAxisModel.AngleZero = AngularAxisModel.AngleZero.THREE_OCLOCK)

Properties

Link copied to clipboard
open override val angleDirection: AngularAxisModel.AngleDirection

The AngleDirection for this axis.

Link copied to clipboard
open override val angleZero: AngularAxisModel.AngleZero

The AngleZero for this axis.

Functions

Link copied to clipboard
open override fun computeOffset(point: AngularValue): AngularValue

Computes the angular offset of the provided point along this axis. This function provides a mechanism to transform from arbitrary units T to angular units on the plot. For example, a category axis can convert specific categories to their angular position on the plot.

Link copied to clipboard
open override fun getTickValues(): List<AngularValue>

Gets the tick values for this axis model.