Add per-page pdf notes in PdfFile and PdfPages.

Ulrich Dobramysl · Ulrich Dobramysl · commit 9f778851d328 · 2015-01-12T20:18:17.000Z
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -480,6 +480,9 @@ def __init__(self, filename):
 
         self.paths = []
 
+        self.pageAnnotations = [] # A list of annotations for the
+                                  # current page
+
         # The PDF spec recommends to include every procset
         procsets = [Name(x)
                     for x in "PDF Text ImageB ImageC ImageI".split()]
@@ -507,7 +510,8 @@ def newPage(self, width, height):
                    'Contents': contentObject,
                    'Group': {'Type': Name('Group'),
                              'S': Name('Transparency'),
-                             'CS': Name('DeviceRGB')}
+                             'CS': Name('DeviceRGB')},
+                   'Annots': self.pageAnnotations,
                    }
         pageObject = self.reserveObject('page')
         self.writeObject(pageObject, thePage)
@@ -519,6 +523,20 @@ def newPage(self, width, height):
         # graphics context: currently only the join style needs to be set
         self.output(GraphicsContextPdf.joinstyles['round'], Op.setlinejoin)
 
+        # Clear the list of annotations for the next page
+        self.pageAnnotations = []
+
+    def newTextnote(self, text, positionRect = [-100, -100, 0, 0]):
+        # Create a new annotation of type text
+        theNote = {'Type': Name('Annot'),
+                   'Subtype': Name('Text'),
+                   'Contents': text,
+                   'Rect': positionRect,
+                   }
+        annotObject = self.reserveObject('annotation')
+        self.writeObject(annotObject, theNote)
+        self.pageAnnotations.append(annotObject)
+
     def close(self):
         self.endStream()
         # Write out the various deferred objects
@@ -2445,6 +2463,11 @@ def get_pagecount(self):
         """
         return len(self._file.pageList)
 
+    def attach_note(self, text):
+        """
+        Add a new text note to the page to be saved next.
+        """
+        self._file.newTextnote(text)
 
 class FigureCanvasPdf(FigureCanvasBase):
     """
