fix for barchart legends

Author: nschloe

matplotlib2tikz/line2d.py

@@ -150,9 +150,11 @@ def draw_linecollection(data, obj):
             options.append(linestyle)
 
         # TODO what about masks?
-        data, cont = mypath.draw_path(data, path, draw_options=options, simplify=False)
+        data, cont, _, _ = mypath.draw_path(
+            data, path, draw_options=options, simplify=False
+        )
 
-        content.append(cont)
+        content.append(cont + "\n")
 
     return data, content
 

matplotlib2tikz/patch.py

@@ -74,48 +74,43 @@ def _is_in_legend(obj):
 def _draw_rectangle(data, obj, draw_options):
     """Return the PGFPlots code for rectangles.
     """
-
-    # Objects with labels are plot objects (from bar charts, etc).
-    # Even those without labels explicitly set have a label of
-    # "_nolegend_".  Everything else should be skipped because
-    # they likely correspong to axis/legend objects which are
-    # handled by PGFPlots
+    # Objects with labels are plot objects (from bar charts, etc).  Even those without
+    # labels explicitly set have a label of "_nolegend_".  Everything else should be
+    # skipped because they likely correspong to axis/legend objects which are handled by
+    # PGFPlots
     label = obj.get_label()
     if label == "":
         return data, []
 
-    # get real label, bar charts by default only give rectangles
-    # labels of "_nolegend_"
-    # See
-    # <http://stackoverflow.com/questions/35881290/how-to-get-the-label-on-bar-plot-stacked-bar-plot-in-matplotlib>
+    # Get actual label, bar charts by default only give rectangles labels of
+    # "_nolegend_". See <https://stackoverflow.com/q/35881290/353337>.
     handles, labels = obj.axes.get_legend_handles_labels()
     labelsFound = [
         label for h, label in zip(handles, labels) if obj in h.get_children()
     ]
     if len(labelsFound) == 1:
         label = labelsFound[0]
 
-    legend = ""
-    if label != "_nolegend_" and label not in data["rectangle_legends"]:
-        data["rectangle_legends"].add(label)
-        legend = ("\\addlegendimage{{ybar,ybar legend,{}}};\n").format(
-            ",".join(draw_options)
-        )
-
     left_lower_x = obj.get_x()
     left_lower_y = obj.get_y()
     ff = data["float format"]
     cont = (
-        "{}\\draw[{}] (axis cs:" + ff + "," + ff + ") "
+        "\\draw[{}] (axis cs:" + ff + "," + ff + ") "
         "rectangle (axis cs:" + ff + "," + ff + ");\n"
     ).format(
-        legend,
         ",".join(draw_options),
         left_lower_x,
         left_lower_y,
         left_lower_x + obj.get_width(),
         left_lower_y + obj.get_height(),
     )
+
+    if label != "_nolegend_" and label not in data["rectangle_legends"]:
+        data["rectangle_legends"].add(label)
+        cont += "\\addlegendimage{{ybar,ybar legend,{}}};\n".format(
+            ",".join(draw_options)
+        )
+        cont += "\\addlegendentry{{{}}}\n\n".format(label)
     return data, cont
 
 

test/test_barchart_legend.py

@@ -37,3 +37,10 @@ def plot():
 def test():
     assert_equality(plot, "test_barchart_legend_reference.tex")
     return
+
+
+if __name__ == "__main__":
+    import helpers
+
+    helpers.compare_mpl_latex(plot)
+    # helpers.print_tree(plot())

test/test_barchart_legend_reference.tex

@@ -2,7 +2,6 @@
 
 \begin{axis}[
 legend cell align={left},
-legend entries={{Data 1},{Data 2},{Data 3}},
 legend style={draw=white!80.0!black},
 tick align=outside,
 tick pos=left,
@@ -11,16 +10,22 @@
 y grid style={white!69.01960784313725!black},
 ymin=0, ymax=5.25
 ]
-\addlegendimage{ybar,ybar legend,fill=blue,draw opacity=0};
 \draw[fill=blue,draw opacity=0] (axis cs:-0.375,0) rectangle (axis cs:-0.125,1);
+\addlegendimage{ybar,ybar legend,fill=blue,draw opacity=0};
+\addlegendentry{Data 1}
+
 \draw[fill=blue,draw opacity=0] (axis cs:0.625,0) rectangle (axis cs:0.875,2);
 \draw[fill=blue,draw opacity=0] (axis cs:1.625,0) rectangle (axis cs:1.875,3);
-\addlegendimage{ybar,ybar legend,fill=green!50.0!black,draw opacity=0};
 \draw[fill=green!50.0!black,draw opacity=0] (axis cs:-0.125,0) rectangle (axis cs:0.125,3);
+\addlegendimage{ybar,ybar legend,fill=green!50.0!black,draw opacity=0};
+\addlegendentry{Data 2}
+
 \draw[fill=green!50.0!black,draw opacity=0] (axis cs:0.875,0) rectangle (axis cs:1.125,2);
 \draw[fill=green!50.0!black,draw opacity=0] (axis cs:1.875,0) rectangle (axis cs:2.125,4);
-\addlegendimage{ybar,ybar legend,fill=red,draw opacity=0};
 \draw[fill=red,draw opacity=0] (axis cs:0.125,0) rectangle (axis cs:0.375,5);
+\addlegendimage{ybar,ybar legend,fill=red,draw opacity=0};
+\addlegendentry{Data 3}
+
 \draw[fill=red,draw opacity=0] (axis cs:1.125,0) rectangle (axis cs:1.375,3);
 \draw[fill=red,draw opacity=0] (axis cs:2.125,0) rectangle (axis cs:2.375,1);
 \end{axis}