# OverlayStyle

# OverlayStyle

Artifact:[androidx.wear.watchface:watchface-client](https://developer.android.com/jetpack/androidx/releases/wear-watchface)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/client/OverlayStyle.kt+class:androidx.wear.watchface.client.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/client/OverlayStyle "View this page in Java")

<br />

```
class OverlayStyle
```

<br />

*** ** * ** ***

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

This class reflects a snapshot of[androidx.wear.watchface.WatchFace.OverlayStyle](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFace.OverlayStyle).

Note while this plumbing got built, it was never used by the system ui on any platform and it will be removed.

## Summary

|                                                                                                                                                                                                                      ### Public constructors                                                                                                                                                                                                                       |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ~~[OverlayStyle](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#OverlayStyle())~~`()` **This function is deprecated.**OverlayStyle will be removed in a future release.                                                                                                                                                                                                                                                |
| ~~[OverlayStyle](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/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.**OverlayStyle will be removed in a future release. |

|                                        ### 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/client/OverlayStyle#equals(kotlin.Any))~~`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` **This function is deprecated.**OverlayStyle will be removed in a future release. |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | ~~[hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#hashCode())~~`()` **This function is deprecated.**OverlayStyle will be removed in a future release.                                                                                            |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | ~~[toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#toString())~~`()` **This function is deprecated.**OverlayStyle will be removed in a future release.                                                                                            |

|                              ### Public properties                              |
|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Color](https://developer.android.com/reference/android/graphics/Color.html)`?` | [backgroundColor](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#backgroundColor()) **This property is deprecated.**OverlayStyle will be removed in a future release. |
| [Color](https://developer.android.com/reference/android/graphics/Color.html)`?` | [foregroundColor](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#foregroundColor()) **This property is deprecated.**OverlayStyle will be removed in a future release. |

## 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/client/OverlayStyle#OverlayStyle())()
```
| **This function is deprecated.**   
| OverlayStyle will be removed in a future release.

Default constructor when when there's no data available. E.g. when dealing with an old watch face.  

### 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/client/OverlayStyle#OverlayStyle(android.graphics.Color,android.graphics.Color))(backgroundColor: Color?, foregroundColor: Color?)
```
| **This function is deprecated.**   
OverlayStyle will be removed in a future release.  

## Public functions

### equals

```
open operator fun [equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#equals(kotlin.Any))(other: Any?): Boolean
```
| **This function is deprecated.**   
OverlayStyle will be removed in a future release.  

### hashCode

```
open fun [hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#hashCode())(): Int
```
| **This function is deprecated.**   
OverlayStyle will be removed in a future release.  

### toString

```
open fun [toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle#toString())(): String
```
| **This function is deprecated.**   
OverlayStyle will be removed in a future release.  

## 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.**   
| OverlayStyle will be removed in a future release.

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.**   
| OverlayStyle will be removed in a future release.

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.