# 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)

*** ** * ** ***


```
public enum WatchFaceLayer extends Enum<@NonNull WatchFaceLayer>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [kotlin.Enum](https://developer.android.com/reference/java/lang/Enum.html)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) [WatchFaceLayer](https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer)\> ||
|   | ↳ | [androidx.wear.watchface.style.WatchFaceLayer](https://developer.android.com/reference/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/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/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/androidx/wear/watchface/style/WatchFaceLayer#COMPLICATIONS_OVERLAY` | **This enum value is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer>` | `https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer#ALL_WATCH_FACE_LAYERS()` **This field is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer>` | `[getEntries](https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer#getEntries())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer` | `[valueOf](https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer#valueOf(kotlin.String))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html value)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull WatchFaceLayer[]` | `[values](https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer#values())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Enum Values

### BASE

```
WatchFaceLayer WatchFaceLayer.BASE
```

> [!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

```
WatchFaceLayer WatchFaceLayer.COMPLICATIONS
```

> [!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

```
WatchFaceLayer WatchFaceLayer.COMPLICATIONS_OVERLAY
```

> [!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 fields

### ALL_WATCH_FACE_LAYERS

```
public static final @NonNull Set<@NonNull WatchFaceLayer> ALL_WATCH_FACE_LAYERS
```

> [!CAUTION]
> **This field 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/androidx/wear/watchface/style/WatchFaceLayer`s.

## Public methods

### getEntries

```
public final @NonNull EnumEntries<@NonNull WatchFaceLayer> [getEntries](https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer#getEntries())()
```

> [!CAUTION]
> **This method 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.

### valueOf

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

```
public static final @NonNull WatchFaceLayer [valueOf](https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer#valueOf(kotlin.String))(@NonNull String value)
```

> [!CAUTION]
> **This method 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)

```
public static final @NonNull WatchFaceLayer[] [values](https://developer.android.com/reference/androidx/wear/watchface/style/WatchFaceLayer#values())()
```

> [!CAUTION]
> **This method 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.