Vico API

https://www.patrykandpatrick.com/vico/api/stable/
Admin
Unable to extract project information - the page returned a 404 error with no content available.
Tokens:942,943
Snippets:2,240
Trust Score:5.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Insets.start Property

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common/-insets/start

The `start` property of the Insets class represents the size of the start inset. It is defined as a read-only value of type `Dp`.

```APIDOC
Insets:
  start: Dp
    - The start inset’s size.
    - Type: Dp
    - Description: Represents the size of the start inset.
```

--------------------------------

### Key Class and Constructor

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common.data/-extra-store/-key/index

Documentation for the Key class, which is used for writing to and reading from ExtraStores. Includes its primary constructor.

```APIDOC
Key Class:
  open class Key<T : Any>
    Used for writing to and reading from ExtraStores.

  Constructors:
    Key()
      No parameters.
      Returns: void
```

--------------------------------

### Get Start Layer Margin

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.axis/-horizontal-axis/-item-placer/index

Calculates the required start margin for the CartesianLayer area, specifically for the HorizontalAxis. This margin accounts for tick thickness and maximum label width.

```kotlin
abstract fun getStartLayerMargin(
    context: CartesianMeasuringContext,
    layerDimensions: CartesianLayerDimensions,
    tickThickness: Float,
    maxLabelWidth: Float
): Float

Returns the start [CartesianLayer]-area margin required by the [HorizontalAxis].
```

--------------------------------

### Get Start Layer Margin for Horizontal Axis

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian.axis/-horizontal-axis/-item-placer/index

Calculates the required start margin for a CartesianLayer area to accommodate the HorizontalAxis. This margin is essential for preventing axis labels or elements from overlapping with chart content. It takes into account context, layer dimensions, tick thickness, and maximum label width.

```Kotlin
abstract fun getStartLayerMargin(context: CartesianMeasuringContext, layerDimensions: CartesianLayerDimensions, tickThickness: Float, maxLabelWidth: Float): Float

Returns the start [CartesianLayer]-area margin required by the [HorizontalAxis].
```

--------------------------------

### Key Class and Constructor

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.common.data/-extra-store/-key/index

Documentation for the Key class and its primary constructor, used for managing data in ExtraStores. The Key class is generic and designed for writing to and reading from ExtraStore instances.

```APIDOC
open class Key<T : Any>
  Used for writing to and reading from ExtraStores.

  Constructors:
    Key()
      No parameters. Used to create an instance of the Key.
```

--------------------------------

### MutableExtraStore Constructor

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.common.data/-mutable-extra-store/-mutable-extra-store

Creates an empty MutableExtraStore instance. This is the primary way to initialize the store.

```APIDOC
MutableExtraStore:
  constructor()
    Creates an empty [MutableExtraStore](index.html).
    This constructor initializes a new, empty mutable store for extra data.
```

--------------------------------

### Kotlin Start Property Declaration

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian/-scroll/-absolute/-companion/-start

Declares the `Start` property as a `Scroll.Absolute` type within the `Companion` object for `Scroll.Absolute`. This property is noted to correspond to zero.

```Kotlin
val Start: Scroll.Absolute
```

--------------------------------

### Axis Position Vertical Start

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.axis/-axis/-position/-vertical/-start/index

The `Start` data object signifies that a vertical `Axis` is positioned at the beginning of its associated `CartesianChart`. It's part of the `Axis.Position.Vertical` hierarchy.

```kotlin
data object Start : Axis.Position.Vertical
```

--------------------------------

### MutableExtraStore API

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common.data/-mutable-extra-store/index

Provides documentation for the MutableExtraStore class, including its constructor and key methods for managing data.

```APIDOC
class MutableExtraStore : ExtraStore
  - A ExtraStore subclass that allows for data updates.

  constructor()
    - Creates an empty MutableExtraStore.

  fun clear()
    - Removes all stored values.

  fun remove(key: ExtraStore.Key<*>)
    - Removes the value associated with the provided key.

  operator fun <T : Any> set(key: ExtraStore.Key<T>, value: T)
    - Saves the provided value to this MutableExtraStore, associating the value with the given key.
```

--------------------------------

### Create VerticalAxis Start

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.axis/-vertical-axis/-companion/start

Defines the `start` function for creating a `VerticalAxis` on the start side. It allows customization of visual components like lines and labels, as well as behavioral properties such as label positioning, value formatting, and tick length.

```APIDOC
VerticalAxis.Companion.start

fun start(
    line: LineComponent? = null,
    label: TextComponent? = null,
    labelRotationDegrees: Float = 0.0f,
    horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition = Outside,
    verticalLabelPosition: Position.Vertical = Position.Vertical.Center,
    valueFormatter: CartesianValueFormatter = CartesianValueFormatter.decimal(),
    tick: LineComponent? = null,
    tickLengthDp: Float = 0.0f,
    guideline: LineComponent? = null,
    itemPlacer: VerticalAxis.ItemPlacer = ItemPlacer.step(),
    size: BaseAxis.Size = Size.Auto(),
    titleComponent: TextComponent? = null,
    title: CharSequence? = null
): VerticalAxis<Axis.Position.Vertical.Start>

Creates a start VerticalAxis.

Parameters:
- line: Optional `LineComponent` for the axis line.
- label: Optional `TextComponent` for axis labels.
- labelRotationDegrees: Rotation angle for labels in degrees. Defaults to 0.0f.
- horizontalLabelPosition: Position of labels relative to the horizontal axis. Defaults to `Outside`.
- verticalLabelPosition: Position of labels relative to the vertical axis. Defaults to `Center`.
- valueFormatter: Formatter for axis values. Defaults to `CartesianValueFormatter.decimal()`.
- tick: Optional `LineComponent` for axis ticks.
- tickLengthDp: Length of ticks in density-independent pixels. Defaults to 0.0f.
- guideline: Optional `LineComponent` for axis guidelines.
- itemPlacer: Defines how axis items are placed. Defaults to `ItemPlacer.step()`.
- size: Defines the size behavior of the axis. Defaults to `Size.Auto()`.
- titleComponent: Optional `TextComponent` for the axis title.
- title: Optional `CharSequence` for the axis title.
```

--------------------------------

### MutableExtraStore Constructor

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common.data/-mutable-extra-store/-mutable-extra-store

Provides the constructor for the MutableExtraStore class. This constructor creates an empty instance of MutableExtraStore, with no parameters required.

```APIDOC
MutableExtraStore:
  constructor()
    - Creates an empty MutableExtraStore.
```

--------------------------------

### Vico Core and Multiplatform Modules

Source: https://www.patrykandpatrick.com/vico/api/stable/index

Documentation for the Vico core functionalities and multiplatform support, enabling cross-platform development.

```APIDOC
Module: vico/core
Description: The central core functionalities of the Vico library.
Link: vico/core/index.html
```

```APIDOC
Module: vico/multiplatform
Description: Utilities and APIs for building multiplatform applications with Vico.
Link: vico/multiplatform/index.html
```

--------------------------------

### Key Constructor

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.common.data/-extra-store/-key/-key

The default constructor for the Key class. It initializes a new instance of the Key.

```APIDOC
Key:
  constructor()
    - Initializes a new instance of the Key class.
    - Parameters: None
    - Returns: An instance of Key.
```

--------------------------------

### HorizontalCartesianLayerMargins.start API

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian.layer/-horizontal-cartesian-layer-margins/start

API documentation for the abstract Float property 'start' of HorizontalCartesianLayerMargins. This property represents the size of the start margin. It is part of the vico-api-stable project.

```Kotlin
HorizontalCartesianLayerMargins:
  start:
    signature: abstract val start: Float
    description: The start margin’s size.
    type: Float
```

--------------------------------

### CacheStore Class and Methods

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.common.data/-cache-store/index

API documentation for the CacheStore class, including its constructor, inner KeyNamespace class, and core caching functions like getOrNull, getOrSet, and set.

```APIDOC
CacheStore:
  Description: Caches data.

  Constructors:
    @[RestrictTo](https://developer.android.com/reference/kotlin/androidx/annotation/RestrictTo.html)(value = [[RestrictTo.Scope.LIBRARY_GROUP](https://developer.android.com/reference/kotlin/androidx/annotation/RestrictTo.Scope.LIBRARY_GROUP.html)]) constructor()
      Description: Caches data.

  Inner Classes:
    KeyNamespace:
      Description: Identifies a key namespace. These namespaces help prevent interscope key collisions.

  Functions:
    getOrNull:
      Signature: fun <T : Any> getOrNull(keyNamespace: CacheStore.KeyNamespace, vararg keyComponents: Any?): T?
      Description: Retrieves the value associated with the key belonging to the specified namespace and matching the given components. If there’s no such value, `null` is returned.
      Parameters:
        keyNamespace: CacheStore.KeyNamespace - The namespace for the key.
        keyComponents: vararg Any? - Components that form the key.
      Returns: T? - The cached value or null.

    getOrSet:
      Signature: fun <T : Any> getOrSet(keyNamespace: CacheStore.KeyNamespace, vararg keyComponents: Any?, value: () -> T): T
      Description: Retrieves the value associated with the key belonging to the specified namespace and matching the given components. If there’s no such value, `value` is called, and its result is cached and returned.
      Parameters:
        keyNamespace: CacheStore.KeyNamespace - The namespace for the key.
        keyComponents: vararg Any? - Components that form the key.
        value: () -> T - A lambda function that provides the value to be cached if it's not found.
      Returns: T - The cached value or the newly computed value.

    set:
      Signature: operator fun set(keyNamespace: CacheStore.KeyNamespace, vararg keyComponents: Any?, value: Any)
      Description: Caches the provided `value` associated with the key belonging to the specified namespace and matching the given components.
      Parameters:
        keyNamespace: CacheStore.KeyNamespace - The namespace for the key.
        keyComponents: vararg Any? - Components that form the key.
        value: Any - The value to cache.
```

--------------------------------

### Companion Properties for Scroll.Absolute

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian/-scroll/-absolute/-companion/index

Details the 'Start' and 'End' properties of the Scroll.Absolute companion object. 'Start' represents zero scroll value, while 'End' represents the maximum scroll value.

```APIDOC
Scroll.Absolute Companion:

Properties:

val End: Scroll.Absolute
  - Corresponds to the maximum scroll value.

val Start: Scroll.Absolute
  - Corresponds to zero.
```

--------------------------------

### CartesianLayerModel Creation with Partial

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian.data/-cartesian-layer-model/-partial/index

The `Partial` interface in the vico multiplatform library is designed to hold the minimal data necessary for constructing a `CartesianLayerModel`. It offers a `complete` function to facilitate this creation process, allowing the addition of an `ExtraStore`.

```APIDOC
interface Partial
  Stores the minimum amount of data required to create a CartesianLayerModel and facilitates this creation.

  abstract fun complete(extraStore: ExtraStore = ExtraStore.Empty): CartesianLayerModel
    Creates a full CartesianLayerModel with the given ExtraStore from this Partial.
    Parameters:
      extraStore: ExtraStore - The ExtraStore to use (defaults to ExtraStore.Empty).
    Returns:
      CartesianLayerModel - The fully created CartesianLayerModel.
```

--------------------------------

### HorizontalCartesianLayerMargins.start Property

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.layer/-horizontal-cartesian-layer-margins/start

Details the 'start' property of the HorizontalCartesianLayerMargins class, which defines the size of the start margin for Cartesian layers. This property is abstract and returns a Float value representing the margin's size.

```APIDOC
HorizontalCartesianLayerMargins.start
  abstract val start: Float
  - The start margin’s size.
  - Returns: The size of the start margin as a Float.
  - Context: Belongs to the com.patrykandpatrick.vico.core.cartesian.layer package.
```

--------------------------------

### TextComponent.MinWidth Factory Functions

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common.component/-text-component/-min-width/-companion/index

Provides factory functions to create TextComponent.MinWidth instances, allowing configuration of minimum width based on DP values or text content.

```APIDOC
TextComponent.MinWidth.fixed
  fun fixed(value: Dp = 0f.dp): TextComponent.MinWidth
    - Sets the minimum width to the specified DP value.
    - Parameters:
      - value: The minimum width in DP. Defaults to 0dp.
    - Returns: An instance of TextComponent.MinWidth configured with the fixed width.

TextComponent.MinWidth.text
  fun text(text: CharSequence): TextComponent.MinWidth
    - Sets the minimum width to the intrinsic width of the TextComponent for the given text.
    - Parameters:
      - text: The CharSequence used to determine the intrinsic width.
    - Returns: An instance of TextComponent.MinWidth configured with the text-based width.
```

