multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian.layer

Package-level declarations

Types

Link copied to clipboard
abstract class BaseCartesianLayer<T : CartesianLayerModel> : CartesianLayer<T>

A base CartesianLayer implementation.

Link copied to clipboard
@Stable
open class CandlestickCartesianLayer : BaseCartesianLayer<CandlestickCartesianLayerModel>

Draws the content of candlestick charts.

Link copied to clipboard
interface CartesianLayer<M : CartesianLayerModel> : CartesianLayerMarginUpdater<M>

Visualizes data on a Cartesian plane. CartesianLayers are combined and drawn by CartesianCharts.

Link copied to clipboard
interface CartesianLayerDimensions

Stores shared CartesianLayer dimensions.

Link copied to clipboard
class CartesianLayerMargins : HorizontalCartesianLayerMargins

Stores the sizes of CartesianLayer-area margins.

Link copied to clipboard
interface CartesianLayerMarginUpdater<M>

Enables a CartesianChart component to make room for itself around the CartesianLayer area.

Link copied to clipboard
@Immutable
class CartesianLayerPadding(val scalableStart: Dp = 0f.dp, val scalableEnd: Dp = 0f.dp, val unscalableStart: Dp = 0f.dp, val unscalableEnd: Dp = 0f.dp)

Stores CartesianLayer padding sizes. Scalable padding depends on the zoom factor.

Link copied to clipboard
@Stable
open class ColumnCartesianLayer : BaseCartesianLayer<ColumnCartesianLayerModel>

Displays data as vertical bars.

Link copied to clipboard
interface HorizontalCartesianLayerMargins

Stores the sizes of horizontal CartesianLayer-area margins.

Link copied to clipboard
@Stable
open class LineCartesianLayer : BaseCartesianLayer<LineCartesianLayerModel>

Draws the content of line charts.

Link copied to clipboard
class MutableCartesianLayerDimensions(var xSpacing: Float = 0.0f, var scalableStartPadding: Float = 0.0f, var scalableEndPadding: Float = 0.0f, var unscalableStartPadding: Float = 0.0f, var unscalableEndPadding: Float = 0.0f) : CartesianLayerDimensions

An implementation of CartesianLayerDimensions whose every property is mutable.

Functions

Link copied to clipboard
@Composable
@Stable
fun CandlestickCartesianLayer.CandleProvider.Companion.absolute(bullish: CandlestickCartesianLayer.Candle = Candle.sharpFilledCandle(vicoTheme.candlestickCartesianLayerColors.bullish), neutral: CandlestickCartesianLayer.Candle = bullish.copyWithColor(vicoTheme.candlestickCartesianLayerColors.neutral), bearish: CandlestickCartesianLayer.Candle = bullish.copyWithColor(vicoTheme.candlestickCartesianLayerColors.bearish)): CandlestickCartesianLayer.CandleProvider

An alias for CandlestickCartesianLayer.CandleProvider.Companion.absolute with default arguments.

Link copied to clipboard
@Composable
@Stable
fun CandlestickCartesianLayer.CandleProvider.Companion.absoluteRelative(absolutelyBullishRelativelyBullish: CandlestickCartesianLayer.Candle = Candle.sharpHollowCandle(vicoTheme.candlestickCartesianLayerColors.bullish), absolutelyBullishRelativelyNeutral: CandlestickCartesianLayer.Candle = absolutelyBullishRelativelyBullish.copyWithColor( vicoTheme.candlestickCartesianLayerColors.neutral ), absolutelyBullishRelativelyBearish: CandlestickCartesianLayer.Candle = absolutelyBullishRelativelyBullish.copyWithColor( vicoTheme.candlestickCartesianLayerColors.bearish ), absolutelyNeutralRelativelyBullish: CandlestickCartesianLayer.Candle = absolutelyBullishRelativelyBullish, absolutelyNeutralRelativelyNeutral: CandlestickCartesianLayer.Candle = absolutelyBullishRelativelyNeutral, absolutelyNeutralRelativelyBearish: CandlestickCartesianLayer.Candle = absolutelyBullishRelativelyBearish, absolutelyBearishRelativelyBullish: CandlestickCartesianLayer.Candle = Candle.sharpFilledCandle(vicoTheme.candlestickCartesianLayerColors.bullish), absolutelyBearishRelativelyNeutral: CandlestickCartesianLayer.Candle = absolutelyBearishRelativelyBullish.copyWithColor( vicoTheme.candlestickCartesianLayerColors.neutral ), absolutelyBearishRelativelyBearish: CandlestickCartesianLayer.Candle = absolutelyBearishRelativelyBullish.copyWithColor( vicoTheme.candlestickCartesianLayerColors.bearish )): CandlestickCartesianLayer.CandleProvider

An alias for CandlestickCartesianLayer.CandleProvider.Companion.absoluteRelative with default arguments.

Link copied to clipboard
@Composable
fun rememberCandlestickCartesianLayer(candleProvider: CandlestickCartesianLayer.CandleProvider = CandlestickCartesianLayer.CandleProvider.absolute(), minCandleBodyHeight: Dp = Defaults.MIN_CANDLE_BODY_HEIGHT_DP.dp, candleSpacing: Dp = Defaults.CANDLE_SPACING_DP.dp, scaleCandleWicks: Boolean = false, rangeProvider: CartesianLayerRangeProvider = remember { CartesianLayerRangeProvider.auto() }, verticalAxisPosition: Axis.Position.Vertical? = null, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<CandlestickCartesianLayerDrawingModel.Entry, CandlestickCartesianLayerDrawingModel> = CartesianLayerDrawingModelInterpolator.default()): CandlestickCartesianLayer

Creates and remembers a CandlestickCartesianLayer.

Link copied to clipboard
@Composable
fun rememberColumnCartesianLayer(columnProvider: ColumnCartesianLayer.ColumnProvider = ColumnCartesianLayer.ColumnProvider.series( vicoTheme.columnCartesianLayerColors.map { color -> rememberLineComponent(Fill(color), Defaults.COLUMN_WIDTH.dp) } ), columnCollectionSpacing: Dp = Defaults.COLUMN_COLLECTION_SPACING.dp, mergeMode: (ExtraStore) -> ColumnCartesianLayer.MergeMode = { MergeMode.Grouped() }, dataLabel: TextComponent? = null, dataLabelPosition: Position.Vertical = Position.Vertical.Top, dataLabelValueFormatter: CartesianValueFormatter = remember { CartesianValueFormatter.decimal() }, dataLabelRotationDegrees: Float = 0.0f, rangeProvider: CartesianLayerRangeProvider = remember { CartesianLayerRangeProvider.auto() }, verticalAxisPosition: Axis.Position.Vertical? = null, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<ColumnCartesianLayerDrawingModel.Entry, ColumnCartesianLayerDrawingModel> = remember { CartesianLayerDrawingModelInterpolator.default() }): ColumnCartesianLayer

Creates and remembers a ColumnCartesianLayer.

Link copied to clipboard
@Composable
fun LineCartesianLayer.Companion.rememberLine(fill: LineCartesianLayer.LineFill = vicoTheme.lineCartesianLayerColors.first().let { color -> remember(color) { LineCartesianLayer.LineFill.single(Fill(color)) } }, stroke: LineCartesianLayer.LineStroke = LineCartesianLayer.LineStroke.Continuous(), areaFill: LineCartesianLayer.AreaFill? = null, pointProvider: LineCartesianLayer.PointProvider? = null, pointConnector: LineCartesianLayer.PointConnector = PointConnector.Sharp, dataLabel: TextComponent? = null, dataLabelPosition: Position.Vertical = Position.Vertical.Top, dataLabelValueFormatter: CartesianValueFormatter = remember { CartesianValueFormatter.decimal() }, dataLabelRotationDegrees: Float = 0.0f): LineCartesianLayer.Line

Creates and remembers a LineCartesianLayer.Line.

Link copied to clipboard
@Composable
fun rememberLineCartesianLayer(lineProvider: LineCartesianLayer.LineProvider = LineCartesianLayer.LineProvider.series( vicoTheme.lineCartesianLayerColors.map { color -> LineCartesianLayer.rememberLine(LineCartesianLayer.LineFill.single(Fill(color))) } ), pointSpacing: Dp = Defaults.POINT_SPACING.dp, rangeProvider: CartesianLayerRangeProvider = remember { CartesianLayerRangeProvider.auto() }, verticalAxisPosition: Axis.Position.Vertical? = null, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<LineCartesianLayerDrawingModel.Entry, LineCartesianLayerDrawingModel> = remember { CartesianLayerDrawingModelInterpolator.default() }): LineCartesianLayer

Creates and remembers a LineCartesianLayer.