better legend handling

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,7 +405,7 @@ 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")

matplotlib2tikz/line2d.py

@@ -9,15 +9,26 @@
 from . import files
 
 
-def _is_in_legend(line):
+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:
-        leg = line.axes.get_legend()
-        return label in [l.get_label() for l in leg.get_lines()]
-    except AttributeError:
-        return False
+    d = dict(zip(keys, values))
+    if label in d:
+        return d[label]
+
+    return None
 
 
 def draw_line2d(data, obj):
@@ -73,21 +84,19 @@ def draw_line2d(data, obj):
 
     # Check if a line is in a legend and forget it if not.
     # Fixes <https://github.com/nschloe/matplotlib2tikz/issues/167>.
-    is_in_legend = _is_in_legend(obj)
-    if not is_in_legend:
+    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 is_in_legend:
-        label = obj.get_label()
-        content.append("\\addlegendentry{{{}}}\n".format(label))
+    if legend_text is not None:
+        content.append("\\addlegendentry{{{}}}\n".format(legend_text))
 
     return data, content
 
@@ -153,7 +162,6 @@ def draw_linecollection(data, obj):
         data, cont, _, _ = mypath.draw_path(
             data, path, draw_options=options, simplify=False
         )
-
         content.append(cont + "\n")
 
     return data, content

matplotlib2tikz/patch.py

@@ -68,6 +68,8 @@ def draw_patchcollection(data, obj):
 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()]
 
 

matplotlib2tikz/path.py

@@ -110,7 +110,7 @@ def draw_path(data, path, draw_options=None, simplify=None):
         prev = vert[0:2]
 
     do = "[{}]".format(", ".join(draw_options)) if draw_options else ""
-    path_command = "\\path {} {};\n".format(do, "\n".join(nodes))
+    path_command = "\\path {}\n{};\n".format(do, "\n".join(nodes))
 
     return data, path_command, draw_options, is_area
 

matplotlib2tikz/save.py

