core/com.patrykandpatrick.vico.core.chart.insets/Insets

Insets

class Insets(var start: Float = 0.0f, var top: Float = 0.0f, var end: Float = 0.0f, var bottom: Float = 0.0f) : HorizontalInsets

Used to store the insets requested by ChartInsetters.

Parameters

start

the start inset.

top

the top inset.

end

the end inset.

bottom

the bottom inset.

See also

Constructors

constructor(start: Float = 0.0f, top: Float = 0.0f, end: Float = 0.0f, bottom: Float = 0.0f)

Properties

var bottom: Float

val horizontal: Float

The sum of the sizes of the start inset and the end inset.

var start: Float

val vertical: Float

The sum of the sizes of the top inset and the bottom inset.

Functions

fun clear()

Sets the size of each of the four insets to zero.

fun getLeft(isLtr: Boolean): Float

Returns the size of the left inset, taking into account the layout direction.

fun getRight(isLtr: Boolean): Float

Returns the size of the right inset, taking into account the layout direction.

fun set(other: Insets): Insets

Updates the size of each of the four insets to match the size of its corresponding inset from the provided Insets instance.

fun set(all: Float): Insets

Sets a common size for all four insets.

open override fun set(start: Float, end: Float)

Updates the sizes of the start inset and the end inset.

fun set(start: Float = 0.0f, top: Float = 0.0f, end: Float = 0.0f, bottom: Float = 0.0f): Insets

Updates the size of each of the four insets individually.

setAllIfGreater

fun setAllIfGreater(start: Float = this.start, top: Float = this.top, end: Float = this.end, bottom: Float = this.bottom)

For each of the four insets, updates the size of the inset to the corresponding provided value if the corresponding provided value is greater.

fun setHorizontal(value: Float): Insets

Sets the sizes of the start inset and the end inset. value represents the sum of the two insets’ sizes, meaning the size of either inset will be half of value.

setValuesIfGreater

fun setValuesIfGreater(other: Insets)

For each of the four insets, updates the size of the inset to the size of the corresponding inset from the provided Insets instance if the size of the corresponding inset from the provided Insets instance is greater.

open override fun setValuesIfGreater(start: Float, end: Float)

For the start and end insets, updates the value of the inset to the corresponding provided value if the provided value is greater than the current value.

fun setVertical(value: Float): Insets

Sets the sizes of the top inset and the bottom inset. value represents the sum of the two insets’ sizes, meaning the size of either inset will be half of value.