Merge pull request #154 from mlq/feature/axes-tick-label-rotation

Allow rotation of axes tick labels

Author: nschloe

matplotlib2tikz/axes.py

@@ -198,6 +198,29 @@ def __init__(self, data, obj):
                     assert direction == 'inout'
                     self.axis_options.append('tick align=center')
 
+        # Set each rotation for every label
+        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 = \
+            self.__get_label_rotation_and_horizontal_alignment(obj, data, 'y')
+        if y_tick_rotation_and_horizontal_alignment:
+            self.axis_options.append(y_tick_rotation_and_horizontal_alignment)
+
+        # Set tick position
+        x_tick_position_string, x_tick_position = \
+            self.__get_tick_position(obj, data, 'x')
+        y_tick_position_string, y_tick_position = \
+            self.__get_tick_position(obj, data, 'y')
+
+        if x_tick_position == y_tick_position and x_tick_position is not None:
+            self.axis_options.append("tick pos=%s" % x_tick_position)
+        else:
+            self.axis_options.append(x_tick_position_string)
+            self.axis_options.append(y_tick_position_string)
+
         # Don't use get_{x,y}gridlines for gridlines; see discussion on
         # <http://sourceforge.net/p/matplotlib/mailman/message/25169234/>
         # Coordinate of the lines are entirely meaningless, but styles
@@ -360,6 +383,113 @@ def __init__(self, data, obj):
 
         return
 
+    def __get_label_rotation_and_horizontal_alignment(self, obj, data, axes):
+        tick_label_text_width = None
+        tick_label_text_width_identifier = "%s tick label text width" % axes
+        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]
+
+        label_style = ""
+
+        major_tick_labels = obj.xaxis.get_majorticklabels() if axes == 'x' \
+            else obj.yaxis.get_majorticklabels()
+
+        if len(major_tick_labels) == 0:
+            return None
+
+        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
+
+        if tick_labels_rotation_same_value and \
+                tick_labels_horizontal_alignment_same_value:
+            values = []
+
+            if any(tick_labels_rotation) != 0:
+                values.append('rotate=%d' % tick_labels_rotation[0])
+
+            if tick_label_text_width:
+                values.append('align=%s' % tick_labels_horizontal_alignment[0])
+                values.append('text width=%s' % tick_label_text_width)
+            else:
+                print('Horizontal alignment will be ignored as no \'%s tick '
+                      'label text width\' has been passed in the \'extra\' '
+                      'parameter' % axes)
+
+            if len(values) > 0:
+                label_style = \
+                    '%sticklabel style = {%s}' % (axes, ','.join(values))
+        else:
+            values = []
+
+            if tick_labels_rotation_same_value:
+                values.append('rotate=%d' % tick_labels_rotation[0])
+            else:
+                values.append('rotate={%s,0}[\\ticknum]'
+                              % ','.join(str(x) for x in tick_labels_rotation))
+
+            if tick_label_text_width:
+                if tick_labels_horizontal_alignment_same_value:
+                    values.append('align=%s' %
+                                  tick_labels_horizontal_alignment[0])
+                    values.append('text width=%s' % tick_label_text_width)
+                else:
+                    for idx, x in enumerate(tick_labels_horizontal_alignment):
+                        label_style += '%s_tick_label_ha_%d/.initial = %s' \
+                            % (axes, idx, x)
+
+                    values.append(
+                        'align=\pgfkeysvalueof{/pgfplots/'
+                        '%s_tick_label_ha_\\ticknum}' % axes)
+                    values.append('text width=%s' % tick_label_text_width)
+            else:
+                print('Horizontal alignment will be ignored as no \'%s tick '
+                      'label text width\' has been passed in the \'extra\' '
+                      'parameter' % axes)
+
+            label_style = 'every %s tick label/.style = {\n' \
+                '%s\n' \
+                '}' % (axes, ',\n'.join(values))
+
+        return label_style
+
+    def __get_tick_position(self, obj, data, axes):
+        major_ticks = obj.xaxis.majorTicks if axes == 'x' else \
+            obj.yaxis.majorTicks
+
+        major_ticks_bottom = [tick.tick1On for tick in major_ticks]
+        major_ticks_top = [tick.tick2On for tick in major_ticks]
+
+        major_ticks_bottom_show_all = False
+        if len(set(major_ticks_bottom)) == 1 and major_ticks_bottom[0] is True:
+            major_ticks_bottom_show_all = True
+
+        major_ticks_top_show_all = False
+        if len(set(major_ticks_top)) == 1 and major_ticks_top[0] is True:
+            major_ticks_top_show_all = True
+
+        major_ticks_position = None
+        if not major_ticks_bottom_show_all and not major_ticks_top_show_all:
+            position_string = "%smajorticks=false" % axes
+        elif major_ticks_bottom_show_all and major_ticks_top_show_all:
+            major_ticks_position = 'both'
+        elif major_ticks_bottom_show_all:
+            major_ticks_position = 'left'
+        elif major_ticks_top_show_all:
+            major_ticks_position = 'right'
+
+        if major_ticks_position:
+            position_string = "%stick pos=%s" % (axes, major_ticks_position)
+
+        return position_string, major_ticks_position
+
     def get_begin_code(self):
         content = self.content
         if self.axis_options:

test/test_rotated_labels.py

@@ -0,0 +1,141 @@
+# -*- coding: utf-8 -*-
+#
+import matplotlib2tikz
+
+import pytest
+import tempfile
+import os
+from matplotlib import pyplot as plt
+
+
+def __plot():
+    fig, ax = plt.subplots()
+
+    x = [1, 2, 3, 4]
+    y = [1, 4, 9, 6]
+
+    plt.plot(x, y, 'ro')
+    plt.xticks(x, rotation='horizontal')
+
+    return fig, ax
+
+
+@pytest.mark.parametrize(
+    "x_alignment, y_alignment, x_tick_label_width,"
+    "y_tick_label_width, rotation", [
+        (None,     None,     "1rem", "3rem", 90),
+        (None,     "center", "1rem", "3rem", 90),
+        ("center", None,     "1rem", "3rem", 90),
+        ("center", "center", None,   "3rem", 90),
+        ("left",   "left",   None,   "3rem", 90),
+        ("right",  "right",  None,   "3rem", 90),
+        ("center", "center", "1rem", None,   90),
+        ("left",   "left",   "2rem", None,   90),
+        ("right",  "right",  "3rem", None,   90),
+        ("center", "center", "1rem", "3rem", 90),
+        ("left",   "left",   "2rem", "3rem", 90),
+        ("right",  "right",  "3rem", "3rem", 90),
+        ("left",   "right",  "2rem", "3rem", 90),
+        ("right",  "left",   "3rem", "3rem", 90),
+    ])
+def test_rotated_labels_parameters(x_alignment, y_alignment,
+                                   x_tick_label_width, y_tick_label_width,
+                                   rotation):
+    fig, _ = __plot()
+
+    if x_alignment:
+        plt.xticks(ha=x_alignment, rotation=rotation)
+    if y_alignment:
+        plt.yticks(ha=y_alignment, rotation=rotation)
+
+    # convert to tikz file
+    _, tmp_base = tempfile.mkstemp()
+    tikz_file = tmp_base + '_tikz.tex'
+
+    extra_dict = {}
+
+    if x_tick_label_width:
+        extra_dict['x tick label text width'] = x_tick_label_width
+    if y_tick_label_width:
+        extra_dict['y tick label text width'] = y_tick_label_width
+
+    matplotlib2tikz.save(
+        tikz_file,
+        figurewidth='7.5cm',
+        extra=extra_dict
+        )
+
+    # close figure
+    plt.close(fig)
+
+    # delete file
+    os.unlink(tikz_file)
+
+
+@pytest.mark.parametrize("x_tick_label_width, y_tick_label_width", [
+    (None,   None),
+    ("1rem", None),
+    (None,   "3rem"),
+    ("2rem", "3rem"),
+])
+def test_rotated_labels_parameters_different_values(x_tick_label_width,
+                                                    y_tick_label_width):
+    fig, ax = __plot()
+
+    plt.xticks(ha='left', rotation=90)
+    plt.yticks(ha='left', rotation=90)
+    ax.xaxis.get_majorticklabels()[0].set_rotation(20)
+    ax.yaxis.get_majorticklabels()[0].set_horizontalalignment('right')
+
+    # convert to tikz file
+    _, tmp_base = tempfile.mkstemp()
+    tikz_file = tmp_base + '_tikz.tex'
+
+    extra_dict = {}
+
+    if x_tick_label_width:
+        extra_dict['x tick label text width'] = x_tick_label_width
+    if y_tick_label_width:
+        extra_dict['y tick label text width'] = y_tick_label_width
+
+    matplotlib2tikz.save(
+        tikz_file,
+        figurewidth='7.5cm',
+        extra=extra_dict
+        )
+
+    # close figure
+    plt.close(fig)
+
+    # delete file
+    os.unlink(tikz_file)
+
+
+def test_rotated_labels_parameters_no_ticks():
+    fig, ax = __plot()
+
+    ax.xaxis.set_ticks([])
+
+    plt.tick_params(axis='x',
+                    which='both',
+                    bottom='off',
+                    top='off')
+    plt.tick_params(axis='y',
+                    which='both',
+                    left='off',
+                    right='off')
+
+    # convert to tikz file
+    _, tmp_base = tempfile.mkstemp()
+    tikz_file = tmp_base + '_tikz.tex'
+
+    matplotlib2tikz.save(
+        tikz_file,
+        figurewidth='7.5cm'
+        )
+
+    # close figure
+    plt.close(fig)
+
+    # delete file
+    os.unlink(tikz_file)

