# VisibilityPropagation

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

*** ** * ** ***


```
public abstract class VisibilityPropagation extends TransitionPropagation
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.transition.TransitionPropagation](https://developer.android.com/reference/androidx/transition/TransitionPropagation) ||
|   | ↳ | [androidx.transition.VisibilityPropagation](https://developer.android.com/reference/androidx/transition/VisibilityPropagation) |

Known direct subclasses [CircularPropagation](https://developer.android.com/reference/androidx/transition/CircularPropagation), [SidePropagation](https://developer.android.com/reference/androidx/transition/SidePropagation)

|---|---|
| `https://developer.android.com/reference/androidx/transition/CircularPropagation` | A propagation that varies with the distance to the epicenter of the Transition or center of the scene if no epicenter exists. |
| `https://developer.android.com/reference/androidx/transition/SidePropagation` | A `TransitionPropagation` that propagates based on the distance to the side and, orthogonally, the distance to epicenter. |

*** ** * ** ***

Base class for `TransitionPropagation`s that care about View Visibility and the center position of the View.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/transition/VisibilityPropagation#VisibilityPropagation()()` |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/transition/VisibilityPropagation#captureValues(androidx.transition.TransitionValues)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/transition/TransitionValues transitionValues)` Captures the values in the start or end scene for the properties that this transition propagation monitors. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html String[]` | `https://developer.android.com/reference/androidx/transition/VisibilityPropagation#getPropagationProperties()()` Returns the set of property names stored in the `https://developer.android.com/reference/androidx/transition/TransitionValues` object passed into `https://developer.android.com/reference/androidx/transition/TransitionPropagation#captureValues(androidx.transition.TransitionValues)` that this transition propagation cares about for the purposes of preventing duplicate capturing of property values. |
| `int` | `https://developer.android.com/reference/androidx/transition/VisibilityPropagation#getViewVisibility(androidx.transition.TransitionValues)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues values)` Returns `https://developer.android.com/reference/android/view/View.html#getVisibility()` for the View at the time the values were captured. |
| `int` | `https://developer.android.com/reference/androidx/transition/VisibilityPropagation#getViewX(androidx.transition.TransitionValues)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues values)` Returns the View's center x coordinate, relative to the screen, at the time the values were captured. |
| `int` | `https://developer.android.com/reference/androidx/transition/VisibilityPropagation#getViewY(androidx.transition.TransitionValues)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues values)` Returns the View's center y coordinate, relative to the screen, at the time the values were captured. |

| ### Inherited methods |
|---|
| From [androidx.transition.TransitionPropagation](https://developer.android.com/reference/androidx/transition/TransitionPropagation) |---|---| | `abstract long` | `https://developer.android.com/reference/androidx/transition/TransitionPropagation#getStartDelay(android.view.ViewGroup,androidx.transition.Transition,androidx.transition.TransitionValues,androidx.transition.TransitionValues)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/ViewGroup.html sceneRoot, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/transition/Transition transition, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues startValues, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues endValues )` Called by Transition to alter the Animator start delay. | |

## Public constructors

### VisibilityPropagation

Added in 1.0.0

```
public VisibilityPropagation()
```

## Public methods

### captureValues

```
public void captureValues(@NonNull TransitionValues transitionValues)
```

Captures the values in the start or end scene for the properties that this transition propagation monitors. These values are then passed as the startValues or endValues structure in a later call to `https://developer.android.com/reference/androidx/transition/TransitionPropagation#getStartDelay(android.view.ViewGroup,androidx.transition.Transition,androidx.transition.TransitionValues,androidx.transition.TransitionValues)`. The main concern for an implementation is what the properties are that the transition cares about and what the values are for all of those properties. The start and end values will be compared later during the `https://developer.android.com/reference/androidx/transition/TransitionPropagation#getStartDelay(android.view.ViewGroup,androidx.transition.Transition,androidx.transition.TransitionValues,androidx.transition.TransitionValues)`. method to determine the start delay.

Subclasses must implement this method. The method should only be called by the transition system; it is not intended to be called from external classes.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/transition/TransitionValues transitionValues` | The holder for any values that the Transition wishes to store. Values are stored in the `values` field of this TransitionValues object and are keyed from a String value. For example, to store a view's rotation value, a transition might call `transitionValues.values.put("appname:transitionname:rotation", view.getRotation())`. The target view will already be stored in the transitionValues structure when this method is called. |

### getPropagationProperties

```
public @Nullable String[] getPropagationProperties()
```

Returns the set of property names stored in the `https://developer.android.com/reference/androidx/transition/TransitionValues` object passed into `https://developer.android.com/reference/androidx/transition/TransitionPropagation#captureValues(androidx.transition.TransitionValues)` that this transition propagation cares about for the purposes of preventing duplicate capturing of property values.

A `TransitionPropagation` must override this method to prevent duplicate capturing of values and must contain at least one

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html String[]` | An array of property names as described in the class documentation for `https://developer.android.com/reference/androidx/transition/TransitionValues`. |

### getViewVisibility

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

```
public int getViewVisibility(@Nullable TransitionValues values)
```

Returns `https://developer.android.com/reference/android/view/View.html#getVisibility()` for the View at the time the values were captured.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues values` | The TransitionValues captured at the start or end of the Transition. |

| Returns |
|---|---|
| `int` | `https://developer.android.com/reference/android/view/View.html#getVisibility()` for the View at the time the values were captured. |

### getViewX

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

```
public int getViewX(@Nullable TransitionValues values)
```

Returns the View's center x coordinate, relative to the screen, at the time the values were captured.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues values` | The TransitionValues captured at the start or end of the Transition. |

| Returns |
|---|---|
| `int` | the View's center x coordinate, relative to the screen, at the time the values were captured. |

### getViewY

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

```
public int getViewY(@Nullable TransitionValues values)
```

Returns the View's center y coordinate, relative to the screen, at the time the values were captured.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/transition/TransitionValues values` | The TransitionValues captured at the start or end of the Transition. |

| Returns |
|---|---|
| `int` | the View's center y coordinate, relative to the screen, at the time the values were captured. |