# SidePropagation
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
belongs to Maven artifact com.android.support:transition:28.0.0-alpha1
Summary:[Ctors](https://developer.android.com/reference/android/support/transition/SidePropagation#pubctors)\|[Methods](https://developer.android.com/reference/android/support/transition/SidePropagation#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/transition/SidePropagation#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/transition/SidePropagation#)
# SidePropagation
| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).
`
public
class
SidePropagation
`
`
``
``
extends `[VisibilityPropagation](https://developer.android.com/reference/android/support/transition/VisibilityPropagation)`
``
`
|---|---|---|--------------------------------------------|
| java.lang.Object ||||
| ↳ | [android.support.transition.TransitionPropagation](https://developer.android.com/reference/android/support/transition/TransitionPropagation) |||
| | ↳ | [android.support.transition.VisibilityPropagation](https://developer.android.com/reference/android/support/transition/VisibilityPropagation) ||
| | | ↳ | android.support.transition.SidePropagation |
*** ** * ** ***
A`TransitionPropagation`that propagates based on the distance to the side and, orthogonally, the distance to epicenter. If the transitioning View is visible in the start of the transition, then it will transition sooner when closer to the side and later when farther. If the view is not visible in the start of the transition, then it will transition later when closer to the side and sooner when farther from the edge. This is the default TransitionPropagation used with[Slide](https://developer.android.com/reference/android/transition/Slide.html).
## Summary
| ### Public constructors ||
|---------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[SidePropagation](https://developer.android.com/reference/android/support/transition/SidePropagation#SidePropagation())`() ` |
| ### Public methods ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` long` | ` `[getStartDelay](https://developer.android.com/reference/android/support/transition/SidePropagation#getStartDelay(android.view.ViewGroup, android.support.transition.Transition, android.support.transition.TransitionValues, android.support.transition.TransitionValues))`(`[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` sceneRoot, `[Transition](https://developer.android.com/reference/android/support/transition/Transition)` transition, `[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` startValues, `[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` endValues) ` Called by Transition to alter the Animator start delay. |
| ` void` | ` `[setPropagationSpeed](https://developer.android.com/reference/android/support/transition/SidePropagation#setPropagationSpeed(float))`(float propagationSpeed) ` Sets the speed at which transition propagation happens, relative to the duration of the Transition. |
| ` void` | ` `[setSide](https://developer.android.com/reference/android/support/transition/SidePropagation#setSide(int))`(int side) ` Sets the side that is used to calculate the transition propagation. |
| ### Inherited methods |
|-----------------------|---|
| [](https://developer.android.com/reference/android/support/transition/SidePropagation#)From class` `[android.support.transition.VisibilityPropagation](https://developer.android.com/reference/android/support/transition/VisibilityPropagation)` ` |-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[captureValues](https://developer.android.com/reference/android/support/transition/VisibilityPropagation#captureValues(android.support.transition.TransitionValues))`(`[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` values) ` Captures the values in the start or end scene for the properties that this transition propagation monitors. | | ` String[]` | ` `[getPropagationProperties](https://developer.android.com/reference/android/support/transition/VisibilityPropagation#getPropagationProperties())`() ` Returns the set of property names stored in the[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)object passed into[captureValues(TransitionValues)](https://developer.android.com/reference/android/support/transition/TransitionPropagation#captureValues(android.support.transition.TransitionValues))that this transition propagation cares about for the purposes of preventing duplicate capturing of property values. | | ` int` | ` `[getViewVisibility](https://developer.android.com/reference/android/support/transition/VisibilityPropagation#getViewVisibility(android.support.transition.TransitionValues))`(`[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` values) ` Returns[getVisibility()](https://developer.android.com/reference/android/view/View.html#getVisibility())for the View at the time the values were captured. | | ` int` | ` `[getViewX](https://developer.android.com/reference/android/support/transition/VisibilityPropagation#getViewX(android.support.transition.TransitionValues))`(`[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` values) ` Returns the View's center x coordinate, relative to the screen, at the time the values were captured. | | ` int` | ` `[getViewY](https://developer.android.com/reference/android/support/transition/VisibilityPropagation#getViewY(android.support.transition.TransitionValues))`(`[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` values) ` Returns the View's center y coordinate, relative to the screen, at the time the values were captured. | ||
| [](https://developer.android.com/reference/android/support/transition/SidePropagation#)From class` `[android.support.transition.TransitionPropagation](https://developer.android.com/reference/android/support/transition/TransitionPropagation)` ` |----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` `[captureValues](https://developer.android.com/reference/android/support/transition/TransitionPropagation#captureValues(android.support.transition.TransitionValues))`(`[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` transitionValues) ` Captures the values in the start or end scene for the properties that this transition propagation monitors. | | ` abstract String[]` | ` `[getPropagationProperties](https://developer.android.com/reference/android/support/transition/TransitionPropagation#getPropagationProperties())`() ` Returns the set of property names stored in the[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)object passed into[captureValues(TransitionValues)](https://developer.android.com/reference/android/support/transition/TransitionPropagation#captureValues(android.support.transition.TransitionValues))that this transition propagation cares about for the purposes of preventing duplicate capturing of property values. | | ` abstract long` | ` `[getStartDelay](https://developer.android.com/reference/android/support/transition/TransitionPropagation#getStartDelay(android.view.ViewGroup, android.support.transition.Transition, android.support.transition.TransitionValues, android.support.transition.TransitionValues))`(`[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` sceneRoot, `[Transition](https://developer.android.com/reference/android/support/transition/Transition)` transition, `[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` startValues, `[TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)` endValues) ` Called by Transition to alter the Animator start delay. | ||
| [](https://developer.android.com/reference/android/support/transition/SidePropagation#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||
## Public constructors
### SidePropagation
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
SidePropagation ()
```
## Public methods
### getStartDelay
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
long getStartDelay (ViewGroup sceneRoot,
Transition transition,
TransitionValues startValues,
TransitionValues endValues)
```
Called by Transition to alter the Animator start delay. All start delays will be adjusted such that the minimum becomes zero.
| Parameters ||
|---------------|---------------------------------------------------------------------------------|
| `sceneRoot` | `ViewGroup`: The root of the View hierarchy running the transition.
|
| `transition` | `Transition`: The transition that created the Animator
|
| `startValues` | `TransitionValues`: The values for a specific target in the start scene.
|
| `endValues` | `TransitionValues`: The values for the target in the end scene.
|
| Returns ||
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `long` | A start delay to use with the Animator created by`transition`. The delay will be offset by the minimum delay of all`TransitionPropagation`s used in the Transition so that the smallest delay will be 0. Returned values may be negative.
|
### setPropagationSpeed
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setPropagationSpeed (float propagationSpeed)
```
Sets the speed at which transition propagation happens, relative to the duration of the Transition. A`propagationSpeed`of 1 means that a View centered at the side set in[setSide(int)](https://developer.android.com/reference/android/support/transition/SidePropagation#setSide(int))and View centered at the opposite edge will have a difference in start delay of approximately the duration of the Transition. A speed of 2 means the start delay difference will be approximately half of the duration of the transition. A value of 0 is illegal, but negative values will invert the propagation.
| Parameters ||
|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `propagationSpeed` | `float`: The speed at which propagation occurs, relative to the duration of the transition. A speed of 4 means it works 4 times as fast as the duration of the transition. May not be 0.
|
### setSide
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setSide (int side)
```
Sets the side that is used to calculate the transition propagation. If the transitioning View is visible in the start of the transition, then it will transition sooner when closer to the side and later when farther. If the view is not visible in the start of the transition, then it will transition later when closer to the side and sooner when farther from the edge. The default is[BOTTOM](https://developer.android.com/reference/android/view/Gravity.html#BOTTOM).
| Parameters ||
|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `side` | `int`: The side that is used to calculate the transition propagation. Must be one of[LEFT](https://developer.android.com/reference/android/view/Gravity.html#LEFT),[TOP](https://developer.android.com/reference/android/view/Gravity.html#TOP),[RIGHT](https://developer.android.com/reference/android/view/Gravity.html#RIGHT),[BOTTOM](https://developer.android.com/reference/android/view/Gravity.html#BOTTOM),[START](https://developer.android.com/reference/android/view/Gravity.html#START), or[END](https://developer.android.com/reference/android/view/Gravity.html#END).
|
-
## Interfaces
- [Transition.TransitionListener](https://developer.android.com/reference/android/support/transition/Transition.TransitionListener)
-
## Classes
- [ArcMotion](https://developer.android.com/reference/android/support/transition/ArcMotion)
- [AutoTransition](https://developer.android.com/reference/android/support/transition/AutoTransition)
- [ChangeBounds](https://developer.android.com/reference/android/support/transition/ChangeBounds)
- [ChangeClipBounds](https://developer.android.com/reference/android/support/transition/ChangeClipBounds)
- [ChangeImageTransform](https://developer.android.com/reference/android/support/transition/ChangeImageTransform)
- [ChangeScroll](https://developer.android.com/reference/android/support/transition/ChangeScroll)
- [ChangeTransform](https://developer.android.com/reference/android/support/transition/ChangeTransform)
- [CircularPropagation](https://developer.android.com/reference/android/support/transition/CircularPropagation)
- [Explode](https://developer.android.com/reference/android/support/transition/Explode)
- [Fade](https://developer.android.com/reference/android/support/transition/Fade)
- [PathMotion](https://developer.android.com/reference/android/support/transition/PathMotion)
- [PatternPathMotion](https://developer.android.com/reference/android/support/transition/PatternPathMotion)
- [R](https://developer.android.com/reference/android/support/transition/R)
- [R.attr](https://developer.android.com/reference/android/support/transition/R.attr)
- [R.bool](https://developer.android.com/reference/android/support/transition/R.bool)
- [R.color](https://developer.android.com/reference/android/support/transition/R.color)
- [R.dimen](https://developer.android.com/reference/android/support/transition/R.dimen)
- [R.drawable](https://developer.android.com/reference/android/support/transition/R.drawable)
- [R.id](https://developer.android.com/reference/android/support/transition/R.id)
- [R.integer](https://developer.android.com/reference/android/support/transition/R.integer)
- [R.layout](https://developer.android.com/reference/android/support/transition/R.layout)
- [R.string](https://developer.android.com/reference/android/support/transition/R.string)
- [R.style](https://developer.android.com/reference/android/support/transition/R.style)
- [R.styleable](https://developer.android.com/reference/android/support/transition/R.styleable)
- [Scene](https://developer.android.com/reference/android/support/transition/Scene)
- [SidePropagation](https://developer.android.com/reference/android/support/transition/SidePropagation)
- [Slide](https://developer.android.com/reference/android/support/transition/Slide)
- [Transition](https://developer.android.com/reference/android/support/transition/Transition)
- [Transition.EpicenterCallback](https://developer.android.com/reference/android/support/transition/Transition.EpicenterCallback)
- [TransitionInflater](https://developer.android.com/reference/android/support/transition/TransitionInflater)
- [TransitionListenerAdapter](https://developer.android.com/reference/android/support/transition/TransitionListenerAdapter)
- [TransitionManager](https://developer.android.com/reference/android/support/transition/TransitionManager)
- [TransitionPropagation](https://developer.android.com/reference/android/support/transition/TransitionPropagation)
- [TransitionSet](https://developer.android.com/reference/android/support/transition/TransitionSet)
- [TransitionValues](https://developer.android.com/reference/android/support/transition/TransitionValues)
- [Visibility](https://developer.android.com/reference/android/support/transition/Visibility)
- [VisibilityPropagation](https://developer.android.com/reference/android/support/transition/VisibilityPropagation)