add framon option for legend

leejjoon · leejjoon · commit eab892e8c55c · 2009-10-02T18:58:20.000Z
svn path=/trunk/matplotlib/; revision=7841
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -3925,6 +3925,9 @@ def legend(self, *args, **kwargs):
             The relative size of legend markers vs. original. If *None*, use rc
             settings.
 
+          *frameon*: [ True | False ]
+            if True, draw a frame.  Default is True
+
           *fancybox*: [ None | False | True ]
             if True, draw a frame with a round fancybox.  If None, use rc
 
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -115,6 +115,7 @@ def __init__(self, parent, handles, labels,
                  title = None, # set a title for the legend
                  bbox_to_anchor = None, # bbox that the legend will be anchored.
                  bbox_transform = None, # transform for the bbox
+                 frameon = True, # draw frame
                  ):
         """
         - *parent* : the artist that contains the legend
@@ -132,6 +133,7 @@ def __init__(self, parent, handles, labels,
         numpoints          the number of points in the legend for line
         scatterpoints      the number of points in the legend for scatter plot
         scatteryoffsets    a list of yoffsets for scatter symbols in legend
+        frameon            if True, draw a frame (default is True)
         fancybox           if True, draw a frame with a round fancybox.  If None, use rc
         shadow             if True, draw a shadow behind legend
         ncol               number of columns
@@ -303,7 +305,7 @@ def __init__(self, parent, handles, labels,
 
         self._set_artist_props(self.legendPatch)
 
-        self._drawFrame = True
+        self._drawFrame = frameon
 
         # init with null renderer
         self._init_legend_box(handles, labels)
@@ -687,7 +689,7 @@ def _auto_legend_data(self):
 
     def draw_frame(self, b):
         'b is a boolean.  Set draw frame to b'
-        self._drawFrame = b
+        self.set_frame_on(b)
 
     def get_children(self):
         'return a list of child artists'
@@ -737,6 +739,20 @@ def get_window_extent(self):
         return self.legendPatch.get_window_extent()
 
 
+    def get_frame_on(self):
+        """
+        Get whether the legend box patch is drawn
+        """
+        return self._drawFrame
+
+    def set_frame_on(self, b):
+        """
+        Set whether the legend box patch is drawn
+
+        ACCEPTS: [ *True* | *False* ]
+        """
+        self._drawFrame = b
+
     def get_bbox_to_anchor(self):
         """
         return the bbox that the legend will be anchored
