Merge pull request #286 from nschloe/datetime

support for datetime

Author: nschloe

README.md

@@ -18,10 +18,13 @@ This is matplotlib2tikz, a Python tool for converting matplotlib figures into
 for native inclusion into LaTeX documents.
 
 The output of matplotlib2tikz is in
-[PGFPlots](http://pgfplots.sourceforge.net/pgfplots.pdf), a LaTeX library that
-sits on top of TikZ and describes graphs in terms of axes, data etc.
-Consequently, the output of matplotlib2tikz retains more information, can be
-more easily understood, and is more easily editable than [raw TikZ output](https://matplotlib.org/users/whats_new.html#pgf-tikz-backend).
+[PGFPlots](http://pgfplots.sourceforge.net/pgfplots.pdf), a LaTeX library that sits on
+top of [PGF/TikZ](https://en.wikipedia.org/wiki/PGF/TikZ) and describes graphs in terms
+of axes, data etc. Consequently, the output of matplotlib2tikz
+  * retains more information,
+  * can be more easily understood, and
+  * is more easily editable
+than [raw TikZ output](https://matplotlib.org/users/whats_new.html#pgf-tikz-backend).
 For example, the matplotlib figure
 ```python,test
 import matplotlib.pyplot as plt
@@ -45,26 +48,25 @@ tikz_save("test.tex")
 ```
 (see above) gives
 ```latex
-% This file was created by matplotlib2tikz vx.y.z.
 \begin{tikzpicture}
 
-\definecolor{color1}{rgb}{0.203921568627451,0.541176470588235,0.741176470588235}
 \definecolor{color0}{rgb}{0.886274509803922,0.290196078431373,0.2}
+\definecolor{color1}{rgb}{0.203921568627451,0.541176470588235,0.741176470588235}
 
 \begin{axis}[
-title={Simple plot $\frac{\alpha}{2}$},
-xlabel={time (s)},
-ylabel={Voltage (mV)},
-xmin=-0.095, xmax=1.995,
-ymin=-1.1, ymax=1.1,
+axis background/.style={fill=white!89.80392156862746!black},
+axis line style={white},
 tick align=outside,
 tick pos=left,
-xmajorgrids,
+title={Simple plot $\frac{\alpha}{2}$},
 x grid style={white},
-ymajorgrids,
+xlabel={time (s)},
+xmajorgrids,
+xmin=-0.095, xmax=1.995,
 y grid style={white},
-axis line style={white},
-axis background/.style={fill=white!89.803921568627459!black}
+ylabel={Voltage (mV)},
+ymajorgrids,
+ymin=-1.1, ymax=1.1
 ]
 \addplot [line width=1.64pt, color0, mark=*, mark size=3, mark options={solid}]
 table {%
@@ -92,7 +94,7 @@ work flow.
 contains great examples of how to make your plot look even better.
 
 Of course, not all figures produced by matplotlib can be converted without error.
-Notably, [3D plot don't work](https://github.com/matplotlib/matplotlib/issues/7243).
+Notably, [3D plots don't work](https://github.com/matplotlib/matplotlib/issues/7243).
 
 ### Installation
 
@@ -111,54 +113,25 @@ to install/update.
 
 2. Instead of `pyplot.show()`, invoke matplotlib2tikz by
     ```python
-    tikz_save('mytikz.tex')
-    ```
-   to store the TikZ file as `mytikz.tex`. Load the library with:
-    ```python
-    from matplotlib2tikz import save as tikz_save
-    ```
-   _Optional:_
-   The scripts accepts several options, for example `height`, `width`,
-   `encoding`, and some others. Invoke by
-    ```python
-    tikz_save('mytikz.tex', figureheight='4cm', figurewidth='6cm')
-    ```
-   Note that height and width must be set large enough; setting it too low may
-   result in a LaTeX compilation failure along the lines of `Dimension Too Large` or `Arithmetic Overflow`;
-   see information about these errors in [the PGFPlots manual](http://pgfplots.sourceforge.net/pgfplots.pdf).
-   To specify the dimension of the plot from within the LaTeX document, try
-    ```python
-    tikz_save(
-        'mytikz.tex',
-        figureheight='\\figureheight',
-        figurewidth='\\figurewidth'
-        )
+    import matplotlib2tikz
+    matplotlib2tikz.save("mytikz.tex")
     ```
-    and in the LaTeX source
+   to store the TikZ file as `mytikz.tex`.
+
+3. Add the contents of `mytikz.tex` into your LaTeX source code. A convenient way of
+   doing so is via
     ```latex
-    \newlength\figureheight
-    \newlength\figurewidth
-    \setlength\figureheight{4cm}
-    \setlength\figurewidth{6cm}
-    \input{mytikz.tex}
+    \input{/path/to/mytikz.tex}
     ```
-
-3. Add the contents of `mytikz.tex` into your LaTeX source code; a convenient
-   way of doing so is via `\input{/path/to/mytikz.tex}`. Also make sure that
-   in the header of your document the packages for PGFPlots and proper Unicode
-   support and are included:
+   Also make sure that the packages for PGFPlots and proper Unicode support and are
+   included in the header of your document:
     ```latex
     \usepackage[utf8]{inputenc}
+    \usepackage{fontspec}  % optional
     \usepackage{pgfplots}
-    ```
-   Additionally, with LuaLaTeX
-    ```latex
-    \usepackage{fontspec}
-    ```
-   is needed to typeset Unicode characters.
-   Optionally, to use the latest PGFPlots features, insert
-    ```latex
     \pgfplotsset{compat=newest}
+    \usepgfplotslibrary{groupplots}
+    \usepgfplotslibrary{dateplot}
     ```
 
 ### Contributing

matplotlib2tikz/axes.py

@@ -230,13 +230,13 @@ def _ticks(self, data, obj):
                     self.axis_options.append("tick align=center")
 
         # Set each rotation for every label
-        x_tick_rotation_and_horizontal_alignment = _get_label_rotation_and_horizontal_alignment(
+        x_tick_rotation_and_horizontal_alignment = self._get_label_rotation_and_horizontal_alignment(
             obj, data, "x"
         )
         if x_tick_rotation_and_horizontal_alignment:
             self.axis_options.append(x_tick_rotation_and_horizontal_alignment)
 
-        y_tick_rotation_and_horizontal_alignment = _get_label_rotation_and_horizontal_alignment(
+        y_tick_rotation_and_horizontal_alignment = self._get_label_rotation_and_horizontal_alignment(
             obj, data, "y"
         )
         if y_tick_rotation_and_horizontal_alignment:
@@ -397,86 +397,92 @@ def _subplot(self, obj, data):
 
         return
 
+    def _get_label_rotation_and_horizontal_alignment(self, obj, data, x_or_y):
+        tick_label_text_width = None
+        tick_label_text_width_identifier = "{} tick label text width".format(x_or_y)
+        if tick_label_text_width_identifier in self.axis_options:
+            self.axis_options.remove(tick_label_text_width_identifier)
 
-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(x_or_y)
-    if tick_label_text_width_identifier in data["extra axis options"]:
-        data["extra axis options"].remove(tick_label_text_width_identifier)
+        label_style = ""
 
-    label_style = ""
-
-    major_tick_labels = (
-        obj.xaxis.get_majorticklabels()
-        if x_or_y == "x"
-        else obj.yaxis.get_majorticklabels()
-    )
-
-    if not major_tick_labels:
-        return None
+        major_tick_labels = (
+            obj.xaxis.get_majorticklabels()
+            if x_or_y == "x"
+            else obj.yaxis.get_majorticklabels()
+        )
 
-    tick_labels_rotation = [label.get_rotation() for label in major_tick_labels]
-    tick_labels_rotation_same_value = len(set(tick_labels_rotation)) == 1
+        if not major_tick_labels:
+            return None
 
-    tick_labels_horizontal_alignment = [
-        label.get_horizontalalignment() for label in major_tick_labels
-    ]
-    tick_labels_horizontal_alignment_same_value = (
-        len(set(tick_labels_horizontal_alignment)) == 1
-    )
+        tick_labels_rotation = [label.get_rotation() for label in major_tick_labels]
+        tick_labels_rotation_same_value = len(set(tick_labels_rotation)) == 1
 
-    if tick_labels_rotation_same_value and tick_labels_horizontal_alignment_same_value:
-        values = []
+        tick_labels_horizontal_alignment = [
+            label.get_horizontalalignment() for label in major_tick_labels
+        ]
+        tick_labels_horizontal_alignment_same_value = (
+            len(set(tick_labels_horizontal_alignment)) == 1
+        )
 
-        if any(tick_labels_rotation) != 0:
-            values.append("rotate={}".format(tick_labels_rotation[0]))
+        if (
+            tick_labels_rotation_same_value
+            and tick_labels_horizontal_alignment_same_value
+        ):
+            values = []
 
-        # Horizontal alignment will be ignored if no 'x/y tick label text width' has
-        # been passed in the 'extra' parameter
-        if tick_label_text_width:
-            values.append("align={}".format(tick_labels_horizontal_alignment[0]))
-            values.append("text width={}".format(tick_label_text_width))
+            if any(tick_labels_rotation) != 0:
+                values.append("rotate={}".format(tick_labels_rotation[0]))
 
-        if values:
-            label_style = "{}ticklabel style = {{{}}}".format(x_or_y, ",".join(values))
-    else:
-        values = []
+            # Horizontal alignment will be ignored if no 'x/y tick label text width' has
+            # been passed in the 'extra' parameter
+            if tick_label_text_width:
+                values.append("align={}".format(tick_labels_horizontal_alignment[0]))
+                values.append("text width={}".format(tick_label_text_width))
 
-        if tick_labels_rotation_same_value:
-            values.append("rotate={}".format(tick_labels_rotation[0]))
-        else:
-            values.append(
-                "rotate={{{},0}}[\\ticknum]".format(
-                    ",".join(str(x) for x in tick_labels_rotation)
+            if values:
+                label_style = "{}ticklabel style = {{{}}}".format(
+                    x_or_y, ",".join(values)
                 )
-            )
+        else:
+            values = []
 
-        # Ignore horizontal alignment if no '{x,y} tick label text width' has
-        # been passed in the 'extra' parameter
-        if tick_label_text_width:
-            if tick_labels_horizontal_alignment_same_value:
-                values.append("align={}".format(tick_labels_horizontal_alignment[0]))
-                values.append("text width={}".format(tick_label_text_width))
+            if tick_labels_rotation_same_value:
+                values.append("rotate={}".format(tick_labels_rotation[0]))
             else:
-                for idx, x in enumerate(tick_labels_horizontal_alignment):
-                    label_style += "{}_tick_label_ha_{}/.initial = {}".format(
-                        x_or_y, idx, x
-                    )
-
                 values.append(
-                    "align=\\pgfkeysvalueof{{/pgfplots/{}_tick_label_ha_\\ticknum}}".format(
-                        x_or_y
+                    "rotate={{{},0}}[\\ticknum]".format(
+                        ",".join(str(x) for x in tick_labels_rotation)
                     )
                 )
-                values.append("text width={}".format(tick_label_text_width))
 
-        label_style = (
-            "every {} tick label/.style = {{\n"
-            "{}\n"
-            "}}".format(x_or_y, ",\n".join(values))
-        )
+            # Ignore horizontal alignment if no '{x,y} tick label text width' has
+            # been passed in the 'extra' parameter
+            if tick_label_text_width:
+                if tick_labels_horizontal_alignment_same_value:
+                    values.append(
+                        "align={}".format(tick_labels_horizontal_alignment[0])
+                    )
+                    values.append("text width={}".format(tick_label_text_width))
+                else:
+                    for idx, x in enumerate(tick_labels_horizontal_alignment):
+                        label_style += "{}_tick_label_ha_{}/.initial = {}".format(
+                            x_or_y, idx, x
+                        )
+
+                    values.append(
+                        "align=\\pgfkeysvalueof{{/pgfplots/{}_tick_label_ha_\\ticknum}}".format(
+                            x_or_y
+                        )
+                    )
+                    values.append("text width={}".format(tick_label_text_width))
+
+            label_style = (
+                "every {} tick label/.style = {{\n"
+                "{}\n"
+                "}}".format(x_or_y, ",\n".join(values))
+            )
 
-    return label_style
+        return label_style
 
 
 def _get_tick_position(obj, axes_obj):

matplotlib2tikz/legend.py

@@ -76,15 +76,17 @@ def draw_legend(data, obj):
             break
 
     if alignment:
-        data["extra axis options"].add("legend cell align={{{}}}".format(alignment))
+        data["current axes"].axis_options.append(
+            "legend cell align={{{}}}".format(alignment)
+        )
 
     if obj._ncol != 1:
-        data["extra axis options"].add("legend columns={}".format(obj._ncol))
+        data["current axes"].axis_options.append("legend columns={}".format(obj._ncol))
 
     # Write styles to data
     if legend_style:
         style = "legend style={{{}}}".format(", ".join(legend_style))
-        data["extra axis options"].add(style)
+        data["current axes"].axis_options.append(style)
 
     return data