core/com.patrykandpatrick.vico.core.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.

Dimensions

@Immutable

data class Dimensions(val startDp: Float = 0.0f, val topDp: Float = 0.0f, val endDp: Float = 0.0f, val bottomDp: Float = 0.0f)

Defines the size of each edge of a rectangle. Used to store measurements such as padding or margin values.

DrawingContext

interface DrawingContext : MeasuringContext

A MeasuringContext extension with a Canvas reference.

Fill

class Fill

Stores fill properties.

HorizontalInsets

interface HorizontalInsets

Used to apply horizontal insets.

HorizontalLegend

open class HorizontalLegend<M : MeasuringContext, D : DrawingContext>(items: AdditionScope<LegendItem>.(ExtraStore) -> Unit, iconSizeDp: Float, iconPaddingDp: Float, lineSpacingDp: Float = 0.0f, spacingDp: Float = 0.0f, padding: Dimensions = Dimensions.Empty) : Legend<M, D>

HorizontalLegend displays legend items beside one another in lines.

HorizontalPosition

enum HorizontalPosition : Enum<HorizontalPosition>

Defines the horizontal position of a drawn object relative to a given point.

Insets

class Insets : HorizontalInsets

Used to apply insets.

LayeredComponent

open class LayeredComponent(rear: Component, front: Component, padding: Dimensions = Dimensions.Empty, margins: Dimensions = Dimensions.Empty) : Component

Draws two Components, rear and front, on top of each other. padding defines the padding between them.

Legend

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.

MeasuringContext

interface MeasuringContext

Holds data used for measuring and drawing.

MutableMeasuringContext

open class MutableMeasuringContext(val canvasBounds: RectF, var density: Float, var isLtr: Boolean, var spToPx: (Float) -> Float) : MeasuringContext

A MeasuringContext implementation that facilitates the mutation of some of its properties.

Point

@JvmInline

value class Point

Represents a point in a coordinate system.

VerticalLegend

open class VerticalLegend<M : MeasuringContext, D : DrawingContext>(items: AdditionScope<LegendItem>.(ExtraStore) -> Unit, iconSizeDp: Float, iconPaddingDp: Float, spacingDp: Float = 0.0f, padding: Dimensions = Dimensions.Empty) : Legend<M, D>

VerticalLegend displays legend items in a vertical list.

VerticalPosition

enum VerticalPosition : Enum<VerticalPosition>

Defines the vertical position of a drawn object relative to a given point.

Functions

Point

fun Point(x: Float, y: Float): Point

fun Point(x: Int, y: Int): Point

Creates a new Point with the provided coordinates.