# androidx.wear.protolayout.types

*** ** * ** ***

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` | Static or dynamic color value for layout fields. |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` | Static or dynamic string value for layout fields. |

## Top-level functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` | `@https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#stringLayoutConstraint(kotlin.String,kotlin.Int)(longestPattern: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, alignment: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Specifies layout constraints for to use for layout measurement in presence of dynamic values. |

## Extension functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` | `@https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicColor.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(androidx.wear.protolayout.expression.DynamicBuilders.DynamicColor).asLayoutColor(kotlin.Int)(staticArgb: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicColor` |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` | `@https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicColor.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(androidx.wear.protolayout.expression.DynamicBuilders.DynamicColor).asLayoutColor(kotlin.Long)(staticArgb: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicColor` |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` | `@https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(kotlin.String).asLayoutConstraint(kotlin.Int)(alignment: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` from a String. |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` | `@https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 600) https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(androidx.wear.protolayout.expression.DynamicBuilders.DynamicString).asLayoutString(kotlin.String)(staticValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString` |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` | `@https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(androidx.wear.protolayout.expression.DynamicBuilders.DynamicString).asLayoutString(kotlin.String,androidx.wear.protolayout.TypeBuilders.StringLayoutConstraint)( staticValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, layoutConstraint: https://developer.android.com/reference/kotlin/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint )` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString` |

## Extension properties summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(kotlin.Int).argb()` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from an ARGB Color Int. |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(kotlin.Long).argb()` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from an ARGB Color Long. |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html.https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/package-summary#(kotlin.String).layoutString()` Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` from a String. |

## Top-level functions

### stringLayoutConstraint

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutString.kt+function:stringLayoutConstraint) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
fun stringLayoutConstraint(
    longestPattern: String,
    alignment: Int = TEXT_ALIGN_CENTER
): TypeBuilders.StringLayoutConstraint
```

Specifies layout constraints for to use for layout measurement in presence of dynamic values.

| Parameters |
|---|---|
| `longestPattern: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the text string to use as the pattern for the (graphically) longest text that can be laid out. Used to ensure that the layout is of a known size during the layout pass. |
| `alignment: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = TEXT_ALIGN_CENTER` | the alignment of the actual text within the space reserved by `longestPattern` |

## Extension functions

### DynamicBuilders.DynamicColor.asLayoutColor

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutColor.kt+function:asLayoutColor) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
fun DynamicBuilders.DynamicColor.asLayoutColor(staticArgb: @ColorInt Int): LayoutColor
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicColor`

| Parameters |
|---|---|
| `staticArgb: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | the static value that can be used when the `dynamicValue` can't be resolved. |

### DynamicBuilders.DynamicColor.asLayoutColor

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutColor.kt+function:asLayoutColor) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
fun DynamicBuilders.DynamicColor.asLayoutColor(staticArgb: @ColorInt Long): LayoutColor
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicColor`

| Parameters |
|---|---|
| `staticArgb: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | the static value that can be used when the `dynamicValue` can't be resolved. |

### String.asLayoutConstraint

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutString.kt+function:asLayoutConstraint) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
fun String.asLayoutConstraint(alignment: Int = TEXT_ALIGN_CENTER): TypeBuilders.StringLayoutConstraint
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` from a String. `this` will be used as `longestPattern`.

| Parameters |
|---|---|
| `alignment: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = TEXT_ALIGN_CENTER` | the alignment of the actual text within the space reserved by `longestPattern` |

### DynamicBuilders.DynamicString.asLayoutString

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutString.kt+function:asLayoutString) Added in [1.4.2](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.4.2)

```
@RequiresSchemaVersion(major = 1, minor = 600)
fun DynamicBuilders.DynamicString.asLayoutString(staticValue: String): LayoutString
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString`

| Parameters |
|---|---|
| `staticValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the static value that can be used when the `dynamicValue` can't be resolved. |

### DynamicBuilders.DynamicString.asLayoutString

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutString.kt+function:asLayoutString) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
fun DynamicBuilders.DynamicString.asLayoutString(
    staticValue: String,
    layoutConstraint: TypeBuilders.StringLayoutConstraint
): LayoutString
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString`

| Parameters |
|---|---|
| `staticValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the static value that can be used when the `dynamicValue` can't be resolved. |
| `layoutConstraint: https://developer.android.com/reference/kotlin/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` | used to correctly measure layout Text element size and align text to ensure that the layout is of a known size during the layout pass regardless of the `dynamicValue` String. |

## Extension properties

### Int.argb

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutColor.kt+symbol:argb) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
val Int.argb: LayoutColor
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from an ARGB Color Int.

### Long.argb

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutColor.kt+symbol:argb) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
val Long.argb: LayoutColor
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutColor` from an ARGB Color Long.

### String.layoutString

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/types/LayoutString.kt+symbol:layoutString) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
val String.layoutString: LayoutString
```

Extension for creating a `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/types/LayoutString` from a String.