One Logo Pool Ball
PaperKit · IOS API REFERENCE

PaperMarkupViewController.ScrollConfiguration

class · iOS 27.0+ · SDK 27.1

final class ScrollConfiguration

A cross-platform type that provides access to scroll view functionality.

Members (25)

get · iOS 27.0+

horizontalScrollIndicatorInsets

TypeScript
get horizontalScrollIndicatorInsets(): Promise<{ top: number; left: number; bottom: number; right: number }>
Swift declaration
final var horizontalScrollIndicatorInsets: UIEdgeInsets { get set }

The horizontal scroll indicator's insets. Default is `.zero`.

set · iOS 27.0+

horizontalScrollIndicatorInsets

TypeScript
setHorizontalScrollIndicatorInsets(value: { top: number; left: number; bottom: number; right: number }): Promise<void>
Swift declaration
final var horizontalScrollIndicatorInsets: UIEdgeInsets { get set }

The horizontal scroll indicator's insets. Default is `.zero`.

get · iOS 27.0+

isScrollEnabled

TypeScript
get isScrollEnabled(): Promise<boolean>
Swift declaration
final var isScrollEnabled: Bool { get set }

A Boolean value that determines whether scrolling is enabled. When `false`, the scroll view disables dragging temporarily. Default is `true`.

set · iOS 27.0+

isScrollEnabled

TypeScript
setIsScrollEnabled(value: boolean): Promise<void>
Swift declaration
final var isScrollEnabled: Bool { get set }

A Boolean value that determines whether scrolling is enabled. When `false`, the scroll view disables dragging temporarily. Default is `true`.

get · iOS 27.0+

visibleScrollIndicators

TypeScript
get visibleScrollIndicators(): Promise<PaperMarkupViewController_ScrollConfiguration_Axis>
Swift declaration
final var visibleScrollIndicators: PaperMarkupViewController.ScrollConfiguration.Axis { get set }

The axes for which scroll indicators are visible. Scroll indicators appear while tracking and fade out after tracking. Default is `[.vertical, .horizontal]`.

set · iOS 27.0+

visibleScrollIndicators

TypeScript
setVisibleScrollIndicators(value: PaperMarkupViewController_ScrollConfiguration_Axis): Promise<void>
Swift declaration
final var visibleScrollIndicators: PaperMarkupViewController.ScrollConfiguration.Axis { get set }

The axes for which scroll indicators are visible. Scroll indicators appear while tracking and fade out after tracking. Default is `[.vertical, .horizontal]`.

get · iOS 27.0+

verticalScrollIndicatorInsets

TypeScript
get verticalScrollIndicatorInsets(): Promise<{ top: number; left: number; bottom: number; right: number }>
Swift declaration
final var verticalScrollIndicatorInsets: UIEdgeInsets { get set }

The vertical scroll indicator's insets. Default is `.zero`.

set · iOS 27.0+

verticalScrollIndicatorInsets

TypeScript
setVerticalScrollIndicatorInsets(value: { top: number; left: number; bottom: number; right: number }): Promise<void>
Swift declaration
final var verticalScrollIndicatorInsets: UIEdgeInsets { get set }

The vertical scroll indicator's insets. Default is `.zero`.

get · iOS 27.0+

bouncesZoom

TypeScript
get bouncesZoom(): Promise<boolean>
Swift declaration
final var bouncesZoom: Bool { get set }

A Boolean value that controls whether the scroll view animates the content scaling when the scaling exceeds the maximum or minimum limits. When enabled, a person can zoom past the minimum or maximum scale while gesturing, and the scale animates to the minimum or maximum value when the gesture ends. Default is `true`.

set · iOS 27.0+

bouncesZoom

TypeScript
setBouncesZoom(value: boolean): Promise<void>
Swift declaration
final var bouncesZoom: Bool { get set }

A Boolean value that controls whether the scroll view animates the content scaling when the scaling exceeds the maximum or minimum limits. When enabled, a person can zoom past the minimum or maximum scale while gesturing, and the scale animates to the minimum or maximum value when the gesture ends. Default is `true`.

get · iOS 27.0+

contentInset

TypeScript
get contentInset(): Promise<{ top: number; left: number; bottom: number; right: number }>
Swift declaration
final var contentInset: UIEdgeInsets { get set }

The custom distance to inset the content view from the safe area or scroll view edges. Use this property to add additional scroll area around content. Default is `.zero`.

set · iOS 27.0+

contentInset

TypeScript
setContentInset(value: { top: number; left: number; bottom: number; right: number }): Promise<void>
Swift declaration
final var contentInset: UIEdgeInsets { get set }

The custom distance to inset the content view from the safe area or scroll view edges. Use this property to add additional scroll area around content. Default is `.zero`.

get · iOS 27.0+

scrollsToTop

TypeScript
get scrollsToTop(): Promise<boolean>
Swift declaration
final var scrollsToTop: Bool { get set }

