core/com.patrykandpatrick.vico.core.component.marker/MarkerComponent

MarkerComponent

open class MarkerComponent(val label: TextComponent, val indicator: Component?, val guideline: LineComponent?) : Marker

The default implementation of the Marker interface.

Parameters

label

the TextComponent used to draw the label.

indicator

an optional indicator drawn at a given point belonging to the data entry.

guideline

an optional line drawn from the bottom of the chart to the bottom edge of the label.

Constructors

MarkerComponent

constructor(label: TextComponent, indicator: Component?, guideline: LineComponent?)

Properties

guideline

val guideline: LineComponent?

indicator

val indicator: Component?

indicatorSizeDp

var indicatorSizeDp: Float

The indicator size (in dp).

label

val label: TextComponent

labelFormatter

var labelFormatter: MarkerLabelFormatter

The MarkerLabelFormatter for this marker.

onApplyEntryColor

var onApplyEntryColor: (entryColor: Int) -> Unit?

An optional lambda function that allows for applying the color associated with a given data entry to a Component.

Functions

draw

open override fun draw(context: DrawContext, bounds: RectF, markedEntries: List<Marker.EntryModel>, chartValuesProvider: ChartValuesProvider)

Draws the marker.

getInsets

open override fun getInsets(context: MeasureContext, outInsets: Insets, horizontalDimensions: HorizontalDimensions)

Called during the measurement phase, before getHorizontalInsets. Both horizontal and vertical insets can be requested from this function. The final inset for a given edge of the associated Chart is the largest of the insets requested for the edge.