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

Axis

abstract class Axis<Position : AxisPosition> : AxisRenderer<Position>

A basic implementation of AxisRenderer used throughout the library.

See also

Inheritors

Constructors

Link copied to clipboard
constructor()

Types

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

Used to construct Axis instances.

Link copied to clipboard
sealed class SizeConstraint

Defines how an Axis is to size itself.

Properties

Link copied to clipboard
var axisLine: LineComponent?

The LineComponent to use for the axis line.

Link copied to clipboard
open override val bounds: RectF

The bounds of the abstract component.

Link copied to clipboard
var guideline: LineComponent?

The LineComponent to use for guidelines.

Link copied to clipboard
var label: TextComponent?

The TextComponent to use for labels.

Link copied to clipboard
var labelRotationDegrees: Float

The rotation of axis labels (in degrees).

Link copied to clipboard
var sizeConstraint: Axis.SizeConstraint

Used by Axis subclasses for sizing and layout.

Link copied to clipboard
var tick: LineComponent?

The LineComponent to use for ticks.

Link copied to clipboard
var tickLengthDp: Float

The tick length (in dp).

Link copied to clipboard
var title: CharSequence?

The axis title.

Link copied to clipboard
var titleComponent: TextComponent?

An optional TextComponent to use as the axis title.

Link copied to clipboard

Functions

Link copied to clipboard
open override fun setRestrictedBounds(vararg bounds: RectF?)

The bounds (RectF) passed here define the area where the AxisRenderer shouldn’t draw anything.