--------------------------------

### CartesianLayerMargins.start Property

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian.layer/-cartesian-layer-margins/start

Documentation for the 'start' property of the CartesianLayerMargins class in the vico API. This property represents the size of the start margin for a Cartesian layer. It is an open override variable of type Float.

```APIDOC
CartesianLayerMargins:
  start: Float
    The start margin’s size.
    Type: Float
    Modifiers: open override var
```

--------------------------------

### CacheStore Class and Functions

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common.data/-cache-store/index

API documentation for the CacheStore class, including its nested KeyNamespace type and core caching functions.

```APIDOC
CacheStore:
  Description: Caches data.

  Nested Types:
    KeyNamespace:
      Description: Identifies a key namespace. These namespaces help prevent interscope key collisions.

  Functions:
    getOrNull:
      Signature: fun <T : Any> getOrNull(keyNamespace: CacheStore.KeyNamespace, vararg keyComponents: Any?): T?
      Description: Retrieves the value associated with the key belonging to the specified namespace and matching the given components. If there’s no such value, null is returned.
      Parameters:
        keyNamespace: CacheStore.KeyNamespace - The namespace for the key.
        keyComponents: vararg Any? - Components that form the key.
      Returns: T? - The cached value or null.

    getOrSet:
      Signature: fun <T : Any> getOrSet(keyNamespace: CacheStore.KeyNamespace, vararg keyComponents: Any?, value: () -> T): T
      Description: Retrieves the value associated with the key belonging to the specified namespace and matching the given components. If there’s no such value, `value` is called, and its result is cached and returned.
      Parameters:
        keyNamespace: CacheStore.KeyNamespace - The namespace for the key.
        keyComponents: vararg Any? - Components that form the key.
        value: () -> T - A lambda function that provides the value to be cached if it's not found.
      Returns: T - The cached value or the newly computed value.

    set:
      Signature: operator fun set(keyNamespace: CacheStore.KeyNamespace, vararg keyComponents: Any?, value: Any)
      Description: Caches the provided value associated with the key formed by the namespace and components.
      Parameters:
        keyNamespace: CacheStore.KeyNamespace - The namespace for the key.
        keyComponents: vararg Any? - Components that form the key.
        value: Any - The value to cache.
```

--------------------------------

### Start Property Declaration

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian/-scroll/-absolute/-companion/-start

Declares the 'Start' property, which corresponds to the zero value for absolute scrolling. This is part of the Companion object for Scroll.Absolute, likely used in the vico charting library for defining scroll offsets.

```kotlin
val Start: Scroll.Absolute
  "Corresponds to zero."
```

--------------------------------

### CartesianChart startAxis Property

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian/-cartesian-chart/start-axis

Represents the start Axis for a Cartesian chart. This property defines the vertical axis positioned at the start of the chart area. It is nullable, indicating that an axis might not always be present.

```kotlin
val startAxis: Axis<Axis.Position.Vertical.Start>?
  
  /**
   * The start Axis.
   */
```

--------------------------------

### Key Constructor

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common.data/-extra-store/-key/-key

Defines the default constructor for the Key class. This is used to create new instances of the Key object, typically for use within the ExtraStore data management system.

```kotlin
constructor()
```

--------------------------------

### Vico Compose Modules

Source: https://www.patrykandpatrick.com/vico/api/stable/index

Documentation for the Vico Compose modules, which likely provide UI components and utilities for Jetpack Compose.

```APIDOC
Module: vico/compose
Description: Core UI components and utilities for Jetpack Compose.
Link: vico/compose/index.html
```

```APIDOC
Module: vico/compose-m2
Description: Components or utilities specifically for Compose Material 2.
Link: vico/compose-m2/index.html
```

```APIDOC
Module: vico/compose-m3
Description: Components or utilities specifically for Compose Material 3.
Link: vico/compose-m3/index.html
```

--------------------------------

### CartesianLayerMargins.ensureValuesAtLeast Function

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian.layer/-cartesian-layer-margins/ensure-values-at-least

