# GoalProgressComplicationData

Artifact: [androidx.wear.watchface:watchface-complications-data](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/complications/data/Data.kt+class:androidx.wear.watchface.complications.data.GoalProgressComplicationData) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

*** ** * ** ***

<br />

```
@RequiresApi(value = 33)
class GoalProgressComplicationData : ComplicationData
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.wear.watchface.complications.data.ComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData) ||
|   | ↳ | [androidx.wear.watchface.complications.data.GoalProgressComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/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. Unlike `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#value()` is allowed to be larger than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#targetValue()` (e.g. you've done 12000 steps) and renderers may chose to acknowledge this in a special way (e.g. by colorizing part of the progress bar in a different color to indicate progress past the goal). The value may be accompanied by an icon and/or short text and title.

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#targetValue()` field is required for this type, as well as one of `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#value()` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#dynamicValue()`. The progress is expected to always be displayed.

The icon, title, and text fields are optional and the watch face may choose which of these fields to display, if any.

If a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#monochromaticImage()` and a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#smallImage()` are both specified then only one should be displayed. If the complication is drawn with a single color it's recommended to choose `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#monochromaticImage()` and apply a tint. If the complication is rendered with multiple colors it's recommended to choose the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#smallImage()`. It's best practice for a ComplicationDataSource to specify both a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#monochromaticImage()` and a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#smallImage()`.

If you want to represent a score for something that's not based on the user (e.g. air quality index) then you should instead use a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/RangedValueComplicationData` and pass `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/RangedValueComplicationData#TYPE_RATING()` into `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/RangedValueComplicationData.Builder#setValueType(kotlin.Int)`.

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):

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

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 33) class https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData`. |

| ### Public companion properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#PLACEHOLDER()` Used to signal the range should be rendered as a placeholder. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#TYPE()` The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` corresponding to objects of this type. |

| ### Public functions |
|---|---|
| `open https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#getNextChangeInstant(java.time.Instant)(afterInstant: https://developer.android.com/reference/java/time/Instant.html)` Returns the next `https://developer.android.com/reference/java/time/Instant.html` after `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#getNextChangeInstant(java.time.Instant)` at which any field of the complication may change. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#hasPlaceholderFields()()` Returns `true` if any of the fields of this ComplicationData are placeholders. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ColorRamp?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#colorRamp()` Optional hint to render the progress bar representing `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#value()` with the specified `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ColorRamp`. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#contentDescription()` The content description field for accessibility. |
| `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicFloat?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#dynamicValue()` The `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicFloat` optionally set by the data source. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#monochromaticImage()` A simple `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage` image that can be tinted by the watch face. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#smallImage()` A `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage` that is expected to cover a small fraction of a watch face occupied by a single complication. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#targetValue()` The target `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` value for this complication. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#text()` The body `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText` of the complication. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#title()` The optional title `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#value()` The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` value of this complication which is \>= 0f, this value may be larger than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#targetValue()`. |

### Inherited functions

From [androidx.wear.watchface.complications.data.ComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData) `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#hashCode()()`

### Inherited properties

From [androidx.wear.watchface.complications.data.ComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData) `https://developer.android.com/reference/android/content/ComponentName.html?` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#dataSource()`

The `https://developer.android.com/reference/android/content/ComponentName.html` of the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/datasource/ComplicationDataSourceService` that provided the ComplicationData.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#displayPolicy()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationDisplayPolicies` for this complication.
`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData?` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#dynamicValueInvalidationFallback()`

Used in case any dynamic value has been invalidated.
`https://developer.android.com/reference/android/os/PersistableBundle.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#extras()`

A copy of any extras set by a complication provider with the privileged permission `com.google.wear.permission.SET_COMPLICATION_EXTRAS` or `https://developer.android.com/reference/android/os/PersistableBundle.html#EMPTY`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#persistencePolicy()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationPersistencePolicies` for this complication.
`https://developer.android.com/reference/android/app/PendingIntent.html?` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#tapAction()`

The `https://developer.android.com/reference/android/app/PendingIntent.html` to send when the complication is tapped on.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#tapActionLostDueToSerialization()`

`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#tapAction()` which is a `https://developer.android.com/reference/android/app/PendingIntent.html` unfortunately can't be serialized.
`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#type()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` of this complication data.
`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/TimeRange` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#validTimeRange()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/TimeRange` within which the complication should be displayed.

## Public companion properties

### PLACEHOLDER

```
val PLACEHOLDER: Float
```

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 `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/NoDataComplicationData#placeholder()`.

### TYPE

```
val TYPE: ComplicationType
```

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` corresponding to objects of this type.

## Public functions

### getNextChangeInstant

```
open fun getNextChangeInstant(afterInstant: Instant): Instant
```

Returns the next `https://developer.android.com/reference/java/time/Instant.html` after `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#getNextChangeInstant(java.time.Instant)` at which any field of the complication may change. If there's no scheduled changes then `https://developer.android.com/reference/java/time/Instant.html#MAX` will be returned.

See `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText#getNextChangeTime(java.time.Instant)`

| Parameters |
|---|---|
| `afterInstant: https://developer.android.com/reference/java/time/Instant.html` | The reference `https://developer.android.com/reference/java/time/Instant.html`, after which changes will be reported. |

### 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: `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText#PLACEHOLDER()`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage#PLACEHOLDER()`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#PLACEHOLDER()`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/PhotoImageComplicationData#PLACEHOLDER()`, or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/RangedValueComplicationData#PLACEHOLDER()`.

### toString

```
open fun toString(): String
```

## Public properties

### colorRamp

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val colorRamp: ColorRamp?
```

Optional hint to render the progress bar representing `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#value()` with the specified `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ColorRamp`.

### contentDescription

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val contentDescription: ComplicationText?
```

The content description field for accessibility.

### dynamicValue

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val dynamicValue: DynamicBuilders.DynamicFloat?
```

The `https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/DynamicBuilders.DynamicFloat` optionally set by the data source. If present the system will dynamically evaluate this and store the result in `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#value()`. Watch faces can typically ignore this field.

### monochromaticImage

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val monochromaticImage: MonochromaticImage?
```

A simple `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage` image that can be tinted by the watch face. If the monochromaticImage is equal to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/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

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val smallImage: SmallImage?
```

A `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage` that is expected to cover a small fraction of a watch face occupied by a single complication. If the smallImage is equal to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/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.

### targetValue

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val targetValue: Float
```

The target `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` value for this complication.

### text

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val text: ComplicationText?
```

The body `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/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 `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/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

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val title: ComplicationText?
```

The optional title `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/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 `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/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.

### value

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
val value: Float
```

The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` value of this complication which is \>= 0f, this value may be larger than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#targetValue()`. If it's equal to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/GoalProgressComplicationData#PLACEHOLDER()` the renderer must treat it as a placeholder rather than rendering normally, its suggested to be drawn as a grey arc with a percentage value selected by the renderer.