PDFKitの新機能

PDFKitの新機能

PDFKitはあなたのAppに、PDFドキュメントの表示・編集・保存の機能を提供するフル機能のフレームワークです。Live Textやフォームのサポート、画像からのPDF作成、インタラクティブオーバーレイの構築、注釈の保存など、PDFKitの最新機能を紹介します。

リソース
- PDFAnnotationWidgetsAdvanced
- - HDビデオ
  - SDビデオ
関連ビデオ

WWDC22
- WWDC22 Day 4 recap
WWDC19
- PencilKitの紹介
Conrad Carlenです PDFKitの新機能についてお話します議題はこちらまずPDFKitの簡単なおさらい次にLive Textとフォームなどの新機能画像からPDFを作成する新しい方法最後にオーバーレイビューについてまずPDFKitの機能を見直してみましょう PDFKitはAppのフレームワークで閲覧や編集を可能にします iOSやmacOS Mac Catalystで利用でき UIViewをAppに組み込むためのラッパーである UIViewRepresentableを使って SwiftUIで使用することも可能です PDFKitは機能のほとんどをカバーする４つのコアクラスで構成されます PDFViewはSwiftUIやIBを使ってレイアウトするウィジェットです PDFドキュメントのコンテンツを表示しズーム設定やテキストのコピーも可能
PDFDocumentはPDFファイルを表します通常サブクラス化しませんが必ず使うクラスで PDFオブジェクトグラフのルートまたはツリーの幹ですこれらのいずれかがツリーの作成に必須です
各ドキュメントには1つか複数の PDFPageオブジェクトを含みますコンテンツをレンダリングしそのページに固有のフォントや画像などのリソースを保存します
オブジェクトグラフの葉の部分には PDFAnnotationsのオプションもあります PDFPageは編集を目的としませんが注釈は多くの場合編集可能です各オブジェクトの役割も説明します PDFKitの基本について詳しく知るには下にリンクされている "Introducing PDFKit" のセッションをご覧ください
ではiOS16とVenturaで導入された新機能について
PDFKitはLive Textをサポートしますこれはタップしてコピーできるテキストが少量である写真Appとは異なります写真と違って PDFで文字が表示されればテキストとして扱えることが期待されます Live Textを使ってPDF文書内の文字列を選択し検索できるようになりましたこれはビットマップをスキャンしただけのものでテキストはまったくありません
もちろんPDFは多くのページを持てるので PDF文書を開いたときに全ページにOCRを適用するのではなく PDFKitは各ページを操作するときにオンデマンドで実行します OCRはそのファイルに適用されるので文書のコピーを作成する必要はありません文書全体のテキストを保存したい場合は保存時にそのオプションがあります
さらにPDFKitはフォーム処理を改善しましたフォームフィールドを含む文書はテキストフィールドが組み込まれていなくても自動的に認識されますテキストフィールドをタブで移動して期待通りにテキストを入力できます
次は画像からPDFを作成するための新APIについて説明します
iOS16とmacOS Venturaには画像を入力としてPDFを作成できる柔軟な新らしいAPIを用意しました AppはCGImageRefで画像を提供します PDFKitはCGImageRefを受け取り高品質のJPEGエンコーディングで圧縮します CGImageRefはCoreGraphicsのネイティブデータ型なので追加の変換は不要です
最も一般的なケースを処理するのに役立ついくつかのオプションがあります
MediaBoxでページの大きさを指定画像に合わせるか用紙サイズを選択できます
縦向きや横向きの指定もできます
画像がMediaBox より大きい場合 MediaBoxに収まるよう画像を縮小します UpscaleIfSmallerが指定されている場合画像がMediaBoxより小さい時はページ全体に拡大されます
多く寄せられた質問にお答えします「PencilKitでPDFに描画するには？」オーバーレイビューを使用します
以前はPDFPageをサブクラス化し描画メソッドをオーバーライドするかカスタムPDFアノテーションが必要でした iOS16とVenturaでは各PDFのページ上に独自のビューをオーバーレイできますこれでPDF上にインタラクティブなライブビューを作成できますオーバーレイについて知っておくべき３点はまず新プロトコルによりオーバーレイビューを PDFページにインストールします
コンテンツはPDFに組込んで保存します PDF文書を保存する際のベストプラクティスについて紹介します
オーバーレイビューのインストールは簡単です PDFは数百ページにもなる可能性もあるため開く時にすべてのページのビューを作成することはできませんユーザーが高速でスクロールした場合は？ビューをいつ作成するべきか知る方法は？
PDFKitはページをスクロールして表示する前にコンテンツをインテリジェントに準備するよう設計されていますオーバーレイビューを要求するタイミングも万全です Appは新しいプロトコルによるリクエストに応答する必要があるだけです
PDFPageOverlayViewProviderが新しいプロトコルです PDFKitPlatformViewはプラットフォームに応じて UIViewかNSViewとして定義されます最も重要なメソッドはoverlayViewForPageですビューのインスタンスを提供するだけで PDFKitは適切な制約を適用してそのサイズを調整しますまたページの回転がゼロ以外の場合は回転させます
次の２つのメソッドはオプションです willDisplayOverlayViewを使用して独自のジェスチャーハンドラをインストールしたり PDFKitのジェスチャーとの衝突を調整することができます
willEndDisplayingOverlayViewはPDFKitがあなたのビューを終了したときに呼び出されますおそらくスクロールアウトされたためですここでビューを解放することができますがこのメソッドにはもう一つ重要な使い方があります描画を表すデータがある場合はこのメソッドでデータを取得しておくこともできますここではPencilKitを使用していますがビューデータが別の場所にある場合はこれを実装する必要はありません
これがこの例でプロバイダとして使用しているクラスです PDFPageOverlayViewProviderプロトコルを実装していますこれはiOSなのでUIViewです PDFPage から UIView へは map を使用しますプロトコルメソッドの宣言はこうなります次に実装を見てみましょう overlayViewForPageはpageToViewMappingでビューが作成済かどうかを確認しますまだの場合は新しいビューを作成しますいずれの場合もページからdrawingを取得してキャンバスビューに設定しますここではPDFPageのサブクラスを使っています drawingプロパティを追加するだけです
次のメソッドを見てみましょう willEndDisplayingです
OverlayViewはシンプルですビューからdrawingを取得しカスタムページクラスに保存します実際の動作を見てみます
この時期にはいつも釣りをしますが今年はWWDCですので別の人が代わりに参加しているためお気に入りスポットを彼に紹介したいと思いますこのAppではPencilKitをオーバーレイ表示で使用します構成は今見たコード以外はごくわずかでオーバーレイを表示するためのコードは約30行ですグランドレイクはダム湖なんですがたくさん魚がいる穴場ですねここを下るとダム湖に行って釣りができますあるいこの道を進んでダムを越えてからここを通って釣りすることもできますそこからここでも釣れます一周してからの先には間違っても行かないように流れが急に深くなりますここは避けて養魚場へ養魚場の横を進んでこの水場に移るとあちこちでキャスティングできますここは穴場で私はいつもここで魚を釣っています
さてルートが書けたのでズームとスクロールを実行してみましょう
良いレスポンスですよね
以上になります PDFKitのオーバーレイビューでしたスケッチができたので次は保存についてですそれにはPDFAnnotationクラスを使用します保存するときに実現したいことは２つ画面上の表示を忠実に一致させることとラウンドトリップ編集です PDFアノテーションにはこれを容易にするいくつかの機能があり「アピアランスストリーム」と呼ばれる PDFの描画コマンドのストリームを持つことができます Quartz2Dで描画できるものはほぼすべてを記録できますそれ以外は画像にレンダリングして記録します Metalを使用している場合は画像で記録しています PDFの描画として記録されているため Adobe ReaderやChromeなどでも同じように表示されます
PDFの注釈はdictionaryとしてPDF文書に保存しますカスタムデータをプライベートキーと値のペアで保存することもできますどのようなコードになるのか見てみましょう PDFAnnotationのサブクラスの作成から始めます drawメソッドをオーバーライドする作業です PDFKitは前のスライドで説明したアピアランスストリームを保存するときにこのメソッドを呼び出します
ドキュメントを保存するためcontentsを上書きします関数の概要を次に示します PDFDocumentのすべてのページをループしますループの中の処理は...
各ページに対して次の作業を行いますカスタムクラスのアノテーションを作成し drawingをデータにエンコードしてデータをアノテーションに追加します次にこの文書を開くときに value:forAnnotationKey を使用して保存されたdrawingデータを読み出しそれをオーバーレイビューに配置します
最後にページに注釈を追加します contentsのオーバーライドに戻りますページに注釈を追加したので PDFDocumentのdataRepresentationで結果を返します
コンテンツが注釈として保存されるとコンテンツの移動やサイズ変更や削除も可能になります望まれる機能ですねページの一部として注釈を“焼き付け”たい場合 iOS16とmacOS Venturaにはこれを行うPDFDocumentWriteOptionが使えます保存オプションに burnInAnnotationsOption=trueを追加するだけです処理はこれだけです
PDF書き込みオプションと言えば iOS16とmacOSVenturaで利用できるようになったもを見ていくことにします CoreGraphicsは常に最高画質で画像をPDFに保存するため画像はロスレス圧縮でフル解像度です PDFが大判プリンターで印刷される場合に最高です画面に表示されることが多いPDFでは忠実度の高い画像データをすべて保存するとファイルサイズが非常に大きくなってしまいますこれに対処するために２つのオプションがあります
saveAllImagesAsJPEGはその名のとおり画像はすべてJPEGエンコーディングで PDFに保存します
optimizeImagesForScreenは画像をHiDPIスクリーンの解像度にダウンサンプリングしますこれら２つのオプションは同時に使用できます
createLinearizedPDFはインターネット用に最適化された特別な種類のPDFを作成しますインターネット登場前に設計されたPDF形式はファイルの最後から読み取られますつまり表示する前に全体をダウンロードする必要がありました線形化されたPDFにはファイルの先頭に最初のページの表示に必要なすべてが含まれておりブラウザーは残りの部分がロード中でも表示できるようになっています
これらのオプションはPDFDocument の dataRepresentation や writeToURL メソッドに渡すことも可能です以上になります PDFKitはパワフルで使いやすく iOSやmacOSの多くのAppで使われており iOS16とmacOSVenturaで新機能も追加されましたどんな風に使割れるか楽しみです
詳細については以下のセッションをご確認くださいご清聴ありがとうございます

