HorizontalRuler

public class HorizontalRuler private constructor(calculation: (PlacementScope.(Float) -> Float)?) :
    Ruler(calculation)

A horizontal Ruler. Defines a line that can be used by parent layouts to align or position their children vertically. The position of the ruler can be retrieved with Placeable.PlacementScope.current and can be set with MeasureScope.layout using RulerScope.provides.

Functions

calculateCoordinate

override fun calculateCoordinate(
        coordinate: Float,
        sourceCoordinates: LayoutCoordinates,
        targetCoordinates: LayoutCoordinates,
    ): Float

Creates a HorizontalRuler whose values are directly provided. The developer can set the ruler value in MeasureScope.layout using RulerScope.provides or RulerScope.providesRelative.

Members

Companion

public companion object

Functions

maxOf

public fun maxOf(vararg rulers: HorizontalRuler): HorizontalRuler

Creates a HorizontalRuler derived from the greater value of all HorizontalRulers in rulers that supply a value. This is the right-most of all provided ruler values.

minOf

public fun minOf(vararg rulers: HorizontalRuler): HorizontalRuler

Creates a HorizontalRuler derived from the least value of all HorizontalRulers in rulers that supply a value. This is the left-most of all provided ruler values.

derived

public fun derived(
            calculation: PlacementScope.(defaultValue: Float) -> Float
        ): HorizontalRuler

Creates a HorizontalRuler whose values are derived from values available in the PlacementScope, such as other HorizontalRulers.

Parameters