# SmallImage

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.SmallImage) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0)

*** ** * ** ***


```
public final class SmallImage
```

<br />

*** ** * ** ***

An image that is expected to cover a small fraction of a watch face occupied by a single complication. A SmallImage must not be tinted.

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

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage.Builder` Builder for `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage`. |

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage` | `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage#PLACEHOLDER()` For use when the real data isn't available yet, this `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage` should be rendered as a placeholder. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final https://developer.android.com/reference/android/graphics/drawable/Icon.html` | `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage#getAmbientImage()()` The image to be shown when the device is in ambient mode to save power or avoid burn in |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/drawable/Icon.html` | `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage#getImage()()` The image itself |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImageType` | `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage#getType()()` The style of the image provided, to guide how it should be displayed |
| `int` | `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage#toString()()` |

## Public fields

### PLACEHOLDER

```
public static final @NonNull SmallImage PLACEHOLDER
```

For use when the real data isn't available yet, this `https://developer.android.com/reference/androidx/wear/watchface/complications/data/SmallImage` 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 `https://developer.android.com/reference/androidx/wear/watchface/complications/data/NoDataComplicationData#placeholder()`.

## Public methods

### equals

```
public boolean equals(Object other)
```

### getAmbientImage

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

```
public final Icon getAmbientImage()
```

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

### getImage

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

```
public final @NonNull Icon getImage()
```

The image itself

### getType

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

```
public final @NonNull SmallImageType getType()
```

The style of the image provided, to guide how it should be displayed

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```