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

AngularAxisModel

interface AngularAxisModel<T>

An interface for classes representing the angular axis on a polar plot.

Parameters

T

The data type for the axis values.

Inheritors

Types

Link copied to clipboard
enum AngleDirection : Enum<AngularAxisModel.AngleDirection>

Defines the direction for incrementing angles on a PolarGraph. Counter clockwise is the regular convention for mathematics.

Link copied to clipboard
enum AngleZero : Enum<AngularAxisModel.AngleZero>

Defines the orientation of the Zero angle on a PolarGraph. 3 O'Clock is the regular convention for mathematics, while 12 O'Clock is typical for category based charts and spider charts.

Properties

Link copied to clipboard
Link copied to clipboard
abstract val angleZero: AngularAxisModel.AngleZero

The AngleZero for this axis.

Functions

Link copied to clipboard
abstract fun computeOffset(point: T): 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
abstract fun getTickValues(): List<T>

Gets the tick values for this axis model.