IOSViewConfiguration class

iOS-specific viewer configuration options.

Use this class for options that only apply to the iOS platform. Pass an instance as NutrientViewConfiguration.iosConfig.

All fields are optional. Unset fields (null) use the Nutrient iOS SDK's built-in defaults.

Example

NutrientViewConfiguration(
  iosConfig: IOSViewConfiguration(
    spreadFitting: SpreadFitting.adaptive,
    showPageLabels: true,
    inlineSearch: true,
    bookmarkIndicatorMode: IOSBookmarkIndicatorMode.onWhenBookmarked,
    leftBarButtonItems: ['closeButtonItem'],
    rightBarButtonItems: ['annotationButtonItem', 'searchButtonItem'],
  ),
)

Platform availability

All fields on this class are iOS-only. On Android and Web they are silently ignored.

Constructors

IOSViewConfiguration({SpreadFitting? spreadFitting, ThumbnailBarMode? thumbnailBarMode, bool? showPageLabels, bool? documentLabelEnabled, bool? inlineSearch, bool? showActionNavigationButtons, bool? allowToolbarTitleChange, IOSBookmarkIndicatorMode? bookmarkIndicatorMode, bool? bookmarkIndicatorInteractionEnabled, List<String>? leftBarButtonItems, List<String>? rightBarButtonItems, IOSFileConflictResolution? fileConflictResolution}): Creates an IOSViewConfiguration.
const

Properties

allowToolbarTitleChange → bool?: Whether the navigation bar title updates as the user scrolls the document.
final
bookmarkIndicatorInteractionEnabled → bool?: Whether tapping the bookmark indicator toggles the bookmark on the page.
final
bookmarkIndicatorMode → IOSBookmarkIndicatorMode?: Controls when the per-page bookmark indicator is displayed.
final
documentLabelEnabled → bool?: Show the document title overlay at the top of the viewer.
final
fileConflictResolution → IOSFileConflictResolution?: How to resolve a file conflict when the underlying PDF file is modified or deleted by another process while it is open in the viewer.
final
hashCode → int: The hash code for this object.
no setterinherited
inlineSearch → bool?: Use inline search instead of a separate search panel.
final
leftBarButtonItems → List<String>?: Custom bar button items for the left side of the navigation bar.
final
rightBarButtonItems → List<String>?: Custom bar button items for the right side of the navigation bar.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
showActionNavigationButtons → bool?: Show back/forward page-navigation buttons in the navigation bar.
final
showPageLabels → bool?: Show page labels instead of page numbers.
final
spreadFitting → SpreadFitting?: How a page spread is fitted into the available viewport.
final
thumbnailBarMode → ThumbnailBarMode?: Where and how the thumbnail bar is displayed.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited