compose/com.patrykandpatrick.vico.compose.axis.vertical/startAxis

startAxis

@Composable
fun startAxis(label: TextComponent? = axisLabelComponent(), axis: LineComponent? = axisLineComponent(), tick: LineComponent? = axisTickComponent(), tickLength: Dp = currentChartStyle.axis.axisTickLength, guideline: LineComponent? = axisGuidelineComponent(), valueFormatter: AxisValueFormatter<AxisPosition.Vertical.Start> = DecimalFormatAxisValueFormatter(), sizeConstraint: Axis.SizeConstraint = Axis.SizeConstraint.Auto(), horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition = VerticalAxis.HorizontalLabelPosition.Outside, verticalLabelPosition: VerticalAxis.VerticalLabelPosition = VerticalAxis.VerticalLabelPosition.Center, maxLabelCount: Int = DEF_LABEL_COUNT, labelRotationDegrees: Float = currentChartStyle.axis.axisLabelRotationDegrees, titleComponent: TextComponent? = null, title: CharSequence? = null): VerticalAxis<AxisPosition.Vertical.Start>

Deprecated

`startAxis` is being replaced by `rememberStartAxis`. Also, `maxLabelCount` is being replaced by `AxisItemPlacer.Vertical`. If using `maxLabelCount`, create a base `AxisItemPlacer.Vertical` implementation with the desired maximum item count via `AxisItemPlacer.Vertical.default`, and use the `itemPlacer` parameter of `rememberStartAxis` to apply it to the `VerticalAxis` being created.

Creates and remembers a start axis (i.e., a VerticalAxis with AxisPosition.Vertical.Start).

Parameters

label

the TextComponent to use for the labels.

axis

the LineComponent to use for the axis line.

tick

the LineComponent to use for the ticks.

tickLength

the length of the ticks.

guideline

the LineComponent to use for the guidelines.

valueFormatter

formats the labels.

sizeConstraint

defines how the VerticalAxis is to size itself.

horizontalLabelPosition

the horizontal position of the labels.

verticalLabelPosition

the vertical position of the labels.

maxLabelCount

the maximum label count.

labelRotationDegrees

the rotation of the axis labels (in degrees).

titleComponent

an optional TextComponent to use as the axis title.

title

the axis title.