# MonochromaticImage

# MonochromaticImage

Artifact:[androidx.wear.watchface:watchface-complications-data](https://developer.android.com/jetpack/androidx/releases/wear-watchface)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/complications/data/Image.kt+class:androidx.wear.watchface.complications.data.MonochromaticImage)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0)

*** ** * ** ***

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

<br />

```
class MonochromaticImage
```

<br />

*** ** * ** ***

A simple, monochromatic image that can be tinted by the watch face.

A monochromatic image doesn't have to be black and white, it can have a single color associated with the provider / brand with the expectation that the watch face may recolor it (typically using a SRC_IN filter).

An ambient alternative is provided that may be shown instead of the regular image while the watch is not active.

## Summary

|                                                                                                                                             ### Nested types                                                                                                                                              |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[MonochromaticImage.Builder](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage.Builder) Builder for[MonochromaticImage](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage). |

|                                                  ### Public companion properties                                                   |
|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [MonochromaticImage](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage) | [PLACEHOLDER](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#PLACEHOLDER()) For use when the real data isn't available yet, this[MonochromaticImage](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage)should be rendered as a placeholder. |

|                                        ### 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/complications/data/MonochromaticImage#equals(kotlin.Any))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | [hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#hashCode())`()`                                                                                            |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | [toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#toString())`()`                                                                                            |

|                                 ### Public properties                                  |
|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Icon](https://developer.android.com/reference/android/graphics/drawable/Icon.html)`?` | [ambientImage](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#ambientImage()) The image to be shown when the device is in ambient mode to save power or avoid burn in |
| [Icon](https://developer.android.com/reference/android/graphics/drawable/Icon.html)    | [image](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#image()) The image itself                                                                                      |

## Public companion properties

### PLACEHOLDER

```
val PLACEHOLDER: MonochromaticImage
```

For use when the real data isn't available yet, this[MonochromaticImage](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage)should be rendered as a placeholder. It is suggested that it should be rendered with a light grey box.

Note a placeholder may only be used in the context of[NoDataComplicationData.placeholder](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/NoDataComplicationData#placeholder()).  

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```  

### hashCode

```
open fun hashCode(): Int
```  

### toString

```
open fun toString(): String
```  

## Public properties

### ambientImage

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

```
val ambientImage: Icon?
```

The image to be shown when the device is in ambient mode to save power or avoid burn in  

### image

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

```
val image: Icon
```

The image itself