Merge pull request #466 from nschloe/horizontal-alignment

Horizontal alignment

Author: nschloe

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = tikzplotlib
-version = 0.9.7
+version = 0.9.8
 author = Nico Schlömer
 author_email = [email protected]
 description = Convert matplotlib figures into TikZ/PGFPlots
@@ -21,6 +21,7 @@ classifiers =
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
     Topic :: Multimedia :: Graphics :: Graphics Conversion
     Topic :: Scientific/Engineering :: Visualization
 keywords =

test/test_dual_axis_reference.tex

@@ -48,7 +48,8 @@
 y grid style={white!69.019608!black},
 ymin=-100, ymax=2100,
 ytick pos=right,
-ytick style={color=black}
+ytick style={color=black},
+yticklabel style={anchor=west}
 ]
 \addplot [semithick, color0]
 table {%

test/test_horizontal_alignment.py

@@ -0,0 +1,29 @@
+import numpy as np
+import matplotlib.pyplot as plt
+
+from helpers import assert_equality
+
+
+def plot():
+    labels = ["lab1", "label 2", "another super label"]
+    n = len(labels)
+    x = np.arange(n)
+    y = 1 / (x + 1)
+
+    ax = plt.gca()
+    ax.bar(x, y, 0.5)
+
+    ax.set_xticks(x)
+    ax.set_xticklabels(labels)
+    plt.xticks(rotation=45, ha="right")
+
+
+def test():
+    assert_equality(plot, "test_horizontal_alignment_reference.tex")
+
+
+if __name__ == "__main__":
+    # import helpers
+    # helpers.compare_mpl_tex(plot)
+    plot()
+    plt.show()

test/test_horizontal_alignment_reference.tex

@@ -0,0 +1,23 @@
+\begin{tikzpicture}
+
+\definecolor{color0}{rgb}{0.12156863,0.46666667,0.70588235}
+
+\begin{axis}[
+tick align=outside,
+tick pos=left,
+x grid style={white!69.019608!black},
+xmin=-0.375, xmax=2.375,
+xtick style={color=black},
+xtick={0,1,2},
+xticklabel style={rotate=45.0,anchor=east},
+xticklabels={lab1,label 2,another super label},
+y grid style={white!69.019608!black},
+ymin=0, ymax=1.05,
+ytick style={color=black}
+]
+\draw[draw=none,fill=color0] (axis cs:-0.25,0) rectangle (axis cs:0.25,1);
+\draw[draw=none,fill=color0] (axis cs:0.75,0) rectangle (axis cs:1.25,0.5);
+\draw[draw=none,fill=color0] (axis cs:1.75,0) rectangle (axis cs:2.25,0.33333333);
+\end{axis}
+
+\end{tikzpicture}

test/test_legend_best_location.py

@@ -1,5 +1,7 @@
 import matplotlib.pyplot as plt
 import numpy as np
+import pytest
+
 from helpers import assert_equality
 
 
@@ -58,9 +60,10 @@ def plot():
     return fig
 
 
+# TODO find a way to make this robust
+@pytest.mark.skip(reason="'Best' location depends on window size.")
 def test():
     assert_equality(plot, "test_legend_best_location_reference.tex")
-    return
 
 
 if __name__ == "__main__":

test/test_legend_best_location_reference.tex

@@ -47,8 +47,8 @@
   fill opacity=0.8,
   draw opacity=1,
   text opacity=1,
-  at={(0.03,0.97)},
-  anchor=north west,
+  at={(0.5,0.91)},
+  anchor=north,
   draw=white!80!black
 },
 scaled x ticks=manual:{}{\pgfmathparse{#1}},
@@ -135,8 +135,8 @@
   fill opacity=0.8,
   draw opacity=1,
   text opacity=1,
-  at={(0.03,0.03)},
-  anchor=south west,
+  at={(0.97,0.03)},
+  anchor=south east,
   draw=white!80!black
 },
 scaled x ticks=manual:{}{\pgfmathparse{#1}},
@@ -239,8 +239,8 @@
   fill opacity=0.8,
   draw opacity=1,
   text opacity=1,
-  at={(0.09,0.5)},
-  anchor=west,
+  at={(0.5,0.5)},
+  anchor=center,
   draw=white!80!black
 },
 scaled x ticks=manual:{}{\pgfmathparse{#1}},
@@ -321,8 +321,8 @@
   fill opacity=0.8,
   draw opacity=1,
   text opacity=1,
-  at={(0.5,0.09)},
-  anchor=south,
+  at={(0.97,0.03)},
+  anchor=south east,
   draw=white!80!black
 },
 tick align=outside,
@@ -357,14 +357,7 @@
 
 \nextgroupplot[
 legend cell align={left},
-legend style={
-  fill opacity=0.8,
-  draw opacity=1,
-  text opacity=1,
-  at={(0.5,0.91)},
-  anchor=north,
-  draw=white!80!black
-},
+legend style={fill opacity=0.8, draw opacity=1, text opacity=1, draw=white!80!black},
 scaled y ticks=manual:{}{\pgfmathparse{#1}},
 tick align=outside,
 tick pos=left,
@@ -398,7 +391,14 @@
 \addlegendentry{UC}
 
 \nextgroupplot[
-legend style={fill opacity=0.8, draw opacity=1, text opacity=1, draw=white!80!black},
+legend style={
+  fill opacity=0.8,
+  draw opacity=1,
+  text opacity=1,
+  at={(0.91,0.5)},
+  anchor=east,
+  draw=white!80!black
+},
 scaled y ticks=manual:{}{\pgfmathparse{#1}},
 tick align=outside,
 tick pos=left,

tikzplotlib/_axes.py

@@ -459,69 +459,55 @@ def _get_label_rotation_and_horizontal_alignment(self, obj, data, x_or_y):
         if tick_label_text_width_identifier in self.axis_options:
             self.axis_options.remove(tick_label_text_width_identifier)
 
-        tick_labels_rotation = [label.get_rotation() for label in major_tick_labels]
-        tick_labels_rotation_same_value = len(set(tick_labels_rotation)) == 1
-
-        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
-        )
+        values = []
 
-        if (
-            tick_labels_rotation_same_value
-            and tick_labels_horizontal_alignment_same_value
-        ):
-            values = []
-
-            if any(tick_labels_rotation) != 0:
+        tick_labels_rotation = [label.get_rotation() for label in major_tick_labels]
+        if len(set(tick_labels_rotation)) == 1:
+            if tick_labels_rotation[0] != 0:
                 values.append(f"rotate={tick_labels_rotation[0]}")
-
-            # Horizontal alignment will be ignored if no 'x/y tick label text width' has
-            # been passed in the 'extra' parameter
-            # tick_label_text_width = None
-            # if tick_label_text_width:
-            #     values.append(f"align={tick_labels_horizontal_alignment[0]}")
-            #     values.append(f"text width={tick_label_text_width}")
-
-            if values:
-                label_style = "{}ticklabel style = {{{}}}".format(
-                    x_or_y, ",".join(values)
-                )
         else:
-            values = []
-
-            if tick_labels_rotation_same_value:
-                values.append("rotate={tick_labels_rotation[0]}")
-            else:
-                values.append(
-                    "rotate={{{},0}}[\\ticknum]".format(
-                        ",".join(str(x) for x in tick_labels_rotation)
-                    )
+            values.append(
+                "rotate={{{},0}}[\\ticknum]".format(
+                    ",".join(str(x) for x in tick_labels_rotation)
                 )
-
-            # 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(f"align={tick_labels_horizontal_alignment[0]}")
-            #         values.append(f"text width={tick_label_text_width}")
-            #     else:
-            #         for idx, x in enumerate(tick_labels_horizontal_alignment):
-            #             label_style += f"{x_or_y}_tick_label_ha_{idx}/.initial = {x}"
-
-            #         values.append(
-            #             f"align=\\pgfkeysvalueof{{/pgfplots/{x_or_y}_tick_label_ha_\\ticknum}}"
-            #         )
-            #         values.append(f"text width={tick_label_text_width}")
-
-            label_style = (
-                "every {} tick label/.style = {{\n"
-                "{}\n"
-                "}}".format(x_or_y, ",\n".join(values))
             )
 
+        tick_labels_horizontal_alignment = [
+            label.get_horizontalalignment() for label in major_tick_labels
+        ]
+        if len(set(tick_labels_horizontal_alignment)) == 1:
+            anchor = {"right": "east", "left": "west", "center": "center"}[
+                tick_labels_horizontal_alignment[0]
+            ]
+            if not (x_or_y == "x" and anchor == "center") and not (
+                x_or_y == "y" and anchor == "east"
+            ):
+                values.append(f"anchor={anchor}")
+
+        if values:
+            label_style = "{}ticklabel style={{{}}}".format(x_or_y, ",".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 is_tick_label_alignment_identical:
+        #         values.append(f"align={tick_labels_horizontal_alignment[0]}")
+        #         values.append(f"text width={tick_label_text_width}")
+        #     else:
+        #         for idx, x in enumerate(tick_labels_horizontal_alignment):
+        #             label_style += f"{x_or_y}_tick_label_ha_{idx}/.initial = {x}"
+
+        #         values.append(
+        #             f"align=\\pgfkeysvalueof{{/pgfplots/{x_or_y}_tick_label_ha_\\ticknum}}"
+        #         )
+        #         values.append(f"text width={tick_label_text_width}")
+
+        # label_style = (
+        #     "every {} tick label/.style = {{\n"
+        #     "{}\n"
+        #     "}}".format(x_or_y, ",\n".join(values))
+        # )
+
         return label_style
 
 
@@ -606,9 +592,10 @@ def _get_ticks(data, xy, ticks, ticklabels):
             axis_options.append(f"{xy}tick={val}")
 
         if is_label_required:
-            axis_options.append(
-                "{}ticklabels={{{}}}".format(xy, ",".join(pgfplots_ticklabels))
-            )
+            length = sum(len(label) for label in pgfplots_ticklabels)
+            sep = ("", ",", "") if length < 75 else ("\n  ", ",\n  ", "\n")
+            string = sep[1].join(pgfplots_ticklabels)
+            axis_options.append(f"{xy}ticklabels={{{sep[0]}{string}{sep[2]}}}")
     return axis_options
 
 

tikzplotlib/_cleanfigure.py

@@ -569,8 +569,8 @@ def _get_line_data(linehandle):
         xData, yData, zData = linehandle.get_data_3d()
         data = _stack_data_3D(xData, yData, zData)
     else:
-        xData = linehandle.get_xdata().astype(np.float32)
-        yData = linehandle.get_ydata().astype(np.float32)
+        xData = np.asarray(linehandle.get_xdata()).astype(np.float32)
+        yData = np.asarray(linehandle.get_ydata()).astype(np.float32)
         data = _stack_data_2D(xData, yData)
     return data, is3D
 

tikzplotlib/_save.py

@@ -31,6 +31,7 @@ def get_tikz_code(
     extra_axis_parameters: Optional[Union[List, Set]] = None,
     extra_groupstyle_parameters: dict = {},
     extra_tikzpicture_parameters: Optional[Union[List, Set]] = None,
+    extra_lines_start: Optional[Union[List, Set]] = None,
     dpi: Optional[int] = None,
     show_info: bool = False,
     include_disclaimer: bool = True,
@@ -224,7 +225,10 @@ def get_tikz_code(
         code += data["flavor"].start("tikzpicture")
         if extra_tikzpicture_parameters:
             code += "[\n" + ",\n".join(extra_tikzpicture_parameters) + "\n]"
-        code += "\n\n"
+        code += "\n"
+        if extra_lines_start:
+            code += "\n".join(extra_lines_start) + "\n"
+        code += "\n"
 
     coldefs = _get_color_definitions(data)
     if coldefs: