MeasureScope

Kotlin |Java

interface MeasureScope : IntrinsicMeasureScope

androidx.compose.ui.layout.MeasureScope

Known Direct Subclasses

SubcomposeMeasureScope

The receiver scope of a SubcomposeLayout's measure lambda which adds ability to dynamically subcompose a content during the measuring on top of the features provided by MeasureScope.

The receiver scope of a layout's measure lambda. The return value of the measure lambda is MeasureResult, which should be returned by layout

Summary

Public methods
open MeasureResult	`layout(width: Int, height: Int, alignmentLines: Map<AlignmentLine, Int> = emptyMap(), placementBlock: Placeable.PlacementScope.() -> Unit)` Sets the size and alignment lines of the measured layout, as well as the positioning block that defines the children positioning logic.

Inherited functions

From class Density

`Int`	`roundToPx()` Convert Dp to Int by rounding
`Int`	`roundToPx()` Convert Sp to Int by rounding
`Dp`	`toDp()` Convert Sp to Dp.
`Dp`	`toDp()` Convert an Int pixel value to Dp.
`Dp`	`toDp()` Convert a Float pixel value to a Dp
`Float`	`toPx()` Convert Dp to pixels. Pixels are used to paint to Canvas.
`Float`	`toPx()` Convert Sp to pixels. Pixels are used to paint to Canvas.
`Rect`	`toRect()` Convert a DpRect to a Rect.
`TextUnit`	`toSp()` Convert Dp to Sp. Sp is used for font size, etc.
`TextUnit`	`toSp()` Convert an Int pixel value to Sp.
`TextUnit`	`toSp()` Convert a Float pixel value to a Sp

Inherited properties

From class Density

Float

density

The logical density of the display. This is a scaling factor for the Dp unit.

Float

fontScale

Current user preference for the scaling factor for fonts.

From class IntrinsicMeasureScope

LayoutDirection

layoutDirection

The LayoutDirection of the Layout or LayoutModifier using the measure scope to measure their children.

Public methods

layout

open fun layout(
    width: Int, 
    height: Int, 
    alignmentLines: Map<AlignmentLine, Int> = emptyMap(), 
    placementBlock: Placeable.PlacementScope.() -> Unit
): MeasureResult

Sets the size and alignment lines of the measured layout, as well as the positioning block that defines the children positioning logic. The placementBlock is a lambda used for positioning children. Placeable.placeAt should be called on children inside placementBlock. The alignmentLines can be used by the parent layouts to decide layout, and can be queried using the Placeable.get operator. Note that alignment lines will be inherited by parent layouts, such that indirect parents will be able to query them as well.

Parameters