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

FloatLinearAxisModel

class FloatLinearAxisModel(val range: ClosedFloatingPointRange<Float>, zoomRangeLimit: Float = (range.endInclusive - range.start) * ZoomRangeLimitDefault.toFloat(), 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.

Parameters

range

The minimum to maximum values allowed to be represented on this Axis. Zoom and scroll modifications may not exceed this range.

zoomRangeLimit

Specifies the minimum allowed range after zooming. Must be greater than 0 and less than the difference between the start and end of range.

minimumMajorTickIncrement

The minimum value between adjacent major ticks. Must be less than or equal to the extent of the range.

minimumMajorTickSpacing

Specifies the minimum physical spacing for major ticks, in Dp units. Must be greater than 0.

minorTickCount

The number of minor ticks per major tick interval.

allowZooming

If the axis should allow zooming

allowPanning

If the axis should allow panning.

Constructors

FloatLinearAxisModel

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

Properties

minimumMajorTickSpacing

open override val minimumMajorTickSpacing: Dp

range

open override val range: ClosedFloatingPointRange<Float>

Functions

computeOffset

open override fun computeOffset(point: Float): Float

Computes the linear offset of the provided point along this axis relative to its min value. For a linear axis this is offset = (point-min)/(max-min). Values less than 0 or greater than 1 mean the point is before or beyond the range of the axis, respectively. Nonlinear, e.g. log, axes can be implemented with appropriate transformations in this function.

computeTickValues

open override fun computeTickValues(axisLength: Dp): TickValues<Float>

Computes major and minor tick values based on the minimum tick spacing and the overall axisLength.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

pan

open override fun pan(amount: Float)

Asks the AxisState to compute new ranges and tick values after panning, if the axis supports panning.

zoom

open override fun zoom(zoomFactor: Float, pivot: Float)

Asks the AxisState to compute new ranges and tick values after zooming, if the axis supports zooming.