WatchFaceLayer

Artifact: androidx.wear.watchface:watchface-style

Added in 1.0.0

Kotlin |Java

enum WatchFaceLayer : Enum

kotlin.Any
↳	kotlin.Enum
	↳	androidx.wear.watchface.style.WatchFaceLayer

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

use Watch Face Format instead

Summary

Enum Values
`BASE`	This enum value is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`COMPLICATIONS`	This enum value is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`COMPLICATIONS_OVERLAY`	This enum value is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public companion properties
`Set<WatchFaceLayer>`	`ALL_WATCH_FACE_LAYERS` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public functions
`WatchFaceLayer`	`valueOf(value: String)` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`Array<WatchFaceLayer>`	`values()` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public properties
`EnumEntries<WatchFaceLayer>`	`entries` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Enum Values

BASE

val WatchFaceLayer.BASE: WatchFaceLayer

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

COMPLICATIONS

val WatchFaceLayer.COMPLICATIONS: WatchFaceLayer

The watch face complications.

COMPLICATIONS_OVERLAY

val WatchFaceLayer.COMPLICATIONS_OVERLAY: WatchFaceLayer

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>

A Set of all WatchFaceLayers.

Public functions

valueOf

Added in 1.0.0

fun valueOf(value: String): WatchFaceLayer

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
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

Added in 1.0.0

fun values(): Array<WatchFaceLayer>

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.

Public properties

entries

val entries: EnumEntries<WatchFaceLayer>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.