# WatchFace.OverlayStyle

# WatchFace.OverlayStyle

Artifact:[androidx.wear.watchface:watchface](https://developer.android.com/jetpack/androidx/releases/wear-watchface)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/WatchFace.kt+class:androidx.wear.watchface.WatchFace.OverlayStyle)  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0)  
Deprecated in[1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/wear/watchface/WatchFace.OverlayStyle "View this page in Java")

<br />

```
class WatchFace.OverlayStyle
```

<br />

*** ** * ** ***

| **This class is deprecated.**   
| OverlayStyle will be removed in a future release.

This class allows the watch face to configure the status overlay which is rendered by the system on top of the watch face.

Note: This is not a supported API and will be removed.

## Summary

|                                                                                                                                                                                                                                     ### Public constructors                                                                                                                                                                                                                                     |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ~~[OverlayStyle](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#OverlayStyle())~~`()` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                                                                                                                                                                                                                                |
| ~~[OverlayStyle](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#OverlayStyle(android.graphics.Color,android.graphics.Color))~~`(backgroundColor: `[Color](https://developer.android.com/reference/android/graphics/Color.html)`?, foregroundColor: `[Color](https://developer.android.com/reference/android/graphics/Color.html)`?)` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

|                                        ### Public functions                                         |
|-----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | ~~[equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#equals(kotlin.Any))~~`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | ~~[hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#hashCode())~~`()` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                                                                            |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | ~~[toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#toString())~~`()` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                                                                            |

|                              ### Public properties                              |
|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Color](https://developer.android.com/reference/android/graphics/Color.html)`?` | [backgroundColor](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#backgroundColor()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| [Color](https://developer.android.com/reference/android/graphics/Color.html)`?` | [foregroundColor](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#foregroundColor()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Public constructors

### OverlayStyle

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

```
[OverlayStyle](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#OverlayStyle())()
```
| **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  

### OverlayStyle

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

```
[OverlayStyle](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#OverlayStyle(android.graphics.Color,android.graphics.Color))(backgroundColor: Color?, foregroundColor: Color?)
```
| **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  

## Public functions

### equals

```
open operator fun [equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#equals(kotlin.Any))(other: Any?): Boolean
```
| **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  

### hashCode

```
open fun [hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#hashCode())(): Int
```
| **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  

### toString

```
open fun [toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle#toString())(): String
```
| **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  

## Public properties

### backgroundColor

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

```
val backgroundColor: Color?
```
| **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

The background color of the status indicator tray. This can be any color, including[Color.TRANSPARENT](https://developer.android.com/reference/android/graphics/Color.html#TRANSPARENT()). If this is`null`then the system default will be used.  

### foregroundColor

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

```
val foregroundColor: Color?
```
| **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

The background color of items rendered in the status indicator tray. If not`null`then this must be either[Color.BLACK](https://developer.android.com/reference/android/graphics/Color.html#BLACK())or[Color.WHITE](https://developer.android.com/reference/android/graphics/Color.html#WHITE()). If this is`null`then the system default will be used.