core/com.patrykandpatrick.vico.core.axis/Axis/Builder

Builder

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

Used to construct Axis instances.

Inheritors

Constructors

constructor(builder: Axis.Builder<Position>? = null)

Properties

var axis: LineComponent?

The LineComponent to use for the axis line.

var guideline: LineComponent?

The LineComponent to use for guidelines.

var label: TextComponent?

The TextComponent to use for labels.

labelRotationDegrees

var labelRotationDegrees: Float

The rotation of axis labels (in degrees).

var sizeConstraint: Axis.SizeConstraint

Used by Axis subclasses for sizing and layout.

var tick: LineComponent?

The LineComponent to use for axis ticks.

var tickLengthDp: Float

The tick length (in dp).

var title: CharSequence?

The axis title.

var titleComponent: TextComponent?

An optional TextComponent to use as the axis title.

var valueFormatter: AxisValueFormatter<Position>

The AxisValueFormatter for the axis.

Functions

fun <Position : AxisPosition, A : Axis<Position>> Axis.Builder<Position>.setTo(axis: A): A

A convenience function that allows for applying the properties from an Axis.Builder to an Axis subclass.