WeightedElementsComplicationData
@RequiresApi(value = 33)
class WeightedElementsComplicationData : ComplicationData
| kotlin.Any | ||
| ↳ | 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)Builder for |
|
Describes a single value within a |
Public companion properties |
|
|---|---|
List<WeightedElementsComplicationData.Element> |
Used to signal the range should be rendered as a placeholder. |
ComplicationType |
The |
Public functions |
|
|---|---|
open Instant |
getNextChangeInstant(afterInstant: Instant)Returns the next |
open Boolean |
Returns |
open String |
toString() |
Public properties |
|
|---|---|
ComplicationText? |
The content description field for accessibility. |
Int |
If elements are draw as segments then this is the background color to use in between them. |
List<WeightedElementsComplicationData.Element> |
The breakdown of the subject into various |
MonochromaticImage? |
A simple |
SmallImage? |
A |
ComplicationText? |
The body |
ComplicationText? |
The optional title |
Inherited properties |
||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public companion functions
getMaxElements
fun getMaxElements(): Int
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.
Public companion properties
PLACEHOLDER
val PLACEHOLDER: List<WeightedElementsComplicationData.Element>
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.
Public functions
getNextChangeInstant
open fun getNextChangeInstant(afterInstant: Instant): Instant
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.
hasPlaceholderFields
open fun hasPlaceholderFields(): Boolean
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.
Public properties
contentDescription
val contentDescription: ComplicationText?
The content description field for accessibility.
elementBackgroundColor
val elementBackgroundColor: Int
If elements are draw as segments then this is the background color to use in between them.
elements
val elements: List<WeightedElementsComplicationData.Element>
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.
monochromaticImage
val monochromaticImage: MonochromaticImage?
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.
smallImage
val smallImage: SmallImage?
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.
text
val text: ComplicationText?
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.
title
val title: ComplicationText?
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.