# WatchFaceLayer

Artifact: [androidx.wear.watchface:watchface-style](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/style/WatchFaceLayer.kt+class:androidx.wear.watchface.style.WatchFaceLayer) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***


```
enum WatchFaceLayer : Enum<WatchFaceLayer>
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)\<[WatchFaceLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer)\> ||
|   | ↳ | [androidx.wear.watchface.style.WatchFaceLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer) |

*** ** * ** ***

> [!CAUTION]
> **This enum is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Describes part of watchface. Used as a parameter for rendering.

use Watch Face Format instead

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#BASE` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#COMPLICATIONS` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#COMPLICATIONS_OVERLAY` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public companion properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#ALL_WATCH_FACE_LAYERS()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer` | `[valueOf](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#valueOf(kotlin.String))(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer>` | `[values](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#values())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#entries()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Enum Values

### BASE

```
val WatchFaceLayer.BASE: WatchFaceLayer
```

> [!CAUTION]
> **This enum value is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The watch excluding complications and anything that may render on top of complications.

### COMPLICATIONS

```
val WatchFaceLayer.COMPLICATIONS: WatchFaceLayer
```

> [!CAUTION]
> **This enum value is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The watch face complications.

### COMPLICATIONS_OVERLAY

```
val WatchFaceLayer.COMPLICATIONS_OVERLAY: WatchFaceLayer
```

> [!CAUTION]
> **This enum value is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Any parts of the watch that may render on top of complications, e.g. watch hands.

## Public companion properties

### ALL_WATCH_FACE_LAYERS

```
val ALL_WATCH_FACE_LAYERS: Set<WatchFaceLayer>
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

A `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html` of all `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer`s.

## Public functions

### valueOf

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0)

```
fun [valueOf](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#valueOf(kotlin.String))(value: String): WatchFaceLayer
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0)

```
fun [values](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer#values())(): Array<WatchFaceLayer>
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using `entries` property as a more efficient alternative returning an immutable list of enum entries.

## Public properties

### entries

```
val entries: EnumEntries<WatchFaceLayer>
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.