core/com.patrykandpatrick.vico.core.cartesian.axis/VerticalAxis/ItemPlacer

ItemPlacer

interface ItemPlacer

Determines for what y values a VerticalAxis displays labels, ticks, and guidelines.

Types

Companion

object Companion

Houses ItemPlacer factory functions.

Functions

getBottomVerticalAxisInset

abstract fun getBottomVerticalAxisInset(context: CartesianMeasuringContext, verticalLabelPosition: VerticalAxis.VerticalLabelPosition, maxLabelHeight: Float, maxLineThickness: Float): Float

Returns the bottom inset required by the VerticalAxis.

getHeightMeasurementLabelValues

abstract fun getHeightMeasurementLabelValues(context: CartesianMeasuringContext, position: Axis.Position.Vertical): List<Double>

Returns, as a list, the y values for which the VerticalAxis is to create labels and measure their heights during the measuring phase. The height of the tallest label is passed to other functions.

getLabelValues

abstract fun getLabelValues(context: CartesianDrawingContext, axisHeight: Float, maxLabelHeight: Float, position: Axis.Position.Vertical): List<Double>

Returns, as a list, the y values for which labels are to be displayed.

getLineValues

open fun getLineValues(context: CartesianDrawingContext, axisHeight: Float, maxLabelHeight: Float, position: Axis.Position.Vertical): List<Double>?

Returns, as a list, the y values for which ticks and guidelines are to be displayed.

getShiftTopLines

open fun getShiftTopLines(context: CartesianDrawingContext): Boolean

Returns a boolean indicating whether to shift the lines whose y values are equal to CartesianChartRanges.YRange.maxY, if such lines are present, such that they’re immediately above the CartesianLayer bounds. If a top HorizontalAxis is present, the shifted tick will then be aligned with the axis line, and the shifted guideline will be hidden.

getTopVerticalAxisInset

abstract fun getTopVerticalAxisInset(context: CartesianMeasuringContext, verticalLabelPosition: VerticalAxis.VerticalLabelPosition, maxLabelHeight: Float, maxLineThickness: Float): Float

Returns the top inset required by the VerticalAxis.

getWidthMeasurementLabelValues

abstract fun getWidthMeasurementLabelValues(context: CartesianMeasuringContext, axisHeight: Float, maxLabelHeight: Float, position: Axis.Position.Vertical): List<Double>

Returns, as a list, the y values for which the VerticalAxis is to create labels and measure their widths during the measuring phase. This affects how much horizontal space the VerticalAxis requests.