compose/com.patrykandpatrick.vico.compose.cartesian.axis

Package-level declarations

Functions

Link copied to clipboard
@Composable
fun rememberAxisGuidelineComponent(color: Color = vicoTheme.lineColor, thickness: Dp = Defaults.AXIS_GUIDELINE_WIDTH.dp, shape: Shape = dashedShape(Shape.Rectangle, Defaults.DASH_LENGTH.dp, Defaults.DASH_GAP.dp), margins: Dimensions = Dimensions.Empty, strokeColor: Color = Color.Transparent, strokeThickness: Dp = 0.dp, shader: DynamicShader? = null, shadow: Shadow? = null): LineComponent

A rememberLineComponent alias with defaults for Axis guidelines.

Link copied to clipboard
@Composable
fun rememberAxisLabelComponent(color: Color = vicoTheme.textColor, typeface: Typeface = Typeface.DEFAULT, textSize: TextUnit = Defaults.AXIS_LABEL_SIZE.sp, textAlignment: Layout.Alignment = Layout.Alignment.ALIGN_NORMAL, lineCount: Int = Defaults.AXIS_LABEL_MAX_LINES, truncateAt: TextUtils.TruncateAt = TextUtils.TruncateAt.END, margins: Dimensions = dimensions(Defaults.AXIS_LABEL_HORIZONTAL_MARGIN.dp, Defaults.AXIS_LABEL_VERTICAL_MARGIN.dp), padding: Dimensions = dimensions(Defaults.AXIS_LABEL_HORIZONTAL_PADDING.dp, Defaults.AXIS_LABEL_VERTICAL_PADDING.dp), background: Component? = null, minWidth: TextComponent.MinWidth = TextComponent.MinWidth.fixed()): TextComponent

A rememberTextComponent alias with defaults for Axis labels.

Link copied to clipboard
@Composable
fun rememberAxisLineComponent(color: Color = vicoTheme.lineColor, thickness: Dp = Defaults.AXIS_LINE_WIDTH.dp, shape: Shape = Shape.Rectangle, margins: Dimensions = Dimensions.Empty, strokeColor: Color = Color.Transparent, strokeThickness: Dp = 0.dp, shader: DynamicShader? = null, shadow: Shadow? = null): LineComponent

A rememberLineComponent alias with defaults for Axis lines.

Link copied to clipboard
@Composable
fun rememberAxisTickComponent(color: Color = vicoTheme.lineColor, thickness: Dp = Defaults.AXIS_LINE_WIDTH.dp, shape: Shape = Shape.Rectangle, margins: Dimensions = Dimensions.Empty, strokeColor: Color = Color.Transparent, strokeThickness: Dp = 0.dp, shader: DynamicShader? = null, shadow: Shadow? = null): LineComponent

A rememberLineComponent alias with defaults for Axis ticks.

Link copied to clipboard
@Composable
fun HorizontalAxis.Companion.rememberBottom(line: LineComponent? = rememberAxisLineComponent(), label: TextComponent? = rememberAxisLabelComponent(), labelRotationDegrees: Float = Defaults.AXIS_LABEL_ROTATION_DEGREES, valueFormatter: CartesianValueFormatter = remember { CartesianValueFormatter.decimal() }, tick: LineComponent? = rememberAxisTickComponent(), tickLength: Dp = Defaults.AXIS_TICK_LENGTH.dp, guideline: LineComponent? = rememberAxisGuidelineComponent(), itemPlacer: HorizontalAxis.ItemPlacer = remember { HorizontalAxis.ItemPlacer.aligned() }, sizeConstraint: BaseAxis.SizeConstraint = remember { BaseAxis.SizeConstraint.Auto() }, titleComponent: TextComponent? = null, title: CharSequence? = null): HorizontalAxis<Axis.Position.Horizontal.Bottom>

Creates and remembers a bottom HorizontalAxis.

Link copied to clipboard
@Composable
fun VerticalAxis.Companion.rememberEnd(line: LineComponent? = rememberAxisLineComponent(), label: TextComponent? = rememberAxisLabelComponent(), labelRotationDegrees: Float = Defaults.AXIS_LABEL_ROTATION_DEGREES, horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition = VerticalAxis.HorizontalLabelPosition.Outside, verticalLabelPosition: VerticalAxis.VerticalLabelPosition = VerticalAxis.VerticalLabelPosition.Center, valueFormatter: CartesianValueFormatter = remember { CartesianValueFormatter.decimal() }, tick: LineComponent? = rememberAxisTickComponent(), tickLength: Dp = Defaults.AXIS_TICK_LENGTH.dp, guideline: LineComponent? = rememberAxisGuidelineComponent(), itemPlacer: VerticalAxis.ItemPlacer = remember { VerticalAxis.ItemPlacer.step() }, sizeConstraint: BaseAxis.SizeConstraint = remember { BaseAxis.SizeConstraint.Auto() }, titleComponent: TextComponent? = null, title: CharSequence? = null): VerticalAxis<Axis.Position.Vertical.End>

Creates and remembers an end VerticalAxis.

Link copied to clipboard
@Composable
fun VerticalAxis.Companion.rememberStart(line: LineComponent? = rememberAxisLineComponent(), label: TextComponent? = rememberAxisLabelComponent(), labelRotationDegrees: Float = Defaults.AXIS_LABEL_ROTATION_DEGREES, horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition = VerticalAxis.HorizontalLabelPosition.Outside, verticalLabelPosition: VerticalAxis.VerticalLabelPosition = VerticalAxis.VerticalLabelPosition.Center, valueFormatter: CartesianValueFormatter = remember { CartesianValueFormatter.decimal() }, tick: LineComponent? = rememberAxisTickComponent(), tickLength: Dp = Defaults.AXIS_TICK_LENGTH.dp, guideline: LineComponent? = rememberAxisGuidelineComponent(), itemPlacer: VerticalAxis.ItemPlacer = remember { VerticalAxis.ItemPlacer.step() }, sizeConstraint: BaseAxis.SizeConstraint = remember { BaseAxis.SizeConstraint.Auto() }, titleComponent: TextComponent? = null, title: CharSequence? = null): VerticalAxis<Axis.Position.Vertical.Start>

Creates and remembers a start VerticalAxis.

Link copied to clipboard
@Composable
fun HorizontalAxis.Companion.rememberTop(line: LineComponent? = rememberAxisLineComponent(), label: TextComponent? = rememberAxisLabelComponent(), labelRotationDegrees: Float = Defaults.AXIS_LABEL_ROTATION_DEGREES, valueFormatter: CartesianValueFormatter = remember { CartesianValueFormatter.decimal() }, tick: LineComponent? = rememberAxisTickComponent(), tickLength: Dp = Defaults.AXIS_TICK_LENGTH.dp, guideline: LineComponent? = rememberAxisGuidelineComponent(), itemPlacer: HorizontalAxis.ItemPlacer = remember { HorizontalAxis.ItemPlacer.aligned() }, sizeConstraint: BaseAxis.SizeConstraint = remember { BaseAxis.SizeConstraint.Auto() }, titleComponent: TextComponent? = null, title: CharSequence? = null): HorizontalAxis<Axis.Position.Horizontal.Top>

Creates and remembers a top HorizontalAxis.