# ViewPropertyAnimatorCompat
# 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)
*** ** * ** ***
Kotlin\|[Java](https://developer.android.com/reference/androidx/core/view/ViewPropertyAnimatorCompat "View this page in Java")
```
class ViewPropertyAnimatorCompat
```
*** ** * ** ***
## Summary
| ### Public functions |
|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [alpha](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#alpha(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`alpha`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [alphaBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#alphaBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`alpha`property to be animated by the specified value. |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [cancel](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#cancel())`()` Cancels all property animations that are currently running or pending. |
| [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | [getDuration](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#getDuration())`()` Returns the current duration of property animations. |
| [Interpolator](https://developer.android.com/reference/android/view/animation/Interpolator.html)`?` | [getInterpolator](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#getInterpolator())`()` Returns the timing interpolator that this animation uses. |
| [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | [getStartDelay](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#getStartDelay())`()` Returns the current startDelay of property animations. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [rotation](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#rotation(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`rotation`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [rotationBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#rotationBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`rotation`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [rotationX](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#rotationX(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`rotationX`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [rotationXBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#rotationXBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`rotationX`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [rotationY](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#rotationY(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`rotationY`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [rotationYBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#rotationYBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`rotationY`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [scaleX](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#scaleX(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`scaleX`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [scaleXBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#scaleXBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`scaleX`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [scaleY](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#scaleY(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`scaleY`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [scaleYBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#scaleYBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`scaleY`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [setDuration](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#setDuration(long))`(value: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`)` Sets the duration for the underlying animator that animates the requested properties. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [setInterpolator](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#setInterpolator(android.view.animation.Interpolator))`(value: `[Interpolator](https://developer.android.com/reference/android/view/animation/Interpolator.html)`?)` Sets the interpolator for the underlying animator that animates the requested properties. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [setListener](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#setListener(androidx.core.view.ViewPropertyAnimatorListener))`(listener: `[ViewPropertyAnimatorListener](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorListener)`?)` Sets a listener for events in the underlying Animators that run the property animations. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [setStartDelay](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#setStartDelay(long))`(value: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`)` Sets the startDelay for the underlying animator that animates the requested properties. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [setUpdateListener](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#setUpdateListener(androidx.core.view.ViewPropertyAnimatorUpdateListener))`(listener: `[ViewPropertyAnimatorUpdateListener](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorUpdateListener)`?)` Sets a listener for update events in the underlying Animator that runs the property animations. |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [start](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#start())`()` Starts the currently pending property animations immediately. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [translationX](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#translationX(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`translationX`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [translationXBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#translationXBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`translationX`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [translationY](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#translationY(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`translationY`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [translationYBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#translationYBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`translationY`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [translationZ](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#translationZ(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`translationZ`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [translationZBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#translationZBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`translationZ`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [withEndAction](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#withEndAction(java.lang.Runnable))`(runnable: `[Runnable](https://developer.android.com/reference/java/lang/Runnable.html)`)` Specifies an action to take place when the next animation ends. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [withLayer](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#withLayer())`()` The View associated with this ViewPropertyAnimator will have its[layer type](https://developer.android.com/reference/android/view/View.html#setLayerType(int, android.graphics.Paint))set to[LAYER_TYPE_HARDWARE](https://developer.android.com/reference/android/view/View.html#LAYER_TYPE_HARDWARE())for the duration of the next animation. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [withStartAction](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#withStartAction(java.lang.Runnable))`(runnable: `[Runnable](https://developer.android.com/reference/java/lang/Runnable.html)`)` Specifies an action to take place when the next animation runs. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [x](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#x(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`x`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [xBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#xBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`x`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [y](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#y(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`y`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [yBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#yBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`y`property to be animated by the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [z](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#z(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`z`property to be animated to the specified value. |
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | [zBy](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#zBy(float))`(value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` This method will cause the View's`z`property to be animated by the specified value. |
## Public functions
### alpha
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun alpha(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun alphaBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun cancel(): Unit
```
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)
```
fun getDuration(): Long
```
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](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | The duration of animations, in milliseconds. |
| See also |
|-------------------------------------------------------------------------------------------------------------------------------|---|
| [setDuration](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#setDuration(long)) | |
### getInterpolator
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun getInterpolator(): Interpolator?
```
Returns the timing interpolator that this animation uses.
| Returns |
|-----------------------------------------------------------------------------------------------------|---------------------------------------------|
| [Interpolator](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)
```
fun getStartDelay(): Long
```
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](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | The startDelay of animations, in milliseconds. |
| See also |
|-----------------------------------------------------------------------------------------------------------------------------------|---|
| [setStartDelay](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat#setStartDelay(long)) | |
### rotation
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun rotation(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun rotationBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun rotationX(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun rotationXBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun rotationY(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun rotationYBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun scaleX(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun scaleXBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun scaleY(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun scaleYBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun setDuration(value: Long): ViewPropertyAnimatorCompat
```
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 |
|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| `value: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | The length of ensuing property animations, in milliseconds. The value cannot be negative. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun setInterpolator(value: Interpolator?): ViewPropertyAnimatorCompat
```
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 |
|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
| `value: `[Interpolator](https://developer.android.com/reference/android/view/animation/Interpolator.html)`?` | The TimeInterpolator to be used for ensuing property animations. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun setListener(listener: ViewPropertyAnimatorListener?): ViewPropertyAnimatorCompat
```
Sets a listener for events in the underlying Animators that run the property animations.
| Parameters |
|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| `listener: `[ViewPropertyAnimatorListener](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorListener)`?` | The listener to be called with AnimatorListener events. A value of`null`removes any existing listener. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun setStartDelay(value: Long): ViewPropertyAnimatorCompat
```
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 |
|----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| `value: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | The delay of ensuing property animations, in milliseconds. The value cannot be negative. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun setUpdateListener(listener: ViewPropertyAnimatorUpdateListener?): ViewPropertyAnimatorCompat
```
Sets a listener for update events in the underlying Animator that runs the property animations.
| Parameters |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
| `listener: `[ViewPropertyAnimatorUpdateListener](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorUpdateListener)`?` | The listener to be called with update events. A value of`null`removes any existing listener. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun start(): Unit
```
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)
```
fun translationX(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun translationXBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun translationY(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun translationYBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun translationZ(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun translationZBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun withEndAction(runnable: Runnable): ViewPropertyAnimatorCompat
```
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[withStartAction](https://developer.android.com/reference/kotlin/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:
```kotlin
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[onAnimationEnd](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorListener#onAnimationEnd(android.view.View))method.
| Parameters |
|-----------------------------------------------------------------------------------------|-------------------------------------------------|
| `runnable: `[Runnable](https://developer.android.com/reference/java/lang/Runnable.html) | The action to run when the next animation ends. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun withLayer(): ViewPropertyAnimatorCompat
```
The View associated with this ViewPropertyAnimator will have its[layer type](https://developer.android.com/reference/android/view/View.html#setLayerType(int, android.graphics.Paint))set to[LAYER_TYPE_HARDWARE](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[LAYER_TYPE_HARDWARE](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[LAYER_TYPE_SOFTWARE](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[setLayerType](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 |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | This object, allowing calls to methods in this class to be chained. |
| See also |
|--------------------------------------------------------------------------------------------------------------------------|---|
| [setLayerType](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)
```
fun withStartAction(runnable: Runnable): ViewPropertyAnimatorCompat
```
Specifies an action to take place when the next animation runs. If there is a[startDelay](https://developer.android.com/reference/kotlin/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[withEndAction](https://developer.android.com/reference/kotlin/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 |
|-----------------------------------------------------------------------------------------|---------------------------------------------------|
| `runnable: `[Runnable](https://developer.android.com/reference/java/lang/Runnable.html) | The action to run when the next animation starts. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun x(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun xBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun y(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The value to be animated to. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun yBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun z(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/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)
```
fun zBy(value: Float): ViewPropertyAnimatorCompat
```
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 |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| `value: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The amount to be animated by, as an offset from the current value. |
| Returns |
|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| [ViewPropertyAnimatorCompat](https://developer.android.com/reference/kotlin/androidx/core/view/ViewPropertyAnimatorCompat) | This object, allowing calls to methods in this class to be chained. |