public final class SmallImage

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 SmallImage.Builder

Builder for SmallImage.

Public fields
static final @NonNull SmallImage

For use when the real data isn't available yet, this SmallImage should be rendered as a placeholder.

Public methods
boolean
equals(Object other)
final Icon

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

The image itself
final @NonNull SmallImageType

The style of the image provided, to guide how it should be displayed
int
@NonNull String

Public fields

PLACEHOLDER

public static final @NonNull SmallImage PLACEHOLDER

For use when the real data isn't available yet, this 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 NoDataComplicationData.placeholder.

Public methods

equals

public boolean equals(Object other)

getAmbientImage

Added in 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
public final @NonNull Icon getImage()

The image itself

getType

Added in 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()