core/com.patrykandpatrick.vico.core.cartesian/CartesianChart

CartesianChart

@Stable
open class CartesianChart : CartesianLayerMarginUpdater<CartesianChartModel>

A chart based on a Cartesian coordinate plane, composed of CartesianLayers.

Constructors

Link copied to clipboard
constructor(vararg layers: CartesianLayer<*>, startAxis: Axis<Axis.Position.Vertical.Start>? = null, topAxis: Axis<Axis.Position.Horizontal.Top>? = null, endAxis: Axis<Axis.Position.Vertical.End>? = null, bottomAxis: Axis<Axis.Position.Horizontal.Bottom>? = null, marker: CartesianMarker? = null, markerVisibilityListener: CartesianMarkerVisibilityListener? = null, layerPadding: (ExtraStore) -> CartesianLayerPadding = { CartesianLayerPadding() }, legend: Legend<CartesianMeasuringContext, CartesianDrawingContext>? = null, fadingEdges: FadingEdges? = null, decorations: List<Decoration> = emptyList(), persistentMarkers: CartesianChart.PersistentMarkerScope.(ExtraStore) -> Unit? = null, getXStep: (CartesianChartModel) -> Double = { it.getXDeltaGcd() })

Creates a CartesianChart.

Types

Link copied to clipboard
fun interface PersistentMarkerScope

Facilitates adding persistent CartesianMarkers to CartesianCharts.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val layers: List<CartesianLayer<*>>

The CartesianLayers of which this CartesianChart is composed.

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun copy(vararg layers: CartesianLayer<*> = this.layers.toTypedArray(), startAxis: Axis<Axis.Position.Vertical.Start>? = this.startAxis, topAxis: Axis<Axis.Position.Horizontal.Top>? = this.topAxis, endAxis: Axis<Axis.Position.Vertical.End>? = this.endAxis, bottomAxis: Axis<Axis.Position.Horizontal.Bottom>? = this.bottomAxis, marker: CartesianMarker? = this.marker, markerVisibilityListener: CartesianMarkerVisibilityListener? = this.markerVisibilityListener, layerPadding: (ExtraStore) -> CartesianLayerPadding = this.layerPadding, legend: Legend<CartesianMeasuringContext, CartesianDrawingContext>? = this.legend, fadingEdges: FadingEdges? = this.fadingEdges, decorations: List<Decoration> = this.decorations, persistentMarkers: CartesianChart.PersistentMarkerScope.(ExtraStore) -> Unit? = this.persistentMarkers, getXStep: (CartesianChartModel) -> Double = this.getXStep): CartesianChart

Creates a new CartesianChart based on this one.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun updateHorizontalLayerMargins(context: CartesianMeasuringContext, horizontalLayerMargins: HorizontalCartesianLayerMargins, layerHeight: Float, model: CartesianChartModel)

Ensures that there are sufficient horizontal CartesianLayer-area margins.

Link copied to clipboard
open override fun updateLayerMargins(context: CartesianMeasuringContext, layerMargins: CartesianLayerMargins, layerDimensions: CartesianLayerDimensions, model: CartesianChartModel)

Ensures that there are sufficient CartesianLayer-area margins.