core/com.patrykandpatrick.vico.core.cartesian.layer/ColumnCartesianLayer

ColumnCartesianLayer

@Stable
open class ColumnCartesianLayer : BaseCartesianLayer<ColumnCartesianLayerModel>

Displays data as vertical bars.

Constructors

Link copied to clipboard
constructor(columnProvider: ColumnCartesianLayer.ColumnProvider, columnCollectionSpacingDp: Float = Defaults.COLUMN_COLLECTION_SPACING, mergeMode: (ExtraStore) -> ColumnCartesianLayer.MergeMode = { MergeMode.Grouped() }, dataLabel: TextComponent? = null, dataLabelVerticalPosition: VerticalPosition = VerticalPosition.Top, dataLabelValueFormatter: CartesianValueFormatter = CartesianValueFormatter.decimal(), dataLabelRotationDegrees: Float = 0.0f, rangeProvider: CartesianLayerRangeProvider = CartesianLayerRangeProvider.auto(), verticalAxisPosition: Axis.Position.Vertical? = null, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<ColumnCartesianLayerDrawingModel.ColumnInfo, ColumnCartesianLayerDrawingModel> = CartesianLayerDrawingModelInterpolator.default())

Creates a ColumnCartesianLayer.

Types

Link copied to clipboard
Link copied to clipboard
@Immutable
sealed interface MergeMode

Defines how a ColumnCartesianLayer should draw columns in column collections.

Properties

Link copied to clipboard
open override val markerTargets: Map<Double, List<CartesianMarker.Target>>

Links x values to CartesianMarker.Targets.

Functions

Link copied to clipboard
fun copy(columnProvider: ColumnCartesianLayer.ColumnProvider = this.columnProvider, columnCollectionSpacingDp: Float = this.columnCollectionSpacingDp, mergeMode: (ExtraStore) -> ColumnCartesianLayer.MergeMode = this.mergeMode, dataLabel: TextComponent? = this.dataLabel, dataLabelVerticalPosition: VerticalPosition = this.dataLabelVerticalPosition, dataLabelValueFormatter: CartesianValueFormatter = this.dataLabelValueFormatter, dataLabelRotationDegrees: Float = this.dataLabelRotationDegrees, rangeProvider: CartesianLayerRangeProvider = this.rangeProvider, verticalAxisPosition: Axis.Position.Vertical? = this.verticalAxisPosition, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<ColumnCartesianLayerDrawingModel.ColumnInfo, ColumnCartesianLayerDrawingModel> = this.drawingModelInterpolator): ColumnCartesianLayer

Creates a new ColumnCartesianLayer 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 prepareForTransformation(model: ColumnCartesianLayerModel?, ranges: CartesianChartRanges, extraStore: MutableExtraStore)

Prepares the CartesianLayer for a difference animation.

Link copied to clipboard
open suspend override fun transform(extraStore: MutableExtraStore, fraction: Float)

Carries out the pending difference animation.

Link copied to clipboard
open override fun updateHorizontalDimensions(context: CartesianMeasuringContext, horizontalDimensions: MutableHorizontalDimensions, model: ColumnCartesianLayerModel)

Updates horizontalDimensions to match this CartesianLayer’s dimensions.

Link copied to clipboard
open override fun updateRanges(ranges: MutableCartesianChartRanges, model: ColumnCartesianLayerModel)

Updates ranges in accordance with model.