support for custom dash pattern

Author: Aikhjarto

matplotlib2tikz/path.py

@@ -293,7 +293,7 @@ def mpl_linewidth2pgfp_linewidth(data, line_width):
     return out
 
 
-def mpl_linestyle2pgfplots_linestyle(line_style):
+def mpl_linestyle2pgfplots_linestyle(line_style, line=None):
     """Translates a line style of matplotlib to the corresponding style
     in PGFPlots.
     """
@@ -314,6 +314,28 @@ def mpl_linestyle2pgfplots_linestyle(line_style):
 
         assert len(line_style[1]) == 4
         return "dash pattern=on {}pt off {}pt on {}pt off {}pt".format(*line_style[1])
+    
+    if isinstance(line, mpl.lines.Line2D) and line.is_dashed():
+        # see matplotlib.lines.Line2D.set_dashes
+
+        # get defaults
+        default_dashOffset, default_dashSeq = mpl.lines._get_dash_pattern(line_style)
+
+        # get dash format of line under test
+        dashSeq = line._us_dashSeq
+        dashOffset = line._us_dashOffset
+
+        lst = list()
+        if dashSeq != default_dashSeq:
+            # generate own dash sequence
+            format_string = " ".join(len(dashSeq) // 2 * ["on {}pt off {}pt"])
+            lst.append("dash pattern=" + format_string.format(*dashSeq))
+
+        if dashOffset != default_dashOffset:
+            lst.append("dash phase={}pt".format(dashOffset))
+
+        if len(lst) > 0:
+            return ", ".join(lst)
 
     return {
         "": None,

test/test_line_dashes.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+#
+import matplotlib.pyplot as plt
+
+from helpers import assert_equality
+
+
+def plot():
+    fig = plt.figure()
+    linestyles = ["-", "--", "-.", ":", (1, (10, 1)), (5, (10, 1)), (0, (1, 2, 3, 4))]
+    for idx, ls in enumerate(linestyles):
+        plt.plot([idx, idx + 1], linestyle=ls)
+    return fig
+
+
+def test():
+    assert_equality(plot, __file__[:-3] + "_reference.tex")
+    return
+
+
+if __name__ == "__main__":
+    import helpers
+
+    helpers.compare_mpl_latex(plot)
+    # helpers.print_tree(plot())

test/test_line_dashes_reference.tex

@@ -0,0 +1,58 @@
+\begin{tikzpicture}
+
+\definecolor{color0}{rgb}{0.12156862745098,0.466666666666667,0.705882352941177}
+\definecolor{color1}{rgb}{1,0.498039215686275,0.0549019607843137}
+\definecolor{color2}{rgb}{0.172549019607843,0.627450980392157,0.172549019607843}
+\definecolor{color3}{rgb}{0.83921568627451,0.152941176470588,0.156862745098039}
+\definecolor{color4}{rgb}{0.580392156862745,0.403921568627451,0.741176470588235}
+\definecolor{color5}{rgb}{0.549019607843137,0.337254901960784,0.294117647058824}
+\definecolor{color6}{rgb}{0.890196078431372,0.466666666666667,0.76078431372549}
+
+\begin{axis}[
+tick align=outside,
+tick pos=left,
+x grid style={white!69.01960784313725!black},
+xmin=-0.05, xmax=1.05,
+xtick style={color=black},
+y grid style={white!69.01960784313725!black},
+ymin=-0.35, ymax=7.35,
+ytick style={color=black}
+]
+\addplot [semithick, color0]
+table {%
+0 0
+1 1
+};
+\addplot [semithick, color1, dashed]
+table {%
+0 1
+1 2
+};
+\addplot [semithick, color2, dash pattern=on 1pt off 3pt on 3pt off 3pt]
+table {%
+0 2
+1 3
+};
+\addplot [semithick, color3, dotted]
+table {%
+0 3
+1 4
+};
+\addplot [semithick, color4, dash pattern=on 10pt off 1pt, dash phase=1pt]
+table {%
+0 4
+1 5
+};
+\addplot [semithick, color5, dash pattern=on 10pt off 1pt, dash phase=5pt]
+table {%
+0 5
+1 6
+};
+\addplot [semithick, color6, dash pattern=on 1pt off 2pt on 3pt off 4pt]
+table {%
+0 6
+1 7
+};
+\end{axis}
+
+\end{tikzpicture}