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

VerticalAxis

open class VerticalAxis<P : Axis.Position.Vertical> : BaseAxis<P>

Draws vertical axes. See the BaseAxis documentation for descriptions of the inherited properties.

Types

Link copied to clipboard
object Companion

Houses VerticalAxis factory functions.

Link copied to clipboard
enum HorizontalLabelPosition : Enum<VerticalAxis.HorizontalLabelPosition>

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

Link copied to clipboard
interface ItemPlacer

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

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

Link copied to clipboard
val horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition

defines the horizontal position of the labels relative to the axis line.

Link copied to clipboard
val itemPlacer: VerticalAxis.ItemPlacer

determines for what y values the VerticalAxis displays labels, ticks, and guidelines.

Link copied to clipboard
open override val position: P

The position of the Axis.

Link copied to clipboard
val verticalLabelPosition: VerticalAxis.VerticalLabelPosition

defines the vertical positions of the labels relative to their ticks.

Functions

Link copied to clipboard
fun copy(line: LineComponent? = this.line, label: TextComponent? = this.label, labelRotationDegrees: Float = this.labelRotationDegrees, horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition = this.horizontalLabelPosition, verticalLabelPosition: VerticalAxis.VerticalLabelPosition = this.verticalLabelPosition, valueFormatter: CartesianValueFormatter = this.valueFormatter, tick: LineComponent? = this.tick, tickLengthDp: Float = this.tickLengthDp, guideline: LineComponent? = this.guideline, itemPlacer: VerticalAxis.ItemPlacer = this.itemPlacer, size: BaseAxis.Size = this.size, titleComponent: TextComponent? = this.titleComponent, title: CharSequence? = this.title): VerticalAxis<P>

Creates a new VerticalAxis based on this one.

Link copied to clipboard
open override fun drawOverLayers(context: CartesianDrawingContext)

Draws content over the CartesianLayers.

Link copied to clipboard
open override fun drawUnderLayers(context: CartesianDrawingContext)

Draws content under the CartesianLayers.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun updateHorizontalDimensions(context: CartesianMeasuringContext, horizontalDimensions: MutableHorizontalDimensions)

Updates the chart’s MutableHorizontalDimensions instance.

Link copied to clipboard
open override fun updateHorizontalInsets(context: CartesianMeasuringContext, freeHeight: Float, model: CartesianChartModel, insets: HorizontalInsets)

Ensures that there are sufficient horizontal insets. freeHeight is the height of the CartesianLayer area.

Link copied to clipboard
open override fun updateInsets(context: CartesianMeasuringContext, horizontalDimensions: HorizontalDimensions, model: CartesianChartModel, insets: Insets)

Ensures that there are sufficient insets.