WeightedElementsComplicationData

@RequiresApi(value = 33)
public final class WeightedElementsComplicationData extends ComplicationData

java.lang.Object
   ↳ androidx.wear.watchface.complications.data.ComplicationData
     ↳ androidx.wear.watchface.complications.data.WeightedElementsComplicationData

Type used for complications which want to display the breakdown of something (e.g. nutrition data) perhaps as a pie chart, or as a stacked bar chart etc. The breakdown may be accompanied by an icon and/or short text and title.

The elements field is required for this type and is expected to always be displayed.

The monochromaticImage, smallImage, title, and text fields are optional but at least one of them must be set. The watch face may choose which of these fields to display, if any.

If a monochromaticImage and a smallImage are both specified then only one should be displayed. If the complication is drawn with a single color it's recommended to choose monochromaticImage and apply a tint. If the complication is rendered with multiple colors it's recommended to choose the smallImage. It's best practice for a ComplicationDataSource to specify both a monochromaticImage and a smallImage.

A data source that wants to serve a SmallImageComplicationData must include the following meta data in its manifest (NB the value is a comma separated list):

<meta-data android:name="android.support.wearable.complications.SUPPORTED_TYPES"
   android:value="WEIGHTED_ELEMENTS"/>

Summary

Nested types
@RequiresApi(value = 33)
public final class WeightedElementsComplicationData.Builder

Builder for WeightedElementsComplicationData.

Describes a single value within a WeightedElementsComplicationData.

Public fields
static final @NonNull List<@NonNull WeightedElementsComplicationData.Element>

Used to signal the range should be rendered as a placeholder.
static final @NonNull ComplicationType

The ComplicationType corresponding to objects of this type.

Public methods
final ComplicationText

The content description field for accessibility.
final int

If elements are draw as segments then this is the background color to use in between them.
final @NonNull List<@NonNull WeightedElementsComplicationData.Element>

The breakdown of the subject into various Elements (e.g. the proportion of calories consumed which were carbohydrates, fats, etc.).
static final int

Returns the maximum size for elements.
final MonochromaticImage

A simple MonochromaticImage image that can be tinted by the watch face.
@NonNull Instant

Returns the next Instant after afterInstant at which any field of the complication may change.
final SmallImage

A SmallImage that is expected to cover a small fraction of a watch face occupied by a single complication.
final ComplicationText

The body ComplicationText of the complication.
final ComplicationText

The optional title ComplicationText.
boolean

Returns true if any of the fields of this ComplicationData are placeholders.
@NonNull String

Inherited methods
From androidx.wear.watchface.complications.data.ComplicationData
boolean
equals(Object other)
final ComponentName

The ComponentName of the androidx.wear.watchface.complications.datasource.ComplicationDataSourceService that provided the ComplicationData.
final int

The display policy for this complication.
final ComplicationData

Used in case any dynamic value has been invalidated.
final int

The persistence policy for this complication.
final PendingIntent

The PendingIntent to send when the complication is tapped on.
final boolean

tapAction which is a PendingIntent unfortunately can't be serialized.
final @NonNull ComplicationType

The ComplicationType of this complication data.
final @NonNull TimeRange

The TimeRange within which the complication should be displayed.
int
final void
setTapActionLostDueToSerialization(
    boolean tapActionLostDueToSerialization
)

tapAction which is a PendingIntent unfortunately can't be serialized.

Public fields

PLACEHOLDER

public static final @NonNull List<@NonNull WeightedElementsComplicationData.Element> PLACEHOLDER

Used to signal the range should be rendered as a placeholder. It's suggested that a placeholder ranged value be drawn as a grey arc with a percentage value selected by the renderer.

Note a placeholder may only be used in the context of NoDataComplicationData.placeholder.

TYPE

public static final @NonNull ComplicationType TYPE

The ComplicationType corresponding to objects of this type.

Public methods

getContentDescription

Added in 1.2.0
public final ComplicationText getContentDescription()

The content description field for accessibility.

getElementBackgroundColor

Added in 1.2.0
public final int getElementBackgroundColor()

If elements are draw as segments then this is the background color to use in between them.

getElements

Added in 1.2.0
public final @NonNull List<@NonNull WeightedElementsComplicationData.Element> getElements()

The breakdown of the subject into various Elements (e.g. the proportion of calories consumed which were carbohydrates, fats, etc.). The colors need to be meaningful to the user (e.g. blue is cold, yellow/red is worm), and should be consistent with the experience launched by tapping on the complication. If this is equal to PLACEHOLDER then the renderer must display this in a visually distinct way to suggest to the user that it's placeholder data. E.g. each element is rendered in light grey. The maximum valid size of this list is provided by getMaxElements and it will be truncated if its larger.

getMaxElements

Added in 1.2.0
public static final int getMaxElements()

Returns the maximum size for elements. Complications are small and if we have a very large number of elements we likely won't be able to render them properly because the individual elements will be too small on screen.

getMonochromaticImage

Added in 1.2.0
public final MonochromaticImage getMonochromaticImage()

A simple MonochromaticImage image that can be tinted by the watch face. If the monochromaticImage is equal to MonochromaticImage.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.

getNextChangeInstant

public @NonNull Instant getNextChangeInstant(@NonNull Instant afterInstant)

Returns the next Instant after afterInstant at which any field of the complication may change. If there's no scheduled changes then Instant.MAX will be returned.

See ComplicationText.getNextChangeTime

Parameters
@NonNull Instant afterInstant

The reference Instant, after which changes will be reported.

getSmallImage

Added in 1.2.0
public final SmallImage getSmallImage()

A SmallImage that is expected to cover a small fraction of a watch face occupied by a single complication. If the smallImage is equal to SmallImage.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.

getText

Added in 1.2.0
public final ComplicationText getText()

The body ComplicationText of the complication. The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated. If the text is equal to ComplicationText.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.

getTitle

Added in 1.2.0
public final ComplicationText getTitle()

The optional title ComplicationText. The length of the title, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated. If the title is equal to ComplicationText.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.

hasPlaceholderFields

public boolean hasPlaceholderFields()

Returns true if any of the fields of this ComplicationData are placeholders. I.e. if any fields are equal to: ComplicationText.PLACEHOLDER, SmallImage.PLACEHOLDER, MonochromaticImage.PLACEHOLDER, PhotoImageComplicationData.PLACEHOLDER, or RangedValueComplicationData.PLACEHOLDER.

toString

public @NonNull String toString()