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

ColumnCartesianLayer

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

Displays data as vertical bars.

Constructors

ColumnCartesianLayer

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())

Types

interface ColumnProvider

Provides column LineComponents to ColumnCartesianLayers.

sealed interface MergeMode

Defines how a ColumnCartesianLayer should draw columns in column collections.

Properties

columnCollectionSpacingDp

var columnCollectionSpacingDp: Float

the spacing between neighboring column collections (in dp).

var columnProvider: ColumnCartesianLayer.ColumnProvider

provides the column LineComponents.

var dataLabel: TextComponent?

the TextComponent for the data labels. Use null for no data labels.

dataLabelRotationDegrees

var dataLabelRotationDegrees: Float

the rotation of the data labels (in degrees).

dataLabelValueFormatter

var dataLabelValueFormatter: CartesianValueFormatter

the CartesianValueFormatter for the data labels.

dataLabelVerticalPosition

var dataLabelVerticalPosition: VerticalPosition

the vertical position of each data label relative to its column’s top edge.

drawingModelInterpolator

var drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<ColumnCartesianLayerDrawingModel.ColumnInfo, ColumnCartesianLayerDrawingModel>

interpolates the ColumnCartesianLayer’s ColumnCartesianLayerDrawingModels.

open override val markerTargets: Map<Double, List<CartesianMarker.Target>>

Links x values to CartesianMarker.Targets.

var mergeMode: (ExtraStore) -> ColumnCartesianLayer.MergeMode

defines how columns should be drawn in column collections.

var rangeProvider: CartesianLayerRangeProvider

defines the x and y ranges.

verticalAxisPosition

var verticalAxisPosition: Axis.Position.Vertical?

the position of the VerticalAxis with which the ColumnCartesianLayer should be associated. Use this for independent CartesianLayer scaling.

Functions

prepareForTransformation

open override fun prepareForTransformation(model: ColumnCartesianLayerModel?, ranges: CartesianChartRanges, extraStore: MutableExtraStore)

Prepares the CartesianLayer for a difference animation.

open suspend override fun transform(extraStore: MutableExtraStore, fraction: Float)

Carries out the pending difference animation.

updateHorizontalDimensions

open override fun updateHorizontalDimensions(context: CartesianMeasuringContext, horizontalDimensions: MutableHorizontalDimensions, model: ColumnCartesianLayerModel)

Updates horizontalDimensions to match this CartesianLayer’s dimensions.

open override fun updateRanges(ranges: MutableCartesianChartRanges, model: ColumnCartesianLayerModel)

Updates ranges in accordance with model.