Merge pull request #278 from nschloe/legend-fixes

Legend fixes

Author: nschloe

matplotlib2tikz/axes.py

@@ -126,7 +126,7 @@ def __init__(self, data, obj):
 
         # actually print the thing
         if self.is_subplot:
-            self.content.append("\\nextgroupplot")
+            self.content.append("\n\\nextgroupplot")
         else:
             self.content.append("\\begin{axis}")
 
@@ -405,28 +405,25 @@ def _subplot(self, obj, data):
                 if "is_in_groupplot_env" not in data or not data["is_in_groupplot_env"]:
                     self.content.append(
                         "\\begin{{groupplot}}[group style="
-                        "{{group size={} by {}}}]\n".format(geom[1], geom[0])
+                        "{{group size={} by {}}}]".format(geom[1], geom[0])
                     )
                     data["is_in_groupplot_env"] = True
                     data["pgfplots libs"].add("groupplots")
 
         return
 
 
-def _get_label_rotation_and_horizontal_alignment(obj, data, axes_obj):
+def _get_label_rotation_and_horizontal_alignment(obj, data, x_or_y):
     tick_label_text_width = None
-    tick_label_text_width_identifier = "{} tick label text width".format(axes_obj)
+    tick_label_text_width_identifier = "{} tick label text width".format(x_or_y)
     if tick_label_text_width_identifier in data["extra axis options"]:
-        tick_label_text_width = data["extra axis options [base]"][
-            tick_label_text_width_identifier
-        ]
-        del data["extra axis options"][tick_label_text_width_identifier]
+        data["extra axis options"].remove(tick_label_text_width_identifier)
 
     label_style = ""
 
     major_tick_labels = (
         obj.xaxis.get_majorticklabels()
-        if axes_obj == "x"
+        if x_or_y == "x"
         else obj.yaxis.get_majorticklabels()
     )
 
@@ -456,9 +453,7 @@ def _get_label_rotation_and_horizontal_alignment(obj, data, axes_obj):
             values.append("text width={}".format(tick_label_text_width))
 
         if values:
-            label_style = "{}ticklabel style = {{{}}}".format(
-                axes_obj, ",".join(values)
-            )
+            label_style = "{}ticklabel style = {{{}}}".format(x_or_y, ",".join(values))
     else:
         values = []
 
@@ -478,12 +473,12 @@ def _get_label_rotation_and_horizontal_alignment(obj, data, axes_obj):
             else:
                 for idx, x in enumerate(tick_labels_horizontal_alignment):
                     label_style += "{}_tick_label_ha_{}/.initial = {}".format(
-                        axes_obj, idx, x
+                        x_or_y, idx, x
                     )
 
                 values.append(
                     "align=\\pgfkeysvalueof{{/pgfplots/{}_tick_label_ha_\\ticknum}}".format(
-                        axes_obj
+                        x_or_y
                     )
                 )
                 values.append("text width={}".format(tick_label_text_width))
@@ -493,13 +488,13 @@ def _get_label_rotation_and_horizontal_alignment(obj, data, axes_obj):
                     "Horizontal alignment will be ignored as no '{} tick "
                     "label text width' has been passed in the 'extra' "
                     "parameter"
-                ).format(axes_obj)
+                ).format(x_or_y)
             )
 
         label_style = (
             "every {} tick label/.style = {{\n"
             "{}\n"
-            "}}".format(axes_obj, ",\n".join(values))
+            "}}".format(x_or_y, ",\n".join(values))
         )
 
     return label_style

matplotlib2tikz/legend.py

@@ -16,9 +16,6 @@ def draw_legend(data, obj):
         texts.append("{}".format(text.get_text()))
         children_alignment.append("{}".format(text.get_horizontalalignment()))
 
-    cont = "legend entries={{{{{}}}}}".format("},{".join(texts))
-    data["extra axis options"].add(cont)
-
     # Get the location.
     # http://matplotlib.org/api/legend_api.html
     loc = obj._loc if obj._loc != 0 else _get_location_from_best(obj)
@@ -84,25 +81,6 @@ def draw_legend(data, obj):
     if obj._ncol != 1:
         data["extra axis options"].add("legend columns={}".format(obj._ncol))
 
-    # Set color of lines in legend
-    for handle in obj.legendHandles:
-        try:
-            # when using matplotlib colours like "darkred" or "darkorange",
-            # `handle.get_color` will create nested RGBA codes
-            # e.g. `[[ 0.54509804, 0., 0., 1.]]` which casuse mpl to throw an error.
-            # catch this error, `numpy.squeeze` the colour code and try again
-            try:
-                data, legend_color, _ = mycol.mpl_color2xcolor(data, handle.get_color())
-            except ValueError:
-                data, legend_color, _ = mycol.mpl_color2xcolor(
-                    data, numpy.squeeze(handle.get_color())
-                )
-            data["legend colors"].append(
-                "\\addlegendimage{{no markers, {}}}\n".format(legend_color)
-            )
-        except AttributeError:
-            pass
-
     # Write styles to data
     if legend_style:
         style = "legend style={{{}}}".format(", ".join(legend_style))

matplotlib2tikz/line2d.py

@@ -9,17 +9,26 @@
 from . import files
 
 
-def get_legend_label_(line):
-    """Check if line is in legend
+def _has_legend(axes):
+    return axes.get_legend() is not None
+
+
+def _get_legend_text(line):
+    """Check if line is in legend.
     """
+    leg = line.axes.get_legend()
+    if leg is None:
+        return None
+
+    keys = [l.get_label() for l in leg.get_lines()]
+    values = [l.get_text() for l in leg.texts]
 
     label = line.get_label()
-    try:
-        ax = line.axes
-        leg = ax.get_legend()
-        return label in [l.get_label() for l in leg.get_lines()]
-    except AttributeError:
-        return None
+    d = dict(zip(keys, values))
+    if label in d:
+        return d[label]
+
+    return None
 
 
 def draw_line2d(data, obj):
@@ -73,19 +82,22 @@ def draw_line2d(data, obj):
     if marker and not show_line:
         addplot_options.append("only marks")
 
-    # Check if a line is not in a legend and forget it if so,
-    # fixes bug #167:
-    if not get_legend_label_(obj):
+    # Check if a line is in a legend and forget it if not.
+    # Fixes <https://github.com/nschloe/matplotlib2tikz/issues/167>.
+    legend_text = _get_legend_text(obj)
+    if legend_text is None and _has_legend(obj.axes):
         addplot_options.append("forget plot")
 
     # process options
     content.append("\\addplot ")
     if addplot_options:
-        options = ", ".join(addplot_options)
-        content.append("[" + options + "]\n")
+        content.append("[{}]\n".format(", ".join(addplot_options)))
 
     _table(obj, content, data)
 
+    if legend_text is not None:
+        content.append("\\addlegendentry{{{}}}\n".format(legend_text))
+
     return data, content
 
 
@@ -147,9 +159,10 @@ def draw_linecollection(data, obj):
             options.append(linestyle)
 
         # TODO what about masks?
-        data, cont = mypath.draw_path(data, path, draw_options=options, simplify=False)
-
-        content.append(cont)
+        data, cont, _, _ = mypath.draw_path(
+            data, path, draw_options=options, simplify=False
+        )
+        content.append(cont + "\n")
 
     return data, content
 

matplotlib2tikz/patch.py

@@ -21,7 +21,10 @@ def draw_patch(data, obj):
         return _draw_ellipse(data, obj, draw_options)
 
     # regular patch
-    return mypath.draw_path(data, obj.get_path(), draw_options=draw_options)
+    data, path_command, _, _ = mypath.draw_path(
+        data, obj.get_path(), draw_options=draw_options
+    )
+    return data, path_command
 
 
 def draw_patchcollection(data, obj):
@@ -40,57 +43,76 @@ def draw_patchcollection(data, obj):
         face_color = None
 
     data, draw_options = mypath.get_draw_options(data, edge_color, face_color)
-    for path in obj.get_paths():
-        data, cont = mypath.draw_path(data, path, draw_options=draw_options)
+
+    paths = obj.get_paths()
+    for path in paths:
+        data, cont, draw_options, is_area = mypath.draw_path(
+            data, path, draw_options=draw_options
+        )
         content.append(cont)
+
+    if _is_in_legend(obj):
+        # Unfortunately, patch legend entries need \addlegendimage in Pgfplots.
+        tpe = "area legend" if is_area else "line legend"
+        do = ", ".join([tpe] + draw_options) if draw_options else ""
+        content += [
+            "\\addlegendimage{{{}}}\n".format(do),
+            "\\addlegendentry{{{}}}\n\n".format(obj.get_label()),
+        ]
+    else:
+        content.append("\n")
+
     return data, content
 
 
+def _is_in_legend(obj):
+    label = obj.get_label()
+    leg = obj.axes.get_legend()
+    if leg is None:
+        return False
+    return label in [txt.get_text() for txt in leg.get_texts()]
+
+
 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
 
 

matplotlib2tikz/path.py

@@ -18,7 +18,7 @@ def draw_path(data, path, draw_options=None, simplify=None):
         and all(path.vertices[0] == path.vertices[1])
         and "fill opacity=0" in draw_options
     ):
-        return data, ""
+        return data, "", None, False
 
     nodes = []
     ff = data["float format"]
@@ -34,6 +34,7 @@ def draw_path(data, path, draw_options=None, simplify=None):
         # For path codes see: http://matplotlib.org/api/path_api.html
         #
         # if code == mpl.path.Path.STOP: pass
+        is_area = False
         if code == mpl.path.Path.MOVETO:
             nodes.append(("(axis cs:" + ff + "," + ff + ")").format(*vert))
         elif code == mpl.path.Path.LINETO:
@@ -103,14 +104,15 @@ def draw_path(data, path, draw_options=None, simplify=None):
         else:
             assert code == mpl.path.Path.CLOSEPOLY
             nodes.append("--cycle")
+            is_area = True
 
         # Store the previous point for quadratic Beziers.
         prev = vert[0:2]
 
     do = "[{}]".format(", ".join(draw_options)) if draw_options else ""
-    path_command = "\\path {} {};\n\n".format(do, "\n".join(nodes))
+    path_command = "\\path {}\n{};\n".format(do, "\n".join(nodes))
 
-    return data, path_command
+    return data, path_command, draw_options, is_area
 
 
 def draw_pathcollection(data, obj):