CompositionGroup

Artifact: androidx.compose.runtime:runtime

Added in 1.0.0

Cmn

interface CompositionGroup : CompositionData

CompositionGroup is a group of data slots tracked independently by composition. These groups correspond to flow control branches (such as if statements and function calls) as well as emitting of a node to the tree.

This interface is not intended to be used directly and is provided to allow the tools API to have access to data tracked during composition. The tools API should be used instead which provides a more usable interpretation of the slot table.

Summary

Public properties
`Iterable<Any?>`	`data` The data stored in the slot table for this group.	Cmn
`open Int`	`groupSize` The total number of groups, including itself, that this group contains.	Cmn
`open Any?`	`identity` A value that identifies a Group independently of movement caused by recompositions.	Cmn
`Any`	`key` A value used to identify the group within its siblings and is typically a compiler generated integer but can be an object if the `key` composable is used.	Cmn
`Any?`	`node` If the group represents a node this returns a non-null value which is the node that was emitted for the group.	Cmn
`open Int`	`slotsSize`	Cmn
`String?`	`sourceInfo` Information recorded by the compiler to help tooling identify the source that generated the group.	Cmn

Extension functions
`List<ParameterInformation>`	`@UiToolingDataApi CompositionGroup.findParameters(cache: ContextCache?)` Return the parameters found for this `CompositionGroup`.	android

Inherited functions

From androidx.compose.runtime.tooling.CompositionData

open CompositionGroup?

find(identityToFind: Any)

Find a sub-group by identity.

Cmn

Inherited properties

From androidx.compose.runtime.tooling.CompositionData

`Iterable<CompositionGroup>`	`compositionGroups` Iterate the composition data in the group.	Cmn
`Boolean`	`isEmpty` Returns true if no composition data has been collected.	Cmn

Public properties

data

Cmn

Added in 1.0.0

val data: Iterable<Any?>

The data stored in the slot table for this group. This information includes the values stored for parameters that are checked for change, any value passed as a parameter for androidx.compose.runtime.remember and the last value returned by androidx.compose.runtime.remember, etc.

groupSize

Cmn

Added in 1.4.0

open val groupSize: Int

The total number of groups, including itself, that this group contains.

identity

Cmn

Added in 1.2.0

open val identity: Any?

A value that identifies a Group independently of movement caused by recompositions.

key

Cmn

Added in 1.0.0

val key: Any

A value used to identify the group within its siblings and is typically a compiler generated integer but can be an object if the key composable is used.

node

Cmn

Added in 1.0.0

val node: Any?

If the group represents a node this returns a non-null value which is the node that was emitted for the group.

slotsSize

Cmn

Added in 1.4.0

open val slotsSize: Int

sourceInfo

Cmn

Added in 1.0.0

val sourceInfo: String?

Information recorded by the compiler to help tooling identify the source that generated the group. The format of this string is internal and is interpreted by the tools API which translates this information into source file name and offsets.

Extension functions

findParameters

android

Artifact: androidx.compose.ui:ui-tooling-data

View Source

@UiToolingDataApi
fun CompositionGroup.findParameters(cache: ContextCache? = null): List<ParameterInformation>

Return the parameters found for this CompositionGroup.