@@ -224,6 +224,7 @@ def get_tikz_code(
 \\usepackage{{pgfplots}}
 \\usepgfplotslibrary{{groupplots}}
 \\pgfplotsset{{compat=newest}}
+\\DeclareUnicodeCharacter{{2212}}{{-}}
 \\begin{{document}}
 {}
 \\end{{document}}""".format(

test/test_annotate_reference.tex

@@ -8,7 +8,7 @@
 y grid style={white!69.01960784313725!black},
 ymin=-4, ymax=3
 ]
-\addplot [semithick, blue, forget plot]
+\addplot [semithick, blue]
 table {%
 0 1
 0.2 0.309016994374947

test/test_barchart_errorbars_reference.tex

@@ -17,64 +17,73 @@
 \draw[fill=red,draw opacity=0] (axis cs:0.125,0) rectangle (axis cs:0.375,5);
 \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);
-\path [draw=black, line width=2.0pt] (axis cs:-0.25,0.9)
+\path [draw=black, line width=2.0pt]
+(axis cs:-0.25,0.9)
 --(axis cs:-0.25,1.1);
 
-\path [draw=black, line width=2.0pt] (axis cs:0.75,1.8)
+\path [draw=black, line width=2.0pt]
+(axis cs:0.75,1.8)
 --(axis cs:0.75,2.2);
 
-\path [draw=black, line width=2.0pt] (axis cs:1.75,2.5)
+\path [draw=black, line width=2.0pt]
+(axis cs:1.75,2.5)
 --(axis cs:1.75,3.5);
 
-\path [draw=black, line width=2.0pt] (axis cs:0,2.6)
+\path [draw=black, line width=2.0pt]
+(axis cs:0,2.6)
 --(axis cs:0,3.4);
 
-\path [draw=black, line width=2.0pt] (axis cs:1,1.8)
+\path [draw=black, line width=2.0pt]
+(axis cs:1,1.8)
 --(axis cs:1,2.2);
 
-\path [draw=black, line width=2.0pt] (axis cs:2,3.5)
+\path [draw=black, line width=2.0pt]
+(axis cs:2,3.5)
 --(axis cs:2,4.5);
 
-\path [draw=black, line width=2.0pt] (axis cs:0.25,4.9)
+\path [draw=black, line width=2.0pt]
+(axis cs:0.25,4.9)
 --(axis cs:0.25,5.1);
 
-\path [draw=black, line width=2.0pt] (axis cs:1.25,2.8)
+\path [draw=black, line width=2.0pt]
+(axis cs:1.25,2.8)
 --(axis cs:1.25,3.2);
 
-\path [draw=black, line width=2.0pt] (axis cs:2.25,0.9)
+\path [draw=black, line width=2.0pt]
+(axis cs:2.25,0.9)
 --(axis cs:2.25,1.1);
 
-\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks, forget plot]
+\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks]
 table {%
 -0.25 0.9
 0.75 1.8
 1.75 2.5
 };
-\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks, forget plot]
+\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks]
 table {%
 -0.25 1.1
 0.75 2.2
 1.75 3.5
 };
-\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks, forget plot]
+\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks]
 table {%
 0 2.6
 1 1.8
 2 3.5
 };
-\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks, forget plot]
+\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks]
 table {%
 0 3.4
 1 2.2
 2 4.5
 };
-\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks, forget plot]
+\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks]
 table {%
 0.25 4.9
 1.25 2.8
 2.25 0.9
 };
-\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks, forget plot]
+\addplot [semithick, black, mark=-, mark size=8, mark options={solid}, only marks]
 table {%
 0.25 5.1
 1.25 3.2

test/test_basic_sin_reference.tex

@@ -7,7 +7,6 @@
 axis background/.style={fill=white!89.80392156862746!black},
 axis line style={white},
 legend cell align={left},
-legend entries={{sin},{cos}},
 legend style={at={(0.03,0.03)}, anchor=south west, draw=white!80.0!black, fill=white!89.80392156862746!black},
 tick align=outside,
 tick pos=left,
@@ -44,6 +43,7 @@
 1.8 -0.951056516295154
 1.9 -0.587785252292473
 };
+\addlegendentry{sin}
 \addplot [very thick, color1, opacity=0.3, mark=*, mark size=3, mark options={solid}]
 table {%
 0 1
@@ -67,6 +67,7 @@
 1.8 0.309016994374947
 1.9 0.809016994374947
 };
+\addlegendentry{cos}
 \end{axis}
 
 \end{tikzpicture}

test/test_boxplot_reference.tex

@@ -10,109 +10,109 @@
 y grid style={white!69.01960784313725!black},
 ymin=0.874561785006674, ymax=0.899947924923841
 ]
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 0.85 0.879496627112448
 1.15 0.879496627112448
 1.15 0.884126666796246
 0.85 0.884126666796246
 0.85 0.879496627112448
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 1 0.879496627112448
 1 0.875715700457454
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 1 0.884126666796246
 1 0.888867871101896
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 0.925 0.875715700457454
 1.075 0.875715700457454
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 0.925 0.888867871101896
 1.075 0.888867871101896
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 1.85 0.88877516922908
 2.15 0.88877516922908
 2.15 0.895051444894661
 1.85 0.895051444894661
 1.85 0.88877516922908
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 2 0.88877516922908
 2 0.884905350828982
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 2 0.895051444894661
 2 0.898794009473061
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 1.925 0.884905350828982
 2.075 0.884905350828982
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 1.925 0.898794009473061
 2.075 0.898794009473061
 };
-\addplot [black, mark=*, mark size=3, mark options={solid,fill opacity=0}, only marks, forget plot]
+\addplot [black, mark=*, mark size=3, mark options={solid,fill opacity=0}, only marks]
 table {%
 2 0.877726738991693
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 2.85 0.888622590566905
 3.15 0.888622590566905
 3.15 0.892127720467477
 2.85 0.892127720467477
 2.85 0.888622590566905
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 3 0.888622590566905
 3 0.884168322531585
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 3 0.892127720467477
 3 0.894515611281891
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 2.925 0.884168322531585
 3.075 0.884168322531585
 };
-\addplot [black, forget plot]
+\addplot [black]
 table {%
 2.925 0.894515611281891
 3.075 0.894515611281891
 };
-\addplot [black, mark=*, mark size=3, mark options={solid,fill opacity=0}, only marks, forget plot]
+\addplot [black, mark=*, mark size=3, mark options={solid,fill opacity=0}, only marks]
 table {%
 3 0.898104652708716
 };
-\addplot [color0, forget plot]
+\addplot [color0]
 table {%
 0.85 0.883074649623178
 1.15 0.883074649623178
 };
-\addplot [color0, forget plot]
+\addplot [color0]
 table {%
 1.85 0.892160329903995
 2.15 0.892160329903995
 };
-\addplot [color0, forget plot]
+\addplot [color0]
 table {%
 2.85 0.891012819071749
 3.15 0.891012819071749

test/test_colorbars.py

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