pspdfkit/com.pspdfkit.configuration.compose/SdkConfiguration

SdkConfiguration

data class SdkConfiguration(val scrollDirection: PageScrollDirection? = PageScrollDirection.HORIZONTAL, val thumbnailGridEnabled: Boolean = false, val thumbnailBarMode: ThumbnailBarMode? = ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING, val immersiveMode: Boolean = true, val selectedIndex: Int = 0, val pageFitMode: PageFitMode = PageFitMode.FIT_TO_SCREEN, val pageScrollMode: PageScrollMode = PageScrollMode.PER_PAGE, @FloatRange(from = 1.0, to = 15.0) val startZoom: Float = 1.0f, val pageZoom: PageZoom = PageZoom(), val scrollbarConfiguration: ScrollbarConfiguration = ScrollbarConfiguration())

Stores the configuration for the SDK.

Constructors

SdkConfiguration

constructor(scrollDirection: PageScrollDirection? = PageScrollDirection.HORIZONTAL, thumbnailGridEnabled: Boolean = false, thumbnailBarMode: ThumbnailBarMode? = ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING, immersiveMode: Boolean = true, selectedIndex: Int = 0, pageFitMode: PageFitMode = PageFitMode.FIT_TO_SCREEN, pageScrollMode: PageScrollMode = PageScrollMode.PER_PAGE, @FloatRange(from = 1.0, to = 15.0) startZoom: Float = 1.0f, pageZoom: PageZoom = PageZoom(), scrollbarConfiguration: ScrollbarConfiguration = ScrollbarConfiguration())

Properties

immersiveMode

val immersiveMode: Boolean = true

Whether the immersive mode is enabled.

pageFitMode

val pageFitMode: PageFitMode

How the page should fit the screen.

pageScrollMode

val pageScrollMode: PageScrollMode

Page scrolling mode (Per page or continuous).

pageZoom

val pageZoom: PageZoom

Zoom level of the selected page. with this user can update the zoom level of any page on real time. Acts as a public api to update zoom per page on real time basis. (Only works with PageScrollMode.PER_PAGE)

scrollbarConfiguration

val scrollbarConfiguration: ScrollbarConfiguration

scrollbar configuration

scrollDirection

val scrollDirection: PageScrollDirection?

Direction of the page scroll action.

selectedIndex

val selectedIndex: Int = 0

Index of the first selected page.

startZoom

val startZoom: Float = 1.0f

Initial zoom level for the document.