PDFKit · IOS API REFERENCE

PDFView

class · iOS 11.0+ · SDK 27.1

class PDFView

Members (91)

method · iOS 11.0+

annotationsChanged

TypeScript

annotationsChanged(page: PDFPage): Promise<void>

Swift declaration

func annotationsChanged(on page: PDFPage)

method · iOS 11.0+

areaOfInterest

TypeScript

areaOfInterestForMouse(event: _UIKit_UIEvent): Promise<PDFAreaOfInterest>

Swift declaration

func areaOfInterest(forMouse event: UIEvent) -> PDFAreaOfInterest

method · iOS 11.0+

areaOfInterest

TypeScript

areaOfInterestFor(cursorLocation: { x: number; y: number }): Promise<PDFAreaOfInterest>

Swift declaration

func areaOfInterest(for cursorLocation: CGPoint) -> PDFAreaOfInterest

method · iOS 11.0+

clearSelection

TypeScript

clearSelection(): Promise<void>

Swift declaration

func clearSelection()

method · iOS 11.0+

convert

TypeScript

convertFrom(point: { x: number; y: number }, page: PDFPage): Promise<{ x: number; y: number }>

Swift declaration

func convert(_ point: CGPoint, from page: PDFPage) -> CGPoint

method · iOS 11.0+

convert

TypeScript

convertTo(point: { x: number; y: number }, page: PDFPage): Promise<{ x: number; y: number }>

Swift declaration

func convert(_ point: CGPoint, to page: PDFPage) -> CGPoint

method · iOS 11.0+

convert

TypeScript

convertFrom86829(rect: { x: number; y: number; width: number; height: number }, page: PDFPage): Promise<{ x: number; y: number; width: number; height: number }>

Swift declaration

func convert(_ rect: CGRect, from page: PDFPage) -> CGRect

method · iOS 11.0+

convert

TypeScript

convertTo23162(rect: { x: number; y: number; width: number; height: number }, page: PDFPage): Promise<{ x: number; y: number; width: number; height: number }>

Swift declaration

func convert(_ rect: CGRect, to page: PDFPage) -> CGRect

method · iOS 11.0+

copy

TypeScript

copy(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func copy(_ sender: Any?)

method · iOS 11.0+

draw

TypeScript

draw(page: PDFPage, context: _CoreGraphics_CGContext): Promise<void>

Swift declaration

func draw(_ page: PDFPage, to context: CGContext)

method · iOS 11.0+

drawPagePost

TypeScript

drawPagePost(page: PDFPage, context: _CoreGraphics_CGContext): Promise<void>

Swift declaration

func drawPagePost(_ page: PDFPage, to context: CGContext)

method · iOS 11.0+

goBack

TypeScript

goBack(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func goBack(_ sender: Any?)

method · iOS 11.0+

goForward

TypeScript

goForward(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func goForward(_ sender: Any?)

method · iOS 11.0+

go

TypeScript

goTo(destination: PDFDestination): Promise<void>

Swift declaration

func go(to destination: PDFDestination)

method · iOS 11.0+

goToFirstPage

TypeScript

goToFirstPage(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func goToFirstPage(_ sender: Any?)

method · iOS 11.0+

goToLastPage

TypeScript

goToLastPage(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func goToLastPage(_ sender: Any?)

method · iOS 11.0+

goToNextPage

TypeScript

goToNextPage(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func goToNextPage(_ sender: Any?)

method · iOS 11.0+

go

TypeScript

goTo50003(page: PDFPage): Promise<void>

Swift declaration

func go(to page: PDFPage)

method · iOS 11.0+

goToPreviousPage

TypeScript

goToPreviousPage(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func goToPreviousPage(_ sender: Any?)

method · iOS 11.0+

go

TypeScript

goToOn(rect: { x: number; y: number; width: number; height: number }, page: PDFPage): Promise<void>

Swift declaration

func go(to rect: CGRect, on page: PDFPage)

method · iOS 11.0+

go

TypeScript

goTo16108(selection: PDFSelection): Promise<void>

Swift declaration

func go(to selection: PDFSelection)

init

TypeScript

static init(): Promise<PDFView>

Swift declaration

init()

method · iOS 11.0+

layoutDocumentView

TypeScript

layoutDocumentView(): Promise<void>

Swift declaration

func layoutDocumentView()

method · iOS 11.0+

page

TypeScript

page(point: { x: number; y: number }, nearest: boolean): Promise<(PDFPage) | null>

Swift declaration

func page(for point: CGPoint, nearest: Bool) -> PDFPage?

method · iOS 11.0+

perform

TypeScript

perform(action: PDFAction): Promise<void>

Swift declaration

func perform(_ action: PDFAction)

method · iOS 11.0+

rowSize

TypeScript

rowSize(page: PDFPage): Promise<{ width: number; height: number }>

Swift declaration

func rowSize(for page: PDFPage) -> CGSize

method · iOS 11.0+

scrollSelectionToVisible

TypeScript

scrollSelectionToVisible(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func scrollSelectionToVisible(_ sender: Any?)

method · iOS 11.0+

selectAll

TypeScript

selectAll(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func selectAll(_ sender: Any?)

method · iOS 11.0+

setCurrentSelection

TypeScript

setCurrentSelection(selection: (PDFSelection) | null, animate: boolean): Promise<void>

Swift declaration

func setCurrentSelection(_ selection: PDFSelection?, animate: Bool)

method · iOS 11.0+

usePageViewController

TypeScript

usePageViewController(enable: boolean, viewOptions?: (NativeMap<unknown, unknown>) | null): Promise<void>

Swift declaration

func usePageViewController(_ enable: Bool, withViewOptions viewOptions: [AnyHashable : Any]? = nil)

method · iOS 11.0+

zoomIn

TypeScript

zoomIn(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func zoomIn(_ sender: Any?)

method · iOS 11.0+

zoomOut

TypeScript

zoomOut(sender?: (unknown) | null): Promise<void>

Swift declaration

@IBAction func zoomOut(_ sender: Any?)

get · iOS 11.0+

autoScales

TypeScript

get autoScales(): Promise<boolean>

Swift declaration

var autoScales: Bool { get set }

set · iOS 11.0+

autoScales

TypeScript

setAutoScales(value: boolean): Promise<void>

Swift declaration

var autoScales: Bool { get set }

get · iOS 11.0+

backgroundColor

TypeScript

get backgroundColor(): Promise<_UIKit_UIColor>

Swift declaration

var backgroundColor: UIColor { get set }

set · iOS 11.0+

backgroundColor

TypeScript

setBackgroundColor(value: _UIKit_UIColor): Promise<void>

Swift declaration

var backgroundColor: UIColor { get set }

get · iOS 11.0+

canGoBack

TypeScript

get canGoBack(): Promise<boolean>

Swift declaration

var canGoBack: Bool { get }

get · iOS 11.0+

canGoForward

TypeScript

get canGoForward(): Promise<boolean>

Swift declaration

var canGoForward: Bool { get }

get · iOS 11.0+

canGoToFirstPage

TypeScript

get canGoToFirstPage(): Promise<boolean>

Swift declaration

var canGoToFirstPage: Bool { get }

get · iOS 11.0+

canGoToLastPage

TypeScript

get canGoToLastPage(): Promise<boolean>

Swift declaration

var canGoToLastPage: Bool { get }

get · iOS 11.0+

canGoToNextPage

TypeScript

get canGoToNextPage(): Promise<boolean>

Swift declaration

var canGoToNextPage: Bool { get }

get · iOS 11.0+

canGoToPreviousPage

TypeScript

get canGoToPreviousPage(): Promise<boolean>

Swift declaration

var canGoToPreviousPage: Bool { get }

get · iOS 11.0+

canZoomIn

TypeScript

get canZoomIn(): Promise<boolean>

Swift declaration

var canZoomIn: Bool { get }

get · iOS 11.0+

canZoomOut

TypeScript

get canZoomOut(): Promise<boolean>

Swift declaration

var canZoomOut: Bool { get }

get · iOS 11.0+

currentDestination

TypeScript

get currentDestination(): Promise<(PDFDestination) | null>

Swift declaration

var currentDestination: PDFDestination? { get }

get · iOS 11.0+

currentPage

TypeScript

get currentPage(): Promise<(PDFPage) | null>

Swift declaration

var currentPage: PDFPage? { get }

get · iOS 11.0+

currentSelection

TypeScript

get currentSelection(): Promise<(PDFSelection) | null>

Swift declaration

var currentSelection: PDFSelection? { get set }

set · iOS 11.0+

currentSelection

TypeScript

setCurrentSelection69773(value?: (PDFSelection) | null): Promise<void>

Swift declaration

var currentSelection: PDFSelection? { get set }

get · iOS 11.0+

delegate

TypeScript

get delegate(): Promise<(SDKHandle) | null>

Swift declaration

weak var delegate: (any PDFViewDelegate)? { get set }

set · iOS 11.0+

delegate

TypeScript

setDelegate(value?: (Implements<PDFViewDelegate> | SDKHandle) | null): Promise<void>

Swift declaration

weak var delegate: (any PDFViewDelegate)? { get set }

get · iOS 11.0+

displayBox

TypeScript

get displayBox(): Promise<PDFDisplayBox>

Swift declaration

var displayBox: PDFDisplayBox { get set }

set · iOS 11.0+

displayBox

TypeScript

setDisplayBox(value: PDFDisplayBox): Promise<void>

Swift declaration

var displayBox: PDFDisplayBox { get set }

get · iOS 11.0+

displayDirection

TypeScript

get displayDirection(): Promise<PDFDisplayDirection>

Swift declaration

var displayDirection: PDFDisplayDirection { get set }

set · iOS 11.0+

displayDirection

TypeScript

setDisplayDirection(value: PDFDisplayDirection): Promise<void>

Swift declaration

var displayDirection: PDFDisplayDirection { get set }

get · iOS 11.0+

displayMode

TypeScript

get displayMode(): Promise<PDFDisplayMode>

Swift declaration

var displayMode: PDFDisplayMode { get set }

set · iOS 11.0+

displayMode

TypeScript

setDisplayMode(value: PDFDisplayMode): Promise<void>

Swift declaration

var displayMode: PDFDisplayMode { get set }

get · iOS 11.0+

displaysAsBook

TypeScript

get displaysAsBook(): Promise<boolean>

Swift declaration

var displaysAsBook: Bool { get set }

set · iOS 11.0+

displaysAsBook

TypeScript

setDisplaysAsBook(value: boolean): Promise<void>

Swift declaration

var displaysAsBook: Bool { get set }

get · iOS 11.0+

displaysPageBreaks

TypeScript

get displaysPageBreaks(): Promise<boolean>

Swift declaration

var displaysPageBreaks: Bool { get set }

set · iOS 11.0+

displaysPageBreaks

TypeScript

setDisplaysPageBreaks(value: boolean): Promise<void>

Swift declaration

var displaysPageBreaks: Bool { get set }

get · iOS 11.0+

displaysRTL

TypeScript

get displaysRTL(): Promise<boolean>

Swift declaration

var displaysRTL: Bool { get set }

set · iOS 11.0+

displaysRTL

TypeScript

setDisplaysRTL(value: boolean): Promise<void>

Swift declaration

var displaysRTL: Bool { get set }

get · iOS 11.0+

document

TypeScript

get document(): Promise<(PDFDocument) | null>

Swift declaration

var document: PDFDocument? { get set }

set · iOS 11.0+

document

TypeScript

setDocument(value?: (PDFDocument) | null): Promise<void>

Swift declaration

var document: PDFDocument? { get set }

get · iOS 11.0+

documentView

TypeScript

get documentView(): Promise<(_UIKit_UIView) | null>

Swift declaration

var documentView: UIView? { get }

get · iOS 11.0+ · Deprecated in iOS 18.0

enableDataDetectors

TypeScript

get enableDataDetectors(): Promise<boolean>

Swift declaration

var enableDataDetectors: Bool { get set }

set · iOS 11.0+ · Deprecated in iOS 18.0

enableDataDetectors

TypeScript

setEnableDataDetectors(value: boolean): Promise<void>

Swift declaration

var enableDataDetectors: Bool { get set }

get · iOS 16.0+

findInteraction

TypeScript

get findInteraction(): Promise<_UIKit_UIFindInteraction>

Swift declaration

var findInteraction: UIFindInteraction { get }

get · iOS 16.0+

isFindInteractionEnabled

TypeScript

get isFindInteractionEnabled(): Promise<boolean>

Swift declaration

var isFindInteractionEnabled: Bool { get set }

set · iOS 16.0+

isFindInteractionEnabled

TypeScript

setIsFindInteractionEnabled(value: boolean): Promise<void>

Swift declaration

var isFindInteractionEnabled: Bool { get set }

get · iOS 11.0+

highlightedSelections

TypeScript

get highlightedSelections(): Promise<(Array<PDFSelection>) | null>

Swift declaration

var highlightedSelections: [PDFSelection]? { get set }

set · iOS 11.0+

highlightedSelections

TypeScript

setHighlightedSelections(value?: (Array<PDFSelection>) | null): Promise<void>

Swift declaration

var highlightedSelections: [PDFSelection]? { get set }

get · iOS 16.0+

isInMarkupMode

TypeScript

get isInMarkupMode(): Promise<boolean>

Swift declaration

var isInMarkupMode: Bool { get set }

set · iOS 16.0+

isInMarkupMode

TypeScript

setIsInMarkupMode(value: boolean): Promise<void>

Swift declaration

var isInMarkupMode: Bool { get set }

get · iOS 11.0+

interpolationQuality

TypeScript

get interpolationQuality(): Promise<PDFInterpolationQuality>

Swift declaration

var interpolationQuality: PDFInterpolationQuality { get set }

set · iOS 11.0+

interpolationQuality

TypeScript

setInterpolationQuality(value: PDFInterpolationQuality): Promise<void>

Swift declaration

var interpolationQuality: PDFInterpolationQuality { get set }

get · iOS 11.0+

isUsingPageViewController

TypeScript

get isUsingPageViewController(): Promise<boolean>

Swift declaration

var isUsingPageViewController: Bool { get }

get · iOS 11.0+

maxScaleFactor

TypeScript

get maxScaleFactor(): Promise<number>

Swift declaration

var maxScaleFactor: CGFloat { get set }

set · iOS 11.0+

maxScaleFactor

TypeScript

setMaxScaleFactor(value: number): Promise<void>

Swift declaration

var maxScaleFactor: CGFloat { get set }

get · iOS 11.0+

minScaleFactor

TypeScript

get minScaleFactor(): Promise<number>

Swift declaration

var minScaleFactor: CGFloat { get set }

set · iOS 11.0+

minScaleFactor

TypeScript

setMinScaleFactor(value: number): Promise<void>

Swift declaration

var minScaleFactor: CGFloat { get set }

get · iOS 11.0+

pageBreakMargins

TypeScript

get pageBreakMargins(): Promise<{ top: number; left: number; bottom: number; right: number }>

Swift declaration

var pageBreakMargins: UIEdgeInsets { get set }

set · iOS 11.0+

pageBreakMargins

TypeScript

setPageBreakMargins(value: { top: number; left: number; bottom: number; right: number }): Promise<void>

Swift declaration

var pageBreakMargins: UIEdgeInsets { get set }

get · iOS 16.0+

pageOverlayViewProvider

TypeScript

get pageOverlayViewProvider(): Promise<(SDKHandle) | null>

Swift declaration

weak var pageOverlayViewProvider: (any PDFPageOverlayViewProvider)? { get set }

set · iOS 16.0+

pageOverlayViewProvider

TypeScript

setPageOverlayViewProvider(value?: (SDKHandle) | null): Promise<void>

Swift declaration

weak var pageOverlayViewProvider: (any PDFPageOverlayViewProvider)? { get set }

get · iOS 12.0+

pageShadowsEnabled

TypeScript

get pageShadowsEnabled(): Promise<boolean>

Swift declaration

var pageShadowsEnabled: Bool { get set }

set · iOS 12.0+

pageShadowsEnabled

TypeScript

setPageShadowsEnabled(value: boolean): Promise<void>

Swift declaration

var pageShadowsEnabled: Bool { get set }

get · iOS 11.0+

scaleFactor

TypeScript

get scaleFactor(): Promise<number>

Swift declaration

var scaleFactor: CGFloat { get set }

set · iOS 11.0+

scaleFactor

TypeScript

setScaleFactor(value: number): Promise<void>

Swift declaration

var scaleFactor: CGFloat { get set }

get · iOS 11.0+

scaleFactorForSizeToFit

TypeScript

get scaleFactorForSizeToFit(): Promise<number>

Swift declaration

var scaleFactorForSizeToFit: CGFloat { get }

get · iOS 11.0+

visiblePages

TypeScript

get visiblePages(): Promise<Array<PDFPage>>

Swift declaration

var visiblePages: [PDFPage] { get }

Skipped declarations

No declarations were skipped in this snapshot.

All PDFKit types →