androidx.wear.watchface.complications.data
Note: As of July 10, 2024, watch faces must use the Watch Face Format in order to be installed on new watches that launch with Wear OS 5 pre-installed. Learn more about the user-facing changes in this Help Center article.
Additionally, starting in early 2025 (specific date to be announced during Q4 2024), all new watch faces published on Google Play must use the Watch Face Format.
Annotations
Interfaces
ComplicationText |
The text within a complication. |
Classes
ColorRamp |
Describes an optional color ramp for the progress bar associated with |
ComplicationData |
Base type for all different types of |
CountDownTimeReference |
Defines a point in time the complication is counting down until. |
CountUpTimeReference |
Defines a point in time the complication is counting up from. |
DynamicComplicationText |
A |
EmptyComplicationData |
Type sent when the user has specified that an active complication should have no complication data source, i.e. when the user has chosen "Empty" in the complication data source chooser. |
GoalProgressComplicationData |
Type used for complications which shows the user's progress towards a goal, E.g. you've done 2400 out of your daily target of 10000 steps. |
GoalProgressComplicationData.Builder |
Builder for |
LongTextComplicationData |
Type used for complications where the primary piece of data is a piece of text. |
LongTextComplicationData.Builder |
Builder for |
MonochromaticImage |
A simple, monochromatic image that can be tinted by the watch face. |
MonochromaticImage.Builder |
Builder for |
MonochromaticImageComplicationData |
Type used for complications which consist only of a |
MonochromaticImageComplicationData.Builder |
Builder for |
NoDataComplicationData |
Type that can be sent by any complication data source, regardless of the configured type, when the complication data source has no data to be displayed. |
NoPermissionComplicationData |
Type sent by the system when the watch face does not have permission to receive complication data. |
NoPermissionComplicationData.Builder |
Builder for |
NotConfiguredComplicationData |
Type sent when a complication does not have a complication data source configured. |
PhotoImageComplicationData |
Type used for complications which consist only of an image that is expected to fill a large part of the watch face, large enough to be shown as either a background or as part of a high resolution complication. |
PhotoImageComplicationData.Builder |
Builder for |
PlainComplicationText |
A |
PlainComplicationText.Builder |
A builder for |
RangedValueComplicationData |
Type used for complications including a numerical value within a range, such as a percentage. |
RangedValueComplicationData.Builder |
Builder for |
ShortTextComplicationData |
Type used for complications where the primary piece of data is a short piece of text (expected to be no more than seven characters in length). |
ShortTextComplicationData.Builder |
Builder for |
SmallImage |
An image that is expected to cover a small fraction of a watch face occupied by a single complication. |
SmallImage.Builder |
Builder for |
SmallImageComplicationData |
Type used for complications which consist only of a |
SmallImageComplicationData.Builder |
Builder for |
TimeDifferenceComplicationText |
A |
TimeDifferenceComplicationText.Builder |
Builder for |
TimeFormatComplicationText |
A |
TimeFormatComplicationText.Builder |
A builder for |
TimeRange |
A range of time, that may be unbounded on either side. |
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. |
WeightedElementsComplicationData.Builder |
Builder for |
WeightedElementsComplicationData.Element |
Describes a single value within a |
ComplicationDisplayPolicies |
The policies that control when complications should be displayed. |
ComplicationPersistencePolicies |
The policies that control complication persistence. |
Enums
ComplicationType |
The possible complication data types. |
SmallImageType |
The type of image being provided. |
TimeDifferenceStyle |
The styling used for showing a time different by ComplicationText#TimeDifferenceBuilder. |
TimeFormatStyle |
The format in which the time should be displayed. |