core/com.patrykandpatrick.vico.core.axis.vertical/VerticalAxis

VerticalAxis

class VerticalAxis<Position : AxisPosition.Vertical>(val position: Position) : Axis<Position>

An implementation of AxisRenderer used for vertical axes. This class extends Axis.

See also

Constructors

constructor(position: Position)

Types

class Builder<Position : AxisPosition.Vertical>(builder: Axis.Builder<Position>? = null) : Axis.Builder<Position>

A subclass of Axis.Builder used to build VerticalAxis instances.

HorizontalLabelPosition

enum HorizontalLabelPosition : Enum<VerticalAxis.HorizontalLabelPosition>

Defines the horizontal position of each of a vertical axis’s labels relative to the axis line.

VerticalLabelPosition

enum VerticalLabelPosition : Enum<VerticalAxis.VerticalLabelPosition>

Defines the vertical position of each of a horizontal axis’s labels relative to the label’s corresponding tick.

Properties

horizontalLabelPosition

var horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition

Defines the horizontal position of each axis label relative to the axis line.

var itemPlacer: AxisItemPlacer.Vertical

Determines for what y values this VerticalAxis is to display labels, ticks, and guidelines.

var ~~labelSpacing~~: Float

The label spacing (in dp).

var ~~maxLabelCount~~: Int

The maximum label count.

open override val position: Position

Defines the position of the axis relative to the Chart.

verticalLabelPosition

var verticalLabelPosition: VerticalAxis.VerticalLabelPosition

Defines the vertical position of each axis label relative to its corresponding tick.

Functions

open override fun drawAboveChart(context: ChartDrawContext)

Called after the Chart is drawn. Implementations can use this function to draw content above the Chart.

drawBehindChart

open override fun drawBehindChart(context: ChartDrawContext)

Called before the Chart is drawn. Implementations should rely on this function to draw themselves, unless they need to draw something above the Chart.

getHorizontalInsets

open override fun getHorizontalInsets(context: MeasureContext, availableHeight: Float, outInsets: HorizontalInsets)

Called during the measurement phase, after getInsets. Only horizontal insets can be requested from this function. Unless the available height is of interest, getInsets can be used to set all insets. The final inset for a given edge of the associated Chart is the largest of the insets requested for the edge.

open override fun getInsets(context: MeasureContext, outInsets: Insets, horizontalDimensions: HorizontalDimensions)

Called during the measurement phase, before getHorizontalInsets. Both horizontal and vertical insets can be requested from this function. The final inset for a given edge of the associated Chart is the largest of the insets requested for the edge.

updateHorizontalDimensions

open override fun updateHorizontalDimensions(context: MeasureContext, horizontalDimensions: MutableHorizontalDimensions)

Updates the chart’s MutableHorizontalDimensions instance.