core/com.patrykandpatrick.vico.core.axis.horizontal/HorizontalAxis

HorizontalAxis

class HorizontalAxis<Position : AxisPosition.Horizontal>(val position: Position) : Axis<Position>

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

See also

Constructors

Link copied to clipboard
constructor(position: Position)

Types

Link copied to clipboard
class Builder<Position : AxisPosition.Horizontal>(builder: Axis.Builder<Position>? = null) : Axis.Builder<Position>

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

Properties

Link copied to clipboard
var itemPlacer: AxisItemPlacer.Horizontal

Determines for what x values this HorizontalAxis is to display labels, ticks, and guidelines.

Link copied to clipboard
var labelOffset: Int

The number of labels (and, for HorizontalLayout.FullWidth, their corresponding ticks and guidelines) to skip from the start.

Link copied to clipboard
var labelSpacing: Int

How often labels (and their corresponding ticks and guidelines) should be drawn.

Link copied to clipboard
open override val position: Position

Defines the position of the axis relative to the Chart.

Functions

Link copied to clipboard
open override fun drawAboveChart(context: ChartDrawContext)

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun updateHorizontalDimensions(context: MeasureContext, horizontalDimensions: MutableHorizontalDimensions)

Updates the chart’s MutableHorizontalDimensions instance.