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

object Companion

Houses VerticalAxis factory functions.

HorizontalLabelPosition

enum HorizontalLabelPosition : Enum<VerticalAxis.HorizontalLabelPosition>

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

interface ItemPlacer

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

Properties

horizontalLabelPosition

val horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition

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

val itemPlacer: VerticalAxis.ItemPlacer

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

open override val position: P

The position of the Axis.

verticalLabelPosition

val verticalLabelPosition: Position.Vertical

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

Functions

fun copy(line: LineComponent? = this.line, label: TextComponent? = this.label, labelRotationDegrees: Float = this.labelRotationDegrees, horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition = this.horizontalLabelPosition, verticalLabelPosition: Position.Vertical = 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.

open override fun drawOverLayers(context: CartesianDrawingContext)

Draws content over the CartesianLayers.

drawUnderLayers

open override fun drawUnderLayers(context: CartesianDrawingContext)

Draws content under the CartesianLayers.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

updateHorizontalLayerMargins

open override fun updateHorizontalLayerMargins(context: CartesianMeasuringContext, horizontalLayerMargins: HorizontalCartesianLayerMargins, layerHeight: Float, model: CartesianChartModel)

Ensures that there are sufficient horizontal CartesianLayer-area margins.

updateLayerDimensions

open override fun updateLayerDimensions(context: CartesianMeasuringContext, layerDimensions: MutableCartesianLayerDimensions)

Updates the chart’s MutableCartesianLayerDimensions instance.

updateLayerMargins

open override fun updateLayerMargins(context: CartesianMeasuringContext, layerMargins: CartesianLayerMargins, layerDimensions: CartesianLayerDimensions, model: CartesianChartModel)

Ensures that there are sufficient CartesianLayer-area margins.