6:54 - Implementing the overlay protocol

class Coordinator: NSObject, PDFPageOverlayViewProvider {

    var pageToViewMapping = [PDFPage: UIView]()
   
    func pdfView(_ view: PDFView, overlayViewFor page: PDFPage) -> UIView? {
        var resultView: PKCanvasView? = nil
        
        if let overlayView = pageToViewMapping[page] {
            resultView = overlayView
        } else {
            let canvasView = PKCanvasView(frame: .zero)
            canvasView.drawingPolicy = .anyInput
            canvasView.tool = PKInkingTool(.pen, color: .systemYellow, width: 20)
            canvasView.backgroundColor = UIColor.clear
            pageToViewMapping[page] = canvasView
            resultView = canvasView
        }
        
        // If we have stored a drawing on the page, set it on the canvas
        let page = page as! MyPDFPage
        if let drawing = page.drawing {
            resultView?.drawing = drawing;
        }
        return resultView
    }

    func pdfView(_ pdfView: PDFView, willEndDisplayingOverlayView
        overlayView: UIView, for page: PDFPage) {
        let overlayView = overlayView as! PKCanvasView
        let page = page as! MyPDFPage
        page.drawing = overlayView.drawing
        pageToViewMapping.removeValue(forKey: page)
    }
}

10:22 - Create a subclass of PDFAnnotation

// Implement a subclass with a drawing override

class MyPDFAnnotation: PDFAnnotation {
    
    override func draw(with box: PDFDisplayBox, in context: CGContext) {
        UIGraphicsPushContext(context)
        context.saveGState()
        
        let page = self.page as! MyPDFPage
        if let drawing = page.drawing {
            let image = drawing.image(from: drawing.bounds, scale: 1)
            image.draw(in: drawing.bounds)
        }
        
        context.restoreGState()
        UIGraphicsPopContext()
    }
}

10:35 - Add annotations to your document when saving

override func contents(forType typeName: String) throws -> Any {
        
    if let pdfDocument = pdfDocument {
      
        // Go through all pages in the document
        for i in 0...pdfDocument.pageCount-1 {
            if let page = pdfDocument.page(at: i) {                       
                if let drawing = (page as! MyPDFPage).drawing {
                        
                    // Create an annotation of our custom subclass
                    let newAnnotation = MyPDFAnnotation(bounds: drawing.bounds,
                                                        forType: .stamp, withProperties: nil)
                        
                    // Add our custom data
                    let codedData = try! NSKeyedArchiver.archivedData(withRootObject: drawing,
                                                                      requiringSecureCoding: true)
                    newAnnotation.setValue(codedData,
                                           forAnnotationKey: PDFAnnotationKey(rawValue: "drawingData"))
                        
                    // Add our annotation to the page
                    page.addAnnotation(newAnnotation)
                }
            }
        }

        // -- Option #1: Save the document to a data representation
        if let resultData = pdfDocument.dataRepresentation() {
            return resultData
        }
      
        // -- Option #2: Save the document to a data representation and "burn in" annotations
        let options = [PDFDocumentWriteOption.burnInAnnotationsOption: true]
        if let resultData = pdfDocument.dataRepresentation(options: options) {
            return resultData
        }
    }
                
    // Fall through to returning empty data
    return Data()
}

リソース

関連ビデオ

WWDC22

WWDC19