charts/io.github.hdcharts.core.style/ChartGradient/Linear

Linear

data class Linear(val stops: ImmutableList<GradientStop>, val start: GradientPoint, val end: GradientPoint, val span: GradientSpan, val tileMode: TileMode) : ChartGradient(source)

A gradient along the line from start to end.

Constructors

constructor(stops: ImmutableList<GradientStop>, start: GradientPoint, end: GradientPoint, span: GradientSpan, tileMode: TileMode)

constructor(stops: List<GradientStop>, start: GradientPoint, end: GradientPoint, span: GradientSpan, tileMode: TileMode)

Copies the supplied stops into an immutable list.

Properties

val end: GradientPoint

End position as fractions of the selected bounds.

open override val span: GradientSpan

The bounds the gradient's positions are fractions of.

val start: GradientPoint

Start position as fractions of the selected bounds.

open override val stops: ImmutableList<GradientStop>

The colors along the gradient, with offsets in 0..1. Offsets outside that range are clamped, stops out of order are sorted, and a stop with a non-finite offset is dropped. A single stop paints its color solid, and no stops draw the shape without a gradient.

val tileMode: TileMode

How the gradient continues beyond start and end.

Functions

fun ChartGradient.clamp(): ChartGradient?

Returns this made drawable, or null when it cannot be drawn, so the shape is solid.