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

ShapeComponent

open class ShapeComponent(val shape: Shape = Shape.Rectangle, color: Int = Color.BLACK, val dynamicShader: DynamicShader? = null, val margins: Dimensions = Dimensions.Empty, val strokeWidthDp: Float = 0.0f, strokeColor: Int = Color.TRANSPARENT) : PaintComponent<ShapeComponent> , Component

ShapeComponent is a Component that draws a shape.

Parameters

shape

the Shape that will be drawn.

color

the color of the shape.

dynamicShader

an optional Shader provider used as the shape’s background.

margins

the Component’s margins.

strokeWidthDp

the width of the shape’s stroke (in dp).

strokeColor

the color of the stroke.

Inheritors

LineComponent

Constructors

ShapeComponent

constructor(shape: Shape = Shape.Rectangle, color: Int = Color.BLACK, 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

strokeColor

var strokeColor: Int

The color of the stroke.

strokeWidthDp

val strokeWidthDp: Float = 0.0f

Functions

clearShadow

fun clearShadow(): ShapeComponent

Removes this ShapeComponent’s drop shadow.

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.

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.