MeasureScope

Artifact: androidx.compose.ui:ui

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  @MeasureScopeMarker
  interface MeasureScope : IntrinsicMeasureScope

Known direct subclasses

ApproachMeasureScope, LazyLayoutMeasureScope, SubcomposeMeasureScope

ApproachMeasureScope	ApproachMeasureScope provides access to lookahead results to allow ApproachLayoutModifierNode to leverage lookahead results to define how measurements and placements approach their destination.
LazyLayoutMeasureScope	The receiver scope of a LazyLayout's measure lambda.
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 functions
open MeasureResult	layout(     width: Int,     height: Int,     alignmentLines: Map<AlignmentLine, Int>,     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.	Cmn
open MeasureResult	layout(     width: Int,     height: Int,     alignmentLines: Map<AlignmentLine, Int>,     rulers: (RulerScope.() -> Unit)?,     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.	Cmn

Inherited functions
From androidx.compose.ui.unit.Density open Int Dp.roundToPx() Convert Dp to Int by rounding Cmn open Int TextUnit.roundToPx() Convert Sp to Int by rounding Cmn open Dp Int.toDp() Convert an Int pixel value to Dp. Cmn open Dp Float.toDp() Convert a Float pixel value to a Dp Cmn open DpSize Size.toDpSize() Convert a Size to a DpSize. Cmn open Float Dp.toPx() Convert Dp to pixels. Cmn open Float TextUnit.toPx() Convert Sp to pixels. Cmn open Rect DpRect.toRect() Convert a DpRect to a Rect. Cmn open Size DpSize.toSize() Convert a DpSize to a Size. Cmn open TextUnit Int.toSp() Convert an Int pixel value to Sp. Cmn open TextUnit Float.toSp() Convert a Float pixel value to a Sp Cmn
From androidx.compose.ui.unit.FontScaling open Dp TextUnit.toDp() Convert Sp to Dp. Cmn open TextUnit Dp.toSp() Convert Dp to Sp. Cmn

Inherited properties
From androidx.compose.ui.unit.Density Float density The logical density of the display. Cmn
From androidx.compose.ui.unit.FontScaling Float fontScale Current user preference for the scaling factor for fonts. Cmn
From androidx.compose.ui.layout.IntrinsicMeasureScope open Boolean isLookingAhead This indicates whether the ongoing measurement is for lookahead pass. Cmn LayoutDirection layoutDirection The LayoutDirection of the Layout or LayoutModifier using the measure scope to measure their children. Cmn

Public functions

layout

Cmn

Added in 1.8.0-alpha05

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
width: Int	the measured width of the layout
height: Int	the measured height of the layout
alignmentLines: Map<AlignmentLine, Int> = emptyMap()	the alignment lines defined by the layout
placementBlock: Placeable.PlacementScope.() -> Unit	block defining the children positioning of the current layout

layout

Cmn

Added in 1.8.0-alpha05

open fun layout(
    width: Int,
    height: Int,
    alignmentLines: Map<AlignmentLine, Int> = emptyMap(),
    rulers: (RulerScope.() -> Unit)? = null,
    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
width: Int	the measured width of the layout
height: Int	the measured height of the layout
alignmentLines: Map<AlignmentLine, Int> = emptyMap()	the alignment lines defined by the layout
rulers: (RulerScope.() -> Unit)? = null	a method to set Ruler values used by all placed children
placementBlock: Placeable.PlacementScope.() -> Unit	block defining the children positioning of the current layout