test/testfunctions/__init__.py

@@ -25,6 +25,8 @@
   'noise2',
   'patches',
   'quadmesh',
+  'rotated_labels',
+  'tick_positions',
   'scatter',
   'scatter_colormap',
   'sharex_and_y',

test/testfunctions/annotate.py

@@ -2,7 +2,7 @@
 #
 desc = 'Annotations'
 # phash = 'ab8a78a1549654fe'
-phash = 'ab8a71a1569654de'
+phash = 'ab8a79a1549654be'
 
 
 def plot():

test/testfunctions/barchart.py

@@ -7,7 +7,8 @@
 
 """
 desc = 'Bar Chart'
-phash = '5f09a9e6b3728742'
+phash = '5f09a9e6b172874a'
+
 
 def plot():
     import matplotlib.pyplot as plt

test/testfunctions/barchart_errorbars.py

@@ -6,7 +6,8 @@
 
 """
 desc = 'Bar Chart With Errorbars'
-phash = '5f09a9e4b37287c2'
+phash = '5f09a9e6b1728746'
+
 
 def plot():
     import matplotlib.pyplot as plt

test/testfunctions/barchart_legend.py

@@ -6,12 +6,13 @@
 patches that should not be plotted in PGFPlots (e.g. axis, legend)
 
 This also tests legends on barcharts. Which are difficult because
-in PGFPlots, they have no \\addplot, and thus legend must be 
+in PGFPlots, they have no \\addplot, and thus legend must be
 manually added.
 
 """
 desc = 'Bar Chart'
-phash = '5f09a9e633728dc4'
+phash = '5f19a966937285cc'
+
 
 def plot():
     import matplotlib.pyplot as plt

test/testfunctions/basic_sin.py

@@ -2,7 +2,7 @@
 #
 desc = 'Simple $\sin$ plot with some labels'
 # phash = '5f34e1ce21c3e5c1'
-phash = '1f36e1ce21c1e7c1'
+phash = '1f36e5c621c1e7c1'
 
 
 def plot():

test/testfunctions/boxplot.py

@@ -3,12 +3,13 @@
 
 This test plots a box plot with three data series. The causes an empty Line2D
 to be plotted.  Without care, this can turn into an empty table in PGFPlot
-which crashes latex (due to it treating an empty table as a table with 
+which crashes latex (due to it treating an empty table as a table with
 external data in the file '' or '.tex')
 See: https://github.com/nschloe/matplotlib2tikz/pull/134
 """
 desc = 'BoxPlot'
-phash = '6bc6f6b95e0000fe'
+phash = '6be3e6b95e8000de'
+
 
 def plot():
     import matplotlib.pyplot as plt

test/testfunctions/dual_axis.py

@@ -2,7 +2,7 @@
 #
 desc = 'Dual axis plot'
 # phash = '43a35c4b76a94eb8'
-phash = '5bab54492628de7c'
+phash = '5382544c16bdde75'
 
 
 def plot():