APIGitHub

CartesianMarker

Overview

CartesianMarkers highlight points on CartesianCharts. There are two types of CartesianMarker:

  • Standard CartesianMarkers are shown on tap. These are added to CartesianCharts via the marker constructor parameter.

  • Persistent CartesianMarkers are shown permanently at given x-values. Such CartesianMarkers are added to CartesianCharts via the persistentMarkers constructor parameter.

There are two ways of creating a CartesianMarker:

  • using DefaultCartesianMarker, described below

  • creating a custom implementation of the interface

DefaultCartesianMarker

A common means of creating CartesianMarkers is DefaultCartesianMarker, which accepts three main components—a label, a point indicator, and a vertical line—and offers several customization options.

A DefaultCartesianMarker’s label text is created by its DefaultCartesianMarker.ValueFormatter. A dedicated formatting contract is required here because CartesianMarkers can highlight multiple points at once. The general principle is the same as with CartesianValueFormatter, but the required information must first be retrieved from targets.

A base DefaultCartesianMarker.ValueFormatter implementation can be instantiated via DefaultCartesianMarker.ValueFormatter.default. This implementation uses DecimalFormat to format y-values. You can provide a custom DecimalFormat instance and toggle the color-coding of y-values. The former enables you not only to change how the y-values themselves are formatted, but also to add prefixes and suffixes.

DefaultCartesianMarker is open for subclassing.

Learn about DefaultCartesianMarker creation in Compose.

CartesianMarkerVisibilityListener

You can listen for visibility changes of standard CartesianMarkers via CartesianMarkerVisibilityListener.

CartesianMarkerController

By default, a standard CartesianMarker appears on press and disappears on release. You can customize this with CartesianMarkerController, which has two built-in implementations, accessed via the following:

With the latter, the CartesianMarker’s visibility is toggled on tap, providing greater persistence. For more specific behavior, create a custom implementation.

CartesianMarker.Target

CartesianMarkers use CartesianMarker.Targets, which hold information on the highlighted points. They are stored in lists (called targets), since several points may be highlighted at once.

CartesianMarker.Target itself includes only general properties. More data is found in its implementations, each of which corresponds to a CartesianLayer: CandlestickCartesianLayerMarkerTarget, ColumnCartesianLayerMarkerTarget, and LineCartesianLayerMarkerTarget.

In general, you should take the following approach when working with targets:

  • If you know that only one point can be highlighted at once, use targets.first(). (This occurs when each point has a unique pixel x-coordinate—for example, when only a single-series LineCartesianLayerMarkerTarget is present.) Otherwise, iterate targets.

  • If you know that only one kind of CartesianMarker.Target is present, use casting. (This occurs when only one kind of CartesianLayer is in use.) Otherwise, use type checking (when with is).

PreviousCartesianValueFormatterNextDecoration

Last updated