charts/io.github.hdcharts.core.style/GridStyle

GridStyle

data class GridStyle(val visible: Boolean, val steps: Int, val color: Color, val lineWidth: Dp)(source)

Horizontal grid configuration shared by charts with a numeric Y axis.

Constructors

constructor(visible: Boolean, steps: Int, color: Color, lineWidth: Dp)

Properties

val color: Color

The grid line color.

val lineWidth: Dp

The grid line stroke width in density-independent pixels.

Number of horizontal grid intervals when Y labels are hidden. With Y labels shown, the grid draws one line per label. 0 draws no grid.

val visible: Boolean

Whether the grid is visible.

Functions

fun GridStyle.clamp(density: Density): GridStyle

Returns this with GridStyle.steps and GridStyle.lineWidth clamped. Names every field instead of using copy, so a field added to the constructor fails to compile here until it is dealt with.