WatchFaceLayer

public enum WatchFaceLayer extends Enum

java.lang.Object
   ↳ kotlin.Enum
     ↳ androidx.wear.watchface.style.WatchFaceLayer

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

Summary

Enum Values
BASE

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

The watch face complications.
COMPLICATIONS_OVERLAY

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

Public fields
static final @NonNull Set<@NonNull WatchFaceLayer>

A Set of all WatchFaceLayers.

Public methods
final @NonNull EnumEntries<@NonNull WatchFaceLayer>

Describes part of watchface.
final @NonNull WatchFaceLayer

Returns the enum constant of this type with the specified name.
final @NonNull WatchFaceLayer[]

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

Enum Values

BASE

WatchFaceLayer WatchFaceLayer.BASE

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

COMPLICATIONS

WatchFaceLayer WatchFaceLayer.COMPLICATIONS

The watch face complications.

COMPLICATIONS_OVERLAY

WatchFaceLayer WatchFaceLayer.COMPLICATIONS_OVERLAY

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

A Set of all WatchFaceLayers.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull WatchFaceLayer> getEntries()

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

valueOf

Added in 1.0.0
public final @NonNull WatchFaceLayer valueOf(@NonNull String value)

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
public final @NonNull WatchFaceLayer[] values()

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.