A Boolean value that controls whether the scroll-to-top gesture is enabled. When a person taps the status bar, the scroll view closest to the status bar scrolls to the top, but only if its `scrollsToTop` property is `true`, its delegate does not return `false` from `scrollViewShouldScrollToTop:`, and it is not already at the top. On iPhone, this gesture works only if one on-screen scroll view has `scrollsToTop == true`. If more than one exists, none scroll to the top. Default is `true`.

set · iOS 27.0+

scrollsToTop

TypeScript
setScrollsToTop(value: boolean): Promise<void>
Swift declaration
final var scrollsToTop: Bool { get set }

A Boolean value that controls whether the scroll-to-top gesture is enabled. When a person taps the status bar, the scroll view closest to the status bar scrolls to the top, but only if its `scrollsToTop` property is `true`, its delegate does not return `false` from `scrollViewShouldScrollToTop:`, and it is not already at the top. On iPhone, this gesture works only if one on-screen scroll view has `scrollsToTop == true`. If more than one exists, none scroll to the top. Default is `true`.

get · iOS 27.0+

alwaysBounces

TypeScript
get alwaysBounces(): Promise<PaperMarkupViewController_ScrollConfiguration_Axis>
Swift declaration
final var alwaysBounces: PaperMarkupViewController.ScrollConfiguration.Axis { get set }

The axes for which bouncing always occurs when scrolling reaches the end of the content. If an axis is included and `bounces` includes that axis, bouncing occurs even if content is smaller than bounds for that axis. Default is `[]`.

set · iOS 27.0+

alwaysBounces

TypeScript
setAlwaysBounces(value: PaperMarkupViewController_ScrollConfiguration_Axis): Promise<void>
Swift declaration
final var alwaysBounces: PaperMarkupViewController.ScrollConfiguration.Axis { get set }

The axes for which bouncing always occurs when scrolling reaches the end of the content. If an axis is included and `bounces` includes that axis, bouncing occurs even if content is smaller than bounds for that axis. Default is `[]`.

get · iOS 27.0+

adjustedContentInset

TypeScript
get adjustedContentInset(): Promise<{ top: number; left: number; bottom: number; right: number }>
Swift declaration
final var adjustedContentInset: UIEdgeInsets { get }

The insets that the system derives from the content insets and safe area insets. When `contentInsetAdjustmentBehavior` allows, the scroll view may incorporate its safe area insets into the adjusted content inset.

get · iOS 27.0+

isDirectionalLockEnabled

TypeScript
get isDirectionalLockEnabled(): Promise<boolean>
Swift declaration
final var isDirectionalLockEnabled: Bool { get set }

A Boolean value that determines whether scrolling is disabled in a particular direction. When `true`, the scroll view tries to lock scrolling to the vertical or horizontal direction while dragging. Default is `false`.

set · iOS 27.0+

isDirectionalLockEnabled

TypeScript
setIsDirectionalLockEnabled(value: boolean): Promise<void>
Swift declaration
final var isDirectionalLockEnabled: Bool { get set }

A Boolean value that determines whether scrolling is disabled in a particular direction. When `true`, the scroll view tries to lock scrolling to the vertical or horizontal direction while dragging. Default is `false`.

get · iOS 27.0+

contentInsetAdjustmentBehavior

TypeScript
get contentInsetAdjustmentBehavior(): Promise<_UIKit_UIScrollView_ContentInsetAdjustmentBehavior>
Swift declaration
final var contentInsetAdjustmentBehavior: UIScrollView.ContentInsetAdjustmentBehavior { get set }

The behavior for determining the adjusted content inset. Default is `.automatic`.

set · iOS 27.0+

contentInsetAdjustmentBehavior

TypeScript
setContentInsetAdjustmentBehavior(value: _UIKit_UIScrollView_ContentInsetAdjustmentBehavior): Promise<void>
Swift declaration
final var contentInsetAdjustmentBehavior: UIScrollView.ContentInsetAdjustmentBehavior { get set }

The behavior for determining the adjusted content inset. Default is `.automatic`.

get · iOS 27.0+

bounces

TypeScript
get bounces(): Promise<PaperMarkupViewController_ScrollConfiguration_Axis>
Swift declaration
final var bounces: PaperMarkupViewController.ScrollConfiguration.Axis { get set }

The axes for which the scroll view bounces past the edge of content and back again. Default is `[.vertical, .horizontal]`.

set · iOS 27.0+

bounces

TypeScript
setBounces(value: PaperMarkupViewController_ScrollConfiguration_Axis): Promise<void>
Swift declaration
final var bounces: PaperMarkupViewController.ScrollConfiguration.Axis { get set }

The axes for which the scroll view bounces past the edge of content and back again. Default is `[.vertical, .horizontal]`.

get · iOS 27.0+

zoomScale

TypeScript
get zoomScale(): Promise<number>
Swift declaration
final var zoomScale: CGFloat { get set }

The current scale factor applied to the scroll view's content. Default is `1.0`.

set · iOS 27.0+

zoomScale

TypeScript
setZoomScale(value: number): Promise<void>
Swift declaration
final var zoomScale: CGFloat { get set }

The current scale factor applied to the scroll view's content. Default is `1.0`.

Skipped declarations

No declarations were skipped in this snapshot.

All PaperKit types →