# ViewPropertyAnimatorCompat

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/ViewPropertyAnimatorCompat.java+class:androidx.core.view.ViewPropertyAnimatorCompat) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

*** ** * ** ***


```
public final class ViewPropertyAnimatorCompat
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#alpha(float)(float value)` This method will cause the View's `alpha` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#alphaBy(float)(float value)` This method will cause the View's `alpha` property to be animated by the specified value. |
| `void` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#cancel()()` Cancels all property animations that are currently running or pending. |
| `long` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#getDuration()()` Returns the current duration of property animations. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/animation/Interpolator.html` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#getInterpolator()()` Returns the timing interpolator that this animation uses. |
| `long` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#getStartDelay()()` Returns the current startDelay of property animations. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#rotation(float)(float value)` This method will cause the View's `rotation` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#rotationBy(float)(float value)` This method will cause the View's `rotation` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#rotationX(float)(float value)` This method will cause the View's `rotationX` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#rotationXBy(float)(float value)` This method will cause the View's `rotationX` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#rotationY(float)(float value)` This method will cause the View's `rotationY` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#rotationYBy(float)(float value)` This method will cause the View's `rotationY` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#scaleX(float)(float value)` This method will cause the View's `scaleX` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#scaleXBy(float)(float value)` This method will cause the View's `scaleX` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#scaleY(float)(float value)` This method will cause the View's `scaleY` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#scaleYBy(float)(float value)` This method will cause the View's `scaleY` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setDuration(long)(long value)` Sets the duration for the underlying animator that animates the requested properties. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setInterpolator(android.view.animation.Interpolator)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/animation/Interpolator.html value)` Sets the interpolator for the underlying animator that animates the requested properties. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setListener(androidx.core.view.ViewPropertyAnimatorListener)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorListener listener)` Sets a listener for events in the underlying Animators that run the property animations. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setStartDelay(long)(long value)` Sets the startDelay for the underlying animator that animates the requested properties. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setUpdateListener(androidx.core.view.ViewPropertyAnimatorUpdateListener)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorUpdateListener listener)` Sets a listener for update events in the underlying Animator that runs the property animations. |
| `void` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#start()()` Starts the currently pending property animations immediately. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#translationX(float)(float value)` This method will cause the View's `translationX` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#translationXBy(float)(float value)` This method will cause the View's `translationX` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#translationY(float)(float value)` This method will cause the View's `translationY` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#translationYBy(float)(float value)` This method will cause the View's `translationY` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#translationZ(float)(float value)` This method will cause the View's `translationZ` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#translationZBy(float)(float value)` This method will cause the View's `translationZ` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#withEndAction(java.lang.Runnable)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/Runnable.html runnable)` Specifies an action to take place when the next animation ends. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#withLayer()()` The View associated with this ViewPropertyAnimator will have its `https://developer.android.com/reference/android/view/View.html#setLayerType(int, android.graphics.Paint)` set to `https://developer.android.com/reference/android/view/View.html#LAYER_TYPE_HARDWARE` for the duration of the next animation. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#withStartAction(java.lang.Runnable)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/Runnable.html runnable)` Specifies an action to take place when the next animation runs. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#x(float)(float value)` This method will cause the View's `x` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#xBy(float)(float value)` This method will cause the View's `x` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#y(float)(float value)` This method will cause the View's `y` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#yBy(float)(float value)` This method will cause the View's `y` property to be animated by the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#z(float)(float value)` This method will cause the View's `z` property to be animated to the specified value. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#zBy(float)(float value)` This method will cause the View's `z` property to be animated by the specified value. |

## Public methods

### alpha

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat alpha(float value)
```

This method will cause the View's `alpha` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### alphaBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat alphaBy(float value)
```

This method will cause the View's `alpha` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### cancel

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public void cancel()
```

Cancels all property animations that are currently running or pending.

### getDuration

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public long getDuration()
```

Returns the current duration of property animations. If the duration was set on this object, that value is returned. Otherwise, the default value of the underlying Animator is returned.

| Returns |
|---|---|
| `long` | The duration of animations, in milliseconds. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setDuration(long)` |   |

### getInterpolator

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @Nullable Interpolator getInterpolator()
```

Returns the timing interpolator that this animation uses.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/animation/Interpolator.html` | The timing interpolator for this animation. |

### getStartDelay

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public long getStartDelay()
```

Returns the current startDelay of property animations. If the startDelay was set on this object, that value is returned. Otherwise, the default value of the underlying Animator is returned.

| Returns |
|---|---|
| `long` | The startDelay of animations, in milliseconds. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setStartDelay(long)` |   |

### rotation

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat rotation(float value)
```

This method will cause the View's `rotation` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### rotationBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat rotationBy(float value)
```

This method will cause the View's `rotation` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### rotationX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat rotationX(float value)
```

This method will cause the View's `rotationX` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### rotationXBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat rotationXBy(float value)
```

This method will cause the View's `rotationX` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### rotationY

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat rotationY(float value)
```

This method will cause the View's `rotationY` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### rotationYBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat rotationYBy(float value)
```

This method will cause the View's `rotationY` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### scaleX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat scaleX(float value)
```

This method will cause the View's `scaleX` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### scaleXBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat scaleXBy(float value)
```

This method will cause the View's `scaleX` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### scaleY

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat scaleY(float value)
```

This method will cause the View's `scaleY` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### scaleYBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat scaleYBy(float value)
```

This method will cause the View's `scaleY` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### setDuration

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat setDuration(long value)
```

Sets the duration for the underlying animator that animates the requested properties. By default, the animator uses the default value for ValueAnimator. Calling this method will cause the declared value to be used instead.

| Parameters |
|---|---|
| `long value` | The length of ensuing property animations, in milliseconds. The value cannot be negative. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### setInterpolator

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat setInterpolator(@Nullable Interpolator value)
```

Sets the interpolator for the underlying animator that animates the requested properties. By default, the animator uses the default interpolator for ValueAnimator. Calling this method will cause the declared object to be used instead.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/animation/Interpolator.html value` | The TimeInterpolator to be used for ensuing property animations. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### setListener

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat setListener(@Nullable ViewPropertyAnimatorListener listener)
```

Sets a listener for events in the underlying Animators that run the property animations.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorListener listener` | The listener to be called with AnimatorListener events. A value of `null` removes any existing listener. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### setStartDelay

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat setStartDelay(long value)
```

Sets the startDelay for the underlying animator that animates the requested properties. By default, the animator uses the default value for ValueAnimator. Calling this method will cause the declared value to be used instead.

| Parameters |
|---|---|
| `long value` | The delay of ensuing property animations, in milliseconds. The value cannot be negative. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### setUpdateListener

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat setUpdateListener(@Nullable ViewPropertyAnimatorUpdateListener listener)
```

Sets a listener for update events in the underlying Animator that runs the property animations.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorUpdateListener listener` | The listener to be called with update events. A value of `null` removes any existing listener. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### start

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public void start()
```

Starts the currently pending property animations immediately. Calling `start()` is optional because all animations start automatically at the next opportunity. However, if the animations are needed to start immediately and synchronously (not at the time when the next event is processed by the hierarchy, which is when the animations would begin otherwise), then this method can be used.

### translationX

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat translationX(float value)
```

This method will cause the View's `translationX` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### translationXBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat translationXBy(float value)
```

This method will cause the View's `translationX` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### translationY

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat translationY(float value)
```

This method will cause the View's `translationY` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### translationYBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat translationYBy(float value)
```

This method will cause the View's `translationY` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### translationZ

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat translationZ(float value)
```

This method will cause the View's `translationZ` property to be animated to the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### translationZBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat translationZBy(float value)
```

This method will cause the View's `translationZ` property to be animated by the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### withEndAction

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat withEndAction(@NonNull Runnable runnable)
```

Specifies an action to take place when the next animation ends. The action is only run if the animation ends normally; if the ViewPropertyAnimator is canceled during that animation, the runnable will not run. This method, along with `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#withStartAction(java.lang.Runnable)`, is intended to help facilitate choreographing ViewPropertyAnimator animations with other animations or actions in the application.

For example, the following code animates a view to x=200 and then back to 0:

```
    Runnable endAction = new Runnable() {
        public void run() {
            view.animate().x(0);
        }
    };
    view.animate().x(200).withEndAction(endAction);
```

For API 14 and 15, this method will run by setting a listener on the ViewPropertyAnimatorCompat object and running the action in that listener's `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorListener#onAnimationEnd(android.view.View)` method.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/Runnable.html runnable` | The action to run when the next animation ends. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### withLayer

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat withLayer()
```

The View associated with this ViewPropertyAnimator will have its `https://developer.android.com/reference/android/view/View.html#setLayerType(int, android.graphics.Paint)` set to `https://developer.android.com/reference/android/view/View.html#LAYER_TYPE_HARDWARE` for the duration of the next animation. As stated in the documentation for `https://developer.android.com/reference/android/view/View.html#LAYER_TYPE_HARDWARE`, the actual type of layer used internally depends on the runtime situation of the view. If the activity and this view are hardware-accelerated, then the layer will be accelerated as well. If the activity or the view is not accelerated, then the layer will effectively be the same as `https://developer.android.com/reference/android/view/View.html#LAYER_TYPE_SOFTWARE`.

This state is not persistent, either on the View or on this ViewPropertyAnimator: the layer type of the View will be restored when the animation ends to what it was when this method was called, and this setting on ViewPropertyAnimator is only valid for the next animation. Note that calling this method and then independently setting the layer type of the View (by a direct call to `https://developer.android.com/reference/android/view/View.html#setLayerType(int, android.graphics.Paint)`) will result in some inconsistency, including having the layer type restored to its pre-withLayer() value when the animation ends.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/view/View.html#setLayerType(int, android.graphics.Paint)` |   |

### withStartAction

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat withStartAction(@NonNull Runnable runnable)
```

Specifies an action to take place when the next animation runs. If there is a `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#setStartDelay(long)` set on this ViewPropertyAnimator, then the action will run after that startDelay expires, when the actual animation begins. This method, along with `https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat#withEndAction(java.lang.Runnable)`, is intended to help facilitate choreographing ViewPropertyAnimator animations with other animations or actions in the application.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/Runnable.html runnable` | The action to run when the next animation starts. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### x

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat x(float value)
```

This method will cause the View's `x` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### xBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat xBy(float value)
```

This method will cause the View's `x` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### y

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat y(float value)
```

This method will cause the View's `y` property to be animated to the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The value to be animated to. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### yBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat yBy(float value)
```

This method will cause the View's `y` property to be animated by the specified value. Animations already running on the property will be canceled.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### z

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat z(float value)
```

This method will cause the View's `z` property to be animated to the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |

### zBy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public @NonNull ViewPropertyAnimatorCompat zBy(float value)
```

This method will cause the View's `z` property to be animated by the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.

| Parameters |
|---|---|
| `float value` | The amount to be animated by, as an offset from the current value. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat` | This object, allowing calls to methods in this class to be chained. |