pdf-viewer/io.github.limuyang2.pdf.viewer/PdfViewState

PdfViewState

@Stable

class PdfViewState

Scroll, zoom, search, and render-cache state for PdfView.

Properties

currentPage

val currentPage: Int

Zero-based index of the first visible page.

horizontalScrollState

val horizontalScrollState: ScrollState

Horizontal scroll state used when a zoomed page is wider than the viewport.

listState

val listState: LazyListState

Vertical lazy-list state backing the page list.

searchResults

var searchResults: List<PdfViewSearchResult>

Search results ordered by page and match position.

searchStatus

var searchStatus: PdfViewSearchStatus

Lifecycle state of the active document search.

selectedSearchResult

val selectedSearchResult: PdfViewSearchResult?

Currently selected result, or null when the result list is empty.

selectedSearchResultIndex

var selectedSearchResultIndex: Int

Index of the selected result, or -1 when there is no result.

zoom

var zoom: Float

Current visual zoom multiplier, clamped to the configured range.

Functions

animateScrollToPage

suspend fun animateScrollToPage(pageIndex: Int, scrollOffset: Int = 0)

Smoothly places pageIndex at the requested list offset.

animateScrollToSearchResult

suspend fun animateScrollToSearchResult(result: PdfViewSearchResult, alignment: PdfSearchScrollAlignment = PdfSearchScrollAlignment.Default)

Smoothly scrolls result to its position inside the PDF page.

clearRenderCache

fun clearRenderCache()

Releases all cached page images without changing scroll or zoom.

clearSearch

fun clearSearch()

Cancels the active search state and removes every highlight.

scrollToPage

suspend fun scrollToPage(pageIndex: Int, scrollOffset: Int = 0)

Immediately places pageIndex at the requested list offset.

scrollToSearchResult

suspend fun scrollToSearchResult(result: PdfViewSearchResult, alignment: PdfSearchScrollAlignment = PdfSearchScrollAlignment.Default)

Immediately scrolls result to its position inside the PDF page.

suspend fun search(document: PdfDocument, query: String, options: PdfSearchOptions = PdfSearchOptions())

Searches every page in document.

selectNextSearchResult

fun selectNextSearchResult(wrapAround: Boolean = true): PdfViewSearchResult?

Selects the next result, optionally wrapping to the first result.

selectPreviousSearchResult

fun selectPreviousSearchResult(wrapAround: Boolean = true): PdfViewSearchResult?

Selects the previous result, optionally wrapping to the last result.

selectSearchResult

fun selectSearchResult(index: Int): PdfViewSearchResult

Selects and returns the result at index without scrolling.

updateZoom

fun updateZoom(zoom: Float)

Sets an absolute zoom value within the supported range.

zoomBy

fun zoomBy(factor: Float)

Multiplies the current zoom by a positive factor.