Show or Hide PDF Annotations using Swift for iOS

1
//
2
//  Copyright © 2020-2025 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
class ToggleAnnotationVisibilityExample: Example {
12

13
    override init() {
14
        super.init()
15
        title = "Toggle Annotation Visibility"
16
        contentDescription = "Allow users to hide or show annotations."
17
        category = .annotations
18
        priority = 10
19
    }
20

21
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
22
        let document = AssetLoader.writableDocument(for: .welcome, overrideIfExists: false)
23
        // Clear cache before presenting the view controller so that pages are
24
        // re-rendered with annotations visible by default, in case the last
25
        // cache has annotations hidden.
26
        PSPDFKit.SDK.shared.cache.remove(for: document)
27
        // Due to the limitation of this example, thumbnail bar won't be updated
28
        // when hiding or showing annotations. So let's disable it.
29
        let controller = ToggleAnnotationVisibilityViewController(document: document) { builder in
30
            builder.thumbnailBarMode = .none
31
        }
32
        // Go directly to the page with annotations.
33
        controller.pageIndex = 15
34
        return controller
35
    }
36
}
37

38
private class ToggleAnnotationVisibilityViewController: PDFViewController {
39

40
    override func commonInit(with document: Document?, configuration: PDFConfiguration) {
41
        super.commonInit(with: document, configuration: configuration)
42

43
        let toggleAnnotationVisibilityBarButtonItem = UIBarButtonItem(image: UIImage(namedInCatalog: "hide"), style: .plain, target: self, action: #selector(didTapToggleAnnotationVisibilityBarButtonItem))
44
        toggleAnnotationVisibilityBarButtonItem.title = "hide"
45
        navigationItem.rightBarButtonItems = [toggleAnnotationVisibilityBarButtonItem]
46
    }
47

48
    @objc func didTapToggleAnnotationVisibilityBarButtonItem(_ sender: UIBarButtonItem) {
49
        // Let link annotations be always visible.
50
        if sender.title == "hide" {
51
            setVisibleAnnotationTypes(.link)
52
            sender.title = "show"
53
            sender.image = UIImage(namedInCatalog: "show")
54
        } else {
55
            setVisibleAnnotationTypes(.all)
56
            sender.title = "hide"
57
            sender.image = UIImage(namedInCatalog: "hide")
58
        }
59
    }
60

61
    // MARK: Private
62

63
    private func setVisibleAnnotationTypes(_ types: Annotation.Kind) {
64
        // Update the render types.
65
        document?.renderAnnotationTypes = types
66
        // Clear the cache so that pages are re-rendered once updated.
67
        PSPDFKit.SDK.shared.cache.remove(for: document)
68
        for pageView in visiblePageViews {
69
            pageView.updateAnnotationViews(animated: false)
70
            pageView.update()
71
        }
72
    }
73
}