core/com.patrykandpatrick.vico.core.common.component/LineComponent

LineComponent

open class LineComponent(color: Int, var thicknessDp: Float = Defaults.LINE_COMPONENT_THICKNESS_DP, val shape: Shape = Rectangle, val dynamicShader: DynamicShader? = null, val margins: Dimensions = Dimensions.Empty, val strokeWidthDp: Float = 0.0f, strokeColor: Int = Color.TRANSPARENT) : ShapeComponent

Draws a line.

Constructors

LineComponent

constructor(color: Int, thicknessDp: Float = Defaults.LINE_COMPONENT_THICKNESS_DP, shape: Shape = Rectangle, dynamicShader: DynamicShader? = null, margins: Dimensions = Dimensions.Empty, strokeWidthDp: Float = 0.0f, strokeColor: Int = Color.TRANSPARENT)

Properties

color

var color: Int

The color of the shape.

dynamicShader

val dynamicShader: DynamicShader? = null

margins

open override val margins: Dimensions

shape

val shape: Shape

solidOrStrokeColor

val solidOrStrokeColor: Int

color if it’s not Color.TRANSPARENT, and strokeColor otherwise.

strokeColor

var strokeColor: Int

The color of the stroke.

strokeWidthDp

val strokeWidthDp: Float = 0.0f

thicknessDp

var thicknessDp: Float

the thickness of the line.

Functions

clearShadow

fun clearShadow(): ShapeComponent

Removes this ShapeComponent’s drop shadow.

copy

open fun copy(color: Int = this.color, thicknessDp: Float = this.thicknessDp, shape: Shape = this.shape, dynamicShader: DynamicShader? = this.dynamicShader, margins: Dimensions = this.margins, strokeWidthDp: Float = this.strokeWidthDp, strokeColor: Int = this.strokeColor): LineComponent

Creates a new LineComponent based on this one.

draw

open override fun draw(context: DrawContext, left: Float, top: Float, right: Float, bottom: Float, opacity: Float)

Instructs the Component to draw itself at the given coordinates.

drawHorizontal

open fun drawHorizontal(context: DrawContext, left: Float, right: Float, centerY: Float, thicknessScale: Float = 1.0f, opacity: Float = 1.0f)

A convenience function for draw that draws the LineComponent horizontally.

drawVertical

open fun drawVertical(context: DrawContext, top: Float, bottom: Float, centerX: Float, thicknessScale: Float = 1.0f, opacity: Float = 1.0f)

A convenience function for draw that draws the LineComponent vertically.

fitsInHorizontal

open fun fitsInHorizontal(context: DrawContext, left: Float, right: Float, centerY: Float, boundingBox: RectF, thicknessScale: Float = 1.0f): Boolean

Checks whether the LineComponent fits horizontally within the given boundingBox with its current thicknessDp.

fitsInVertical

open fun fitsInVertical(context: DrawContext, top: Float, bottom: Float, centerX: Float, boundingBox: RectF, thicknessScale: Float = 1.0f): Boolean

Checks whether the LineComponent fits vertically within the given boundingBox with its current thicknessDp.

intersectsVertical

open fun intersectsVertical(context: DrawContext, top: Float, bottom: Float, centerX: Float, boundingBox: RectF, thicknessScale: Float = 1.0f): Boolean

Checks whether the LineComponent vertically intersects the given boundingBox with its current thicknessDp.

setShadow

fun setShadow(radius: Float, dx: Float = 0.0f, dy: Float = 0.0f, color: Int = Defaults.SHADOW_COLOR, applyElevationOverlay: Boolean = false): ShapeComponent

Applies a drop shadow.