The `ensureValuesAtLeast` function in `CartesianLayerMargins` ensures that the stored margin values (start, end, top, bottom) are not smaller than the provided minimums. It accepts optional start and end values, or all four margin values with defaults.

```APIDOC
CartesianLayerMargins.ensureValuesAtLeast

Ensures that the stored values are no smaller than those provided.

Overload 1:
open override fun ensureValuesAtLeast(start: Float, end: Float)
  - Parameters:
    - start: The minimum start value.
    - end: The minimum end value.

Overload 2:
fun ensureValuesAtLeast(start: Float = this.start, top: Float = this.top, end: Float = this.end, bottom: Float = this.bottom)
  - Parameters:
    - start: The minimum start value (defaults to current start).
    - top: The minimum top value (defaults to current top).
    - end: The minimum end value (defaults to current end).
    - bottom: The minimum bottom value (defaults to current bottom).

Returns: Unit. The function modifies the internal state of the margins.
```

--------------------------------

### Kotlin CartesianChart startAxis Property Declaration

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian/-cartesian-chart/start-axis

Declares the `startAxis` property for the `CartesianChart` class. This property is nullable and represents the start Axis, which is a vertical axis positioned at the start of the chart. It is part of the vico multiplatform charting library.

```Kotlin
val startAxis: Axis<Axis.Position.Vertical.Start>?

/**
 * The start [Axis].
 */
```

--------------------------------

### ExtraStore Class

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.common.data/-extra-store/index

Documentation for the abstract ExtraStore class, which serves as a container for auxiliary data. It lists its inheritors and nested types.

```APIDOC
abstract class ExtraStore
  Description: Houses auxiliary data.
  Inheritors:
    MutableExtraStore
  Nested Types:
    Key
```

--------------------------------

### VerticalAxis.Companion.rememberStart

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/compose/com.patrykandpatrick.vico.compose.cartesian.axis/remember-start

Creates and remembers a start VerticalAxis. This function configures various aspects of the axis, including its line, labels, tick marks, guidelines, and title, using default or provided components and settings. It returns a VerticalAxis instance positioned at the start.

```kotlin
fun VerticalAxis.Companion.rememberStart(
    line: LineComponent? = rememberAxisLineComponent(),
    label: TextComponent? = rememberAxisLabelComponent(),
    labelRotationDegrees: Float = Defaults.AXIS_LABEL_ROTATION_DEGREES,
    horizontalLabelPosition: VerticalAxis.HorizontalLabelPosition = VerticalAxis.HorizontalLabelPosition.Outside,
    verticalLabelPosition: Position.Vertical = Position.Vertical.Center,
    valueFormatter: CartesianValueFormatter = CartesianValueFormatter.Default,
    tick: LineComponent? = rememberAxisTickComponent(),
    tickLength: Dp = Defaults.AXIS_TICK_LENGTH.dp,
    guideline: LineComponent? = rememberAxisGuidelineComponent(),
    itemPlacer: VerticalAxis.ItemPlacer = remember { VerticalAxis.ItemPlacer.step() },
    size: BaseAxis.Size = BaseAxis.Size.auto(),
    titleComponent: TextComponent? = null,
    title: CharSequence? = null
): VerticalAxis<Axis.Position.Vertical.Start>
```

--------------------------------

### PointProvider Interface and Methods

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/multiplatform/com.patrykandpatrick.vico.multiplatform.cartesian.layer/-line-cartesian-layer/-point-provider/index

API reference for the PointProvider interface, including its factory companion object and abstract methods for retrieving points. This interface is crucial for mapping data entries to visual points in Cartesian layers.

```APIDOC
PointProvider
  @Immutable
  interface PointProvider

  // Provides Points to LineCartesianLayers.

  // Companion object
  object Companion

  // Functions
  fun getLargestPoint(extraStore: ExtraStore): Point?
    - Returns the largest Point.
    - Parameters:
      - extraStore: The ExtraStore containing data.
    - Returns: The largest Point or null.

  fun getPoint(entry: LineCartesianLayerModel.Entry, seriesIndex: Int, extraStore: ExtraStore): Point?
    - Returns the Point for the point with the given properties.
    - Parameters:
      - entry: The data entry for the point.
      - seriesIndex: The index of the series the point belongs to.
      - extraStore: The ExtraStore containing data.
    - Returns: The Point or null.
```

--------------------------------

### Insets Class and Constructors

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.common/-insets/index

Defines the Insets class for storing inset sizes and its various constructors for creating instances with different configurations.

```APIDOC
class Insets(startDp: Float = 0.0f, topDp: Float = 0.0f, endDp: Float = 0.0f, bottomDp: Float = 0.0f)
  Stores inset sizes for the sides of a rectangle. Used for margins and padding.

  Parameters:
    startDp: the start inset’s size (in dp).
    topDp: the top inset’s size (in dp).
    endDp: the end inset’s size (in dp).
    bottomDp: the bottom inset’s size (in dp).

  Constructors:
    constructor(horizontalDp: Float = 0.0f, verticalDp: Float = 0.0f)
      Creates an Insets instance with startDp = endDp and topDp = bottomDp.
    constructor(allDp: Float = 0.0f)
      Creates an Insets instance with a common size for all four insets.
    constructor(startDp: Float = 0.0f, topDp: Float = 0.0f, endDp: Float = 0.0f, bottomDp: Float = 0.0f)
      Creates an Insets instance with specific sizes for each side.
```

--------------------------------

### MutableCartesianLayerDimensions.scalableStartPadding

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.layer/-mutable-cartesian-layer-dimensions/scalable-start-padding

The scalable part of the distance between the start of the content area and the first entry (in pixels).

```Kotlin
open override var scalableStartPadding: Float
  Description: The scalable part of the distance between the start of the content area and the first entry (in pixels).
  Type: Float
```

--------------------------------

### Horizontal Property

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.layer/-horizontal-cartesian-layer-margins/horizontal

The `horizontal` property of `HorizontalCartesianLayerMargins` represents the sum of the start and end margins. It is an open Float value.

```APIDOC
class HorizontalCartesianLayerMargins

open val horizontal: Float
  Description: The sum of start and end.
  Type: Float
  Related: start, end
```

--------------------------------

### LegendItem Constructor

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.common/-legend-item/index

Constructs a new LegendItem instance. Requires an icon component, a TextComponent for the label, and the label text.

```APIDOC
constructor(icon: Component, labelComponent: TextComponent, label: CharSequence)
```

--------------------------------

### ColumnProvider Interface and Methods

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.layer/-column-cartesian-layer/-column-provider/index

Documentation for the ColumnProvider interface, detailing its functions for retrieving column components. Includes method signatures, parameter descriptions, and return types.

```APIDOC
ColumnProvider
  @Immutable
  interface ColumnProvider

  Description: Provides column LineComponents to ColumnCartesianLayer.s.

  Functions:
    getColumn(entry: ColumnCartesianLayerModel.Entry, seriesIndex: Int, extraStore: ExtraStore): LineComponent
      Description: Returns the LineComponent for the column with the given properties.
      Parameters:
        entry: ColumnCartesianLayerModel.Entry - The entry for the column.
        seriesIndex: Int - The index of the series.
        extraStore: ExtraStore - Additional data store.
      Returns: LineComponent - The LineComponent for the column.

    getWidestSeriesColumn(seriesIndex: Int, extraStore: ExtraStore): LineComponent
      Description: Returns the widest column LineComponent for the specified series.
      Parameters:
        seriesIndex: Int - The index of the series.
        extraStore: ExtraStore - Additional data store.
      Returns: LineComponent - The widest column LineComponent for the series.
```

--------------------------------

### Get Max Y for ColumnCartesianLayer

Source: https://www.patrykandpatrick.com/vico/api/stable/vico/core/com.patrykandpatrick.vico.core.cartesian.layer/-column-cartesian-layer/-merge-mode/-stacked/get-max-y

Retrieves the maximum y value from a ColumnCartesianLayerModel. This function is an override and is specific to the Stacked merge mode.

```APIDOC
ColumnCartesianLayer.MergeMode.Stacked.getMaxY
  open override fun getMaxY(model: ColumnCartesianLayerModel): Double
    - Returns the maximum y value.
    - Parameters:
      - model: The ColumnCartesianLayerModel to get the max Y from.
    - Returns: The maximum y value as a Double.
```
Tokens:
Raw