Add support for programmatically removing annotations

Author: RadAzzouz

index.js

@@ -192,6 +192,27 @@ class PSPDFKitView extends React.Component {
     }
   };
 
+  /**
+   * Removes an existing annotation from the current document.
+   *
+   * @param annotation InstantJson of the annotation to remove.
+   */
+  removeAnnotation = function(annotationName) {
+    if (Platform.OS === "android") {
+      // TODO: Uncomment once the Android implementaion is ready.
+      // UIManager.dispatchViewManagerCommand(
+      //   findNodeHandle(this.refs.pdfView),
+      //   UIManager.RCTPSPDFKitView.Commands.removeAnnotation,
+      //   [annotation]
+      // );
+    } else if (Platform.OS === "ios") {
+      NativeModules.PSPDFKitViewManager.removeAnnotation(
+        annotation,
+        findNodeHandle(this.refs.pdfView)
+      );
+    }
+  };
+
   /**
    * Gets all unsaved changes to annotations.
    *

ios/RCTPSPDFKit/RCTPSPDFKitView.h

@@ -37,7 +37,8 @@
 
 /// Anotations
 - (NSDictionary<NSString *, NSArray<NSDictionary *> *> *)getAnnotations:(PSPDFPageIndex)pageIndex type:(PSPDFAnnotationType)type;
-- (void)addAnnotation:(NSString *)jsonAnnotation;
+- (void)addAnnotation:(id)jsonAnnotation;
+- (void)removeAnnotation:(id)jsonAnnotation;
 - (NSDictionary<NSString *, NSArray<NSDictionary *> *> *)getAllUnsavedAnnotations;
 - (void)addAnnotations:(NSString *)jsonAnnotations;
 

ios/RCTPSPDFKit/RCTPSPDFKitView.m

@@ -203,6 +203,37 @@ - (void)addAnnotation:(id)jsonAnnotation {
   }
 }
 
+- (void)removeAnnotation:(id)jsonAnnotation {
+  NSData *data;
+  if ([jsonAnnotation isKindOfClass:NSString.class]) {
+    data = [jsonAnnotation dataUsingEncoding:NSUTF8StringEncoding];
+  } else if ([jsonAnnotation isKindOfClass:NSDictionary.class])  {
+    data = [NSJSONSerialization dataWithJSONObject:jsonAnnotation options:0 error:nil];
+  } else {
+    NSLog(@"Invalid JSON Annotation.");
+    return;
+  }
+
+  PSPDFDocument *document = self.pdfController.document;
+  PSPDFDocumentProvider *documentProvider = document.documentProviders.firstObject;
+
+  BOOL success = NO;
+  if (data) {
+    PSPDFAnnotation *annotationToRemove = [PSPDFAnnotation annotationFromInstantJSON:data documentProvider:documentProvider error:NULL];
+    for (PSPDFAnnotation *annotation in [document annotationsForPageAtIndex:annotationToRemove.pageIndex type:annotationToRemove.type]) {
+      // Remove the annotation if the name matches.
+      if ([annotation.name isEqualToString:annotationToRemove.name]) {
+        success = [document removeAnnotations:@[annotation] options:nil];
+        break;
+      }
+    }
+  }
+
+  if (!success) {
+    NSLog(@"Failed to remove annotation.");
+  }
+}
+
 - (NSDictionary<NSString *, NSArray<NSDictionary *> *> *)getAllUnsavedAnnotations {
   PSPDFDocumentProvider *documentProvider = self.pdfController.document.documentProviders.firstObject;
   NSData *data = [self.pdfController.document generateInstantJSONFromDocumentProvider:documentProvider error:NULL];

ios/RCTPSPDFKit/RCTPSPDFKitViewManager.m

@@ -116,6 +116,13 @@ @implementation RCTPSPDFKitViewManager
   });
 }
 
+RCT_EXPORT_METHOD(removeAnnotation:(id)jsonAnnotation reactTag:(nonnull NSNumber *)reactTag) {
+  dispatch_async(dispatch_get_main_queue(), ^{
+    RCTPSPDFKitView *component = (RCTPSPDFKitView *)[self.bridge.uiManager viewForReactTag:reactTag];
+    [component removeAnnotation:jsonAnnotation];
+  });
+}
+
 RCT_EXPORT_METHOD(getAllUnsavedAnnotations:(nonnull NSNumber *)reactTag resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
   dispatch_async(dispatch_get_main_queue(), ^{
     RCTPSPDFKitView *component = (RCTPSPDFKitView *)[self.bridge.uiManager viewForReactTag:reactTag];

samples/Catalog/Catalog.ios.js

@@ -593,6 +593,7 @@ class ProgrammaticAnnotations extends Component {
                   },
                   opacity: 1,
                   pageIndex: 0,
+                  name: "A167811E-6D10-4546-A147-B7AD775FE8AC",
                   strokeColor: "#AA47BE",
                   type: "pspdfkit/ink",
                   v: 1
@@ -602,6 +603,46 @@ class ProgrammaticAnnotations extends Component {
               title="addAnnotation"
             />
           </View>
+          <View>
+            <Button
+              onPress={() => {
+                // Programmatically remove an existing ink annotation.
+                const annotationJSON = {
+                  bbox: [
+                    89.586334228515625,
+                    98.5791015625,
+                    143.12948608398438,
+                    207.1583251953125
+                  ],
+                  isDrawnNaturally: false,
+                  lineWidth: 5,
+                  lines: {
+                    intensities: [[0.5, 0.5, 0.5], [0.5, 0.5, 0.5]],
+                    points: [
+                      [
+                        [92.086334228515625, 101.07916259765625],
+                        [92.086334228515625, 202.15826416015625],
+                        [138.12950134277344, 303.2374267578125]
+                      ],
+                      [
+                        [184.17266845703125, 101.07916259765625],
+                        [184.17266845703125, 202.15826416015625],
+                        [230.2158203125, 303.2374267578125]
+                      ]
+                    ]
+                  },
+                  opacity: 1,
+                  pageIndex: 0,
+                  name: "A167811E-6D10-4546-A147-B7AD775FE8AC",
+                  strokeColor: "#AA47BE",
+                  type: "pspdfkit/ink",
+                  v: 1
+                };
+                this.refs.pdfView.removeAnnotation(annotationJSON);
+              }}
+              title="removeAnnotation"
+            />
+          </View>
           <View>
             <Button
               onPress={() => {
@@ -635,6 +676,7 @@ class ProgrammaticAnnotations extends Component {
                       },
                       isDrawnNaturally: false,
                       strokeColor: "#AA47BE",
+                      name: "A167811E-6D10-4546-A147-B7AD775FE8AC",
                       updatedAt: "2018-07-30T15:34:48Z",
                       pageIndex: 0,
                       opacity: 1,