multiplatform/com.patrykandpatrick.vico.multiplatform.common

Package-level declarations

Types

AdditionScope

fun interface AdditionScope<E>

Facilitates adding elements to a collection.

Bounded

interface Bounded

Defines an abstract component that has some physical bounds.

DashedShape

class DashedShape(val shape: Shape = RectangleShape, val dashLength: Dp = Defaults.DASHED_SHAPE_DASH_LENGTH.dp, val gapLength: Dp = Defaults.DASHED_SHAPE_GAP_LENGTH.dp, val fitStrategy: DashedShape.FitStrategy = FitStrategy.Resize) : Shape

DashedShape draws a dashed line by interchangeably drawing the provided shape and leaving a gap.

DrawingContext

interface DrawingContext : MeasuringContext

A MeasuringContext extension with a Canvas reference.

Fill

class Fill

Stores fill properties.

HorizontalLegend

open class HorizontalLegend<M : MeasuringContext, D : DrawingContext>(items: AdditionScope<LegendItem>.(ExtraStore) -> Unit, iconSize: Dp = Defaults.LEGEND_ICON_SIZE.dp, iconLabelSpacing: Dp = Defaults.LEGEND_ICON_LABEL_SPACING.dp, rowSpacing: Dp = Defaults.LEGEND_ROW_SPACING.dp, columnSpacing: Dp = Defaults.LEGEND_COLUMN_SPACING.dp, padding: Insets = Insets.Zero) : Legend<M, D>

HorizontalLegend displays legend items beside one another in lines.

Insets

@Immutable

class Insets(val start: Dp = 0f.dp, val top: Dp = 0f.dp, val end: Dp = 0f.dp, val bottom: Dp = 0f.dp)

Stores inset sizes for the sides of a rectangle. Used for margins and padding.

LayeredComponent

open class LayeredComponent(back: Component, front: Component, padding: Insets = Insets.Zero, margins: Insets = Insets.Zero) : Component

Draws two Components on top of each other.

Legend

@Immutable

interface Legend<M : MeasuringContext, D : DrawingContext> : Bounded

Defines the functions required by the library to draw a chart legend.

LegendItem

open class LegendItem(val icon: Component, val labelComponent: TextComponent, val label: CharSequence)

Defines the appearance of an item of a Legend.

MarkerCornerBasedShape

open class MarkerCornerBasedShape(val base: CornerBasedShape, val tickSize: Dp = MARKER_TICK_SIZE.dp) : Shape

A CornerBasedShape wrapper that additionally draws a triangular tick.

MeasuringContext

interface MeasuringContext

Holds data used for measuring and drawing.

MutableDrawScope

class MutableDrawScope(baseDrawScope: DrawScope) : DrawScope

A DrawScope implementation with a mutable size.

Point

@JvmInline

value class Point

Represents a point in a coordinate system.

Position

object Position

Defines the relative position of an object.

VerticalLegend

open class VerticalLegend<M : MeasuringContext, D : DrawingContext>(items: AdditionScope<LegendItem>.(ExtraStore) -> Unit, iconSize: Dp = Defaults.LEGEND_ICON_SIZE.dp, iconLabelSpacing: Dp = Defaults.LEGEND_ICON_LABEL_SPACING.dp, rowSpacing: Dp = Defaults.LEGEND_ROW_SPACING.dp, padding: Insets = Insets.Zero) : Legend<M, D>

VerticalLegend displays legend items in a vertical list.

VicoTheme

data class VicoTheme(val candlestickCartesianLayerColors: VicoTheme.CandlestickCartesianLayerColors, val columnCartesianLayerColors: List<Color>, val lineCartesianLayerColors: List<Color> = columnCartesianLayerColors, val lineColor: Color, val textColor: Color)

Houses default chart colors.

Properties

vicoTheme

@get:Composable

val vicoTheme: VicoTheme

The current VicoTheme.

Functions

ProvideVicoTheme

@Composable

fun ProvideVicoTheme(theme: VicoTheme, content: @Composable () -> Unit)

Provides a VicoTheme.

rememberHorizontalLegend

@Composable

fun <M : MeasuringContext, D : DrawingContext> rememberHorizontalLegend(items: AdditionScope<LegendItem>.(ExtraStore) -> Unit, iconSize: Dp = Defaults.LEGEND_ICON_SIZE.dp, iconLabelSpacing: Dp = Defaults.LEGEND_ICON_LABEL_SPACING.dp, rowSpacing: Dp = Defaults.LEGEND_ROW_SPACING.dp, columnSpacing: Dp = Defaults.LEGEND_COLUMN_SPACING.dp, padding: Insets = Insets.Zero): HorizontalLegend<M, D>

Creates and remembers a HorizontalLegend.

rememberVerticalLegend

@Composable

fun <M : MeasuringContext, D : DrawingContext> rememberVerticalLegend(items: AdditionScope<LegendItem>.(ExtraStore) -> Unit, iconSize: Dp = Defaults.LEGEND_ICON_SIZE.dp, iconLabelSpacing: Dp = Defaults.LEGEND_ICON_LABEL_SPACING.dp, rowSpacing: Dp = Defaults.LEGEND_ROW_SPACING.dp, padding: Insets = Insets.Zero): VerticalLegend<M, D>

Creates and remembers a VerticalLegend.