# PdfZoomScrollScope

Artifact: [androidx.pdf:pdf-compose](https://developer.android.com/jetpack/androidx/releases/pdf) [View Source](https://cs.android.com/search?q=file:androidx/pdf/compose/PdfViewerState.kt+class:androidx.pdf.compose.PdfZoomScrollScope) Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)


```
interface PdfZoomScrollScope
```

<br />

*** ** * ** ***

Scope used for suspending scroll blocks

## Summary

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset` | `https://developer.android.com/reference/kotlin/androidx/pdf/compose/PdfZoomScrollScope#scrollBy(androidx.compose.ui.geometry.Offset)(delta: https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset)` Attempts to scroll forward by `https://developer.android.com/reference/kotlin/androidx/pdf/compose/PdfZoomScrollScope#scrollBy(androidx.compose.ui.geometry.Offset)` px. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/compose/PdfZoomScrollScope#zoomTo(kotlin.Float)(zoomLevel: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)` Instantly sets the zoom level to `https://developer.android.com/reference/kotlin/androidx/pdf/compose/PdfZoomScrollScope#zoomTo(kotlin.Float)` |

## Public functions

### scrollBy

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

```
fun scrollBy(delta: Offset): Offset
```

Attempts to scroll forward by `https://developer.android.com/reference/kotlin/androidx/pdf/compose/PdfZoomScrollScope#scrollBy(androidx.compose.ui.geometry.Offset)` px.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset` | the amount of requested scroll that was consumed (i.e. how far it scrolled) |

### zoomTo

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

```
fun zoomTo(zoomLevel: Float): Unit
```

Instantly sets the zoom level to `https://developer.android.com/reference/kotlin/androidx/pdf/compose/PdfZoomScrollScope#zoomTo(kotlin.Float)`