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

Builder for SmallImage.

Public companion properties
SmallImage

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

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
Icon?

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

The image itself
SmallImageType

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

Public companion properties

PLACEHOLDER

val PLACEHOLDER: SmallImage

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 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
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
val image: Icon

The image itself

type

Added in 1.0.0
val type: SmallImageType

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