core/com.patrykandpatrick.vico.core.chart/BaseChart

BaseChart

abstract class BaseChart<in Model : ChartEntryModel> : Chart<Model> , BoundsAware

A base implementation of Chart.

See also

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
open override var axisValuesOverrider: AxisValuesOverrider<@UnsafeVariance Model>?

Overrides the minimum and maximum x-axis and y-axis values. In the case of ColumnCharts and LineCharts contained in ComposedCharts, these overrides can be applied to one vertical axis instead of both. Use ColumnChart.targetVerticalAxisPosition and LineChart.targetVerticalAxisPosition for this purpose.

Link copied to clipboard
open override val bounds: RectF

The bounds of the abstract component.

Link copied to clipboard
open override val chartInsetters: Collection<ChartInsetter>

A Collection of the ChartInsetters that are part of this Chart. Each ChartInsetter can influence the final layout of the chart and its components.

Link copied to clipboard
open override var maxX: Float?

The maximum value shown on the x-axis. If Model implements ChartEntryModel, and maxX is not null, this overrides ChartEntryModel.maxX.

Link copied to clipboard
open override var maxY: Float?

The maximum value shown on the y-axis. If Model implements ChartEntryModel, and maxY is not null, this overrides ChartEntryModel.maxY.

Link copied to clipboard
open override var minX: Float?

The minimum value shown on the x-axis. If Model implements ChartEntryModel, and minX is not null, this overrides ChartEntryModel.minX.

Link copied to clipboard
open override var minY: Float?

The minimum value shown on the y-axis. If Model implements ChartEntryModel, and minY is not null, this overrides ChartEntryModel.minY.

Functions

Link copied to clipboard
open override fun addDecoration(decoration: Decoration): Boolean

Adds a Decoration to this Chart.

Link copied to clipboard
open override fun addPersistentMarker(x: Float, marker: Marker)

Adds a persistent Marker to this Chart. The Marker will be anchored to the given x value on the x-axis.

Link copied to clipboard
open override fun drawNonScrollableContent(context: ChartDrawContext, model: Model)

Responsible for drawing any decorations placed above the chart, as well as persistent markers.

Link copied to clipboard
open override fun drawScrollableContent(context: ChartDrawContext, model: Model)

Responsible for drawing the chart itself and any decorations behind it.

Link copied to clipboard
open override fun removeDecoration(decoration: Decoration): Boolean

Removes a Decoration from this Chart.

Link copied to clipboard
open override fun removePersistentMarker(x: Float)

Removes a persistent Marker from this Chart.

Link copied to clipboard
open override fun setDecorations(decorations: List<Decoration>)

Replaces the current list of decorations with the provided decorations.

Link copied to clipboard
open override fun setPersistentMarkers(markers: Map<Float, Marker>)

Replaces the current map of markers with the provided markers.