Source code for plotnine.themes.themeable

"""
Provide theamables, that is the elements can be themed.

From the ggplot2 documentation the axis.title inherits from text.
What this means is that axis.title and text have the same elements
that may be themed, but the scope of what they apply to is different.
The scope of text covers all text in the plot, axis.title applies
only to the axis.title. In matplotlib terms this means that a theme
that covers text also has to cover axis.title.
"""
from contextlib import suppress
from copy import deepcopy

from ..utils import RegistryHierarchyMeta, to_rgba
from ..exceptions import PlotnineError
from .elements import (element_line, element_rect,
                       element_text, element_blank)


[docs]class themeable(metaclass=RegistryHierarchyMeta): """ themeable is an abstract class of things that can be themed. Every subclass of themeable is stored in a dict at :python:`themeable.register` with the name of the subclass as the key. It is the base of a class hierarchy that uses inheritance in a non-traditional manner. In the textbook use of class inheritance, superclasses are general and subclasses are specializations. In some since the hierarchy used here is the opposite in that superclasses are more specific than subclasses. It is probably better to think if this hierarchy of leveraging Python's multiple inheritance to implement composition. For example the ``axis_title`` themeable is *composed of* the ``x_axis_title`` and the ``y_axis_title``. We are just using multiple inheritance to specify this composition. When implementing a new themeable based on the ggplot2 documentation, it is important to keep this in mind and reverse the order of the "inherits from" in the documentation. For example, to implement, - ``axis_title_x`` - ``x`` axis label (element_text; inherits from ``axis_title``) - ``axis_title_y`` - ``y`` axis label (element_text; inherits from ``axis_title``) You would have this implementation: :: class axis_title_x(themeable): ... class axis_title_y(themeable): ... class axis_title(axis_title_x, axis_title_y): ... If the superclasses fully implement the subclass, the body of the subclass should be "pass". Python(__mro__) will do the right thing. When a method does require implementation, call :python:`super()` then add the themeable's implementation to the axes. Notes ----- A user should never create instances of class :class:`themeable` or subclasses of it. """ order = 0 def __init__(self, theme_element=None): self.theme_element = theme_element element_types = (element_text, element_line, element_rect, element_blank) if isinstance(theme_element, element_types): self.properties = theme_element.properties else: # The specific themeable takes this value and # does stuff with rcParams or sets something # on some object attached to the axes/figure self.properties = {'value': theme_element} if isinstance(theme_element, element_blank): self.apply = self.blank self.apply_figure = self.blank_figure @staticmethod def from_class_name(name, theme_element): """ Create an themeable by name Parameters ---------- name : str Class name theme_element : element object One of :class:`element_line`, :class:`element_rect`, :class:`element_text` or :class:`element_blank` Returns ------- out : Themeable """ msg = "No such themeable element {}".format(name) try: klass = themeable._registry[name] except KeyError: raise PlotnineError(msg) if not issubclass(klass, themeable): raise PlotnineError(msg) return klass(theme_element) @classmethod def registry(cls): return themeable._registry def is_blank(self): """ Return True if theme_element is made of element_blank """ return isinstance(self.theme_element, element_blank) def merge(self, other): """ Merge properties of other into self Raises ------ ValueError If any of the properties are blank """ if self.is_blank() or other.is_blank(): raise ValueError('Cannot merge if there is a blank.') else: self.properties.update(other.properties) def __eq__(self, other): "Mostly for unittesting." return ((self.__class__ == other.__class__) and (self.properties == other.properties)) @property def rcParams(self): """ Return themeables rcparams to an rcparam dict before plotting. Returns ------- dict Dictionary of legal matplotlib parameters. This method should always call super(...).rcParams and update the dictionary that it returns with its own value, and return that dictionary. This method is called before plotting. It tends to be more useful for general themeables. Very specific themeables often cannot be be themed until they are created as a result of the plotting process. """ return {} def apply(self, ax): """ Called after a chart has been plotted. Subclasses should override this method to customize the plot according to the theme. Parameters ---------- ax : matplotlib.axes.Axes This method should be implemented as super(...).apply() followed by extracting the portion of the axes specific to this themeable then applying the properties. """ pass def apply_figure(self, figure): """ Apply theme to the figure Compared to :meth:`setup_figure`, this method is called after plotting and all the elements are drawn onto the figure. """ pass def setup_figure(self, figure): """ Apply theme to the figure Compared to :meth:`apply_figure`, this method is called before any plotting is done. This is necessary in some cases where the drawing functions need(or can make use of) this information. """ pass def blank(self, ax): """ Blank out theme elements """ pass def blank_figure(self, figure): """ Blank out elements on the figure """ pass
class Themeables(dict): """ Collection of themeables The `key` to the value is the name of the class. """ def update(self, other): """ Update themeables with those from `other` This method takes care of inserting the `themeable` into the underlying dictionary. Before doing the insertion, any existing themeables that will be affected by a new from `other` will either be merged or removed. This makes sure that a general themeable of type :class:`text` can be added to override an existing specific one of type :class:`axis_text_x`. """ for new in other.values(): new_key = new.__class__.__name__ # 1st in the mro is self, the # last 2 are (themeable, object) for child in new.__class__.mro()[1:-2]: child_key = child.__name__ try: self[child_key].merge(new) except KeyError: pass except ValueError: # Blank child is will be overridden del self[child_key] try: self[new_key].merge(new) except (KeyError, ValueError): # Themeable type is new or # could not merge blank element. self[new_key] = new def values(self): """ Return a list themeables sorted in reverse based on the their depth in the inheritance hierarchy. The sorting is key applying and merging the themeables so that they do not clash i.e :class:`axis_line` applied before :class:`axis_line_x`. """ def key(th): return len(th.__class__.__mro__) return sorted(dict.values(self), key=key, reverse=True) def property(self, name, key='value'): """ Get the value a specific themeable(s) property Themeables store theming attribute values in the :attr:`Themeable.properties` :class:`dict`. The goal of this method is to look a value from that dictionary, and fallback along the inheritance heirarchy of themeables. Parameters ---------- name : str Themeable name key : str Property name to lookup Returns ------- out : object Value Raises ------ KeyError If key is in not in any of themeables """ hlist = themeable._hierarchy[name] scalar = key == 'value' for th in hlist: try: value = self[th].properties[key] except KeyError: continue else: if not scalar or value is not None: return value msg = "'{}' is not in the properties of {} " raise KeyError(msg.format(key, hlist)) def is_blank(self, name): """ Return True if the themeable *name* is blank This if the *name* is not in the list of themeables then the lookup falls back to inheritance hierarchy is considered. If the none of the themeables in the hierary are present, ``False`` will be returned. Parameters ---------- names : str Themeable, in order of most specific to most general. """ for th in themeable._hierarchy[name]: with suppress(KeyError): return self[th].is_blank() return False def _blankout_rect(rect): """ Make rect invisible """ # set_visible(False) does not clear the attributes rect.set_edgecolor('None') rect.set_facecolor('None') rect.set_linewidth(0) # element_text themeables
[docs]class axis_title_x(themeable): """ x axis label Parameters ---------- theme_element : element_text """ def apply_figure(self, figure): super(axis_title_x, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): text = figure._themeable['axis_title_x'] text.set(**properties) def blank_figure(self, figure): super(axis_title_x, self).blank_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): text = figure._themeable['axis_title_x'] text.set_visible(False)
[docs]class axis_title_y(themeable): """ y axis label Parameters ---------- theme_element : element_text """ def apply_figure(self, figure): super(axis_title_y, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): text = figure._themeable['axis_title_y'] text.set(**properties) def blank_figure(self, figure): super(axis_title_y, self).blank_figure(figure) with suppress(KeyError): text = figure._themeable['axis_title_y'] text.set_visible(False)
[docs]class axis_title(axis_title_x, axis_title_y): """ Axis labels Parameters ---------- theme_element : element_text """ pass
[docs]class legend_title(themeable): """ Legend title Parameters ---------- theme_element : element_text """ def apply_figure(self, figure): super(legend_title, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): textareas = figure._themeable['legend_title'] for ta in textareas: ta._text.set(**properties) def blank_figure(self, figure): super(legend_title, self).blank_figure(figure) with suppress(KeyError): textareas = figure._themeable['legend_title'] for ta in textareas: ta.set_visible(False)
[docs]class legend_text_legend(themeable): """ Legend text for the common legend Parameters ---------- theme_element : element_text Notes ----- This themeable exists mainly to cater for differences in how the text is aligned, compared to the colorbar. Unless you experience those alignment issues (i.e when using parameters **va** or **ha**), you should use :class:`legend_text`. """ def apply_figure(self, figure): super(legend_text_legend, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): texts = figure._themeable['legend_text_legend'] for text in texts: if not hasattr(text, '_x'): # textarea text = text._text text.set(**properties) def blank_figure(self, figure): super(legend_text_legend, self).blank_figure(figure) with suppress(KeyError): texts = figure._themeable['legend_text_legend'] for text in texts: text.set_visible(False)
[docs]class legend_text_colorbar(themeable): """ Colorbar text Parameters ---------- theme_element : element_text Notes ----- This themeable exists mainly to cater for differences in how the text is aligned, compared to the entry based legend. Unless you experience those alignment issues (i.e when using parameters **va** or **ha**), you should use :class:`legend_text`. """ def apply_figure(self, figure): super(legend_text_colorbar, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): texts = figure._themeable['legend_text_colorbar'] for text in texts: if not hasattr(text, '_x'): # textarea text = text._text text.set(**properties) def blank_figure(self, figure): super(legend_text_colorbar, self).blank_figure(figure) with suppress(KeyError): texts = figure._themeable['legend_text_colorbar'] for text in texts: text.set_visible(False)
legend_text_colourbar = legend_text_colorbar
[docs]class legend_text(legend_text_legend, legend_text_colorbar): """ Legend text Parameters ---------- theme_element : element_text """
[docs]class plot_title(themeable): """ Plot title Parameters ---------- theme_element : element_text """ def apply_figure(self, figure): super(plot_title, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): text = figure._themeable['plot_title'] text.set(**properties) def blank_figure(self, figure): super(plot_title, self).blank_figure(figure) with suppress(KeyError): text = figure._themeable['plot_title'] text.set_visible(False)
[docs]class strip_text_x(themeable): """ Facet labels along the horizontal axis Parameters ---------- theme_element : element_text """ def apply_figure(self, figure): super(strip_text_x, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): texts = figure._themeable['strip_text_x'] for text in texts: text.set(**properties) with suppress(KeyError): rects = figure._themeable['strip_background_x'] for rect in rects: rect.set_visible(True) def blank_figure(self, figure): super(strip_text_x, self).blank_figure(figure) with suppress(KeyError): texts = figure._themeable['strip_text_x'] for text in texts: text.set_visible(False) with suppress(KeyError): rects = figure._themeable['strip_background_x'] for rect in rects: rect.set_visible(False)
[docs]class strip_text_y(themeable): """ Facet labels along the vertical axis Parameters ---------- theme_element : element_text """ def apply_figure(self, figure): super(strip_text_y, self).apply_figure(figure) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] with suppress(KeyError): texts = figure._themeable['strip_text_y'] for text in texts: text.set(**properties) with suppress(KeyError): rects = figure._themeable['strip_background_y'] for rect in rects: rect.set_visible(True) def blank_figure(self, figure): super(strip_text_y, self).blank_figure(figure) with suppress(KeyError): texts = figure._themeable['strip_text_y'] for text in texts: text.set_visible(False) with suppress(KeyError): rects = figure._themeable['strip_background_y'] for rect in rects: rect.set_visible(False)
[docs]class strip_text(strip_text_x, strip_text_y): """ Facet labels along both axes Parameters ---------- theme_element : element_text """ pass
[docs]class title(axis_title, legend_title, plot_title): """ All titles on the plot Parameters ---------- theme_element : element_text """ pass
[docs]class axis_text_x(themeable): """ x-axis tick labels Parameters ---------- theme_element : element_text """ def apply(self, ax): super(axis_text_x, self).apply(ax) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] labels = ax.get_xticklabels() for l in labels: l.set(**properties) def blank(self, ax): super(axis_text_x, self).blank(ax) ax.xaxis.set_tick_params( which='both', labelbottom=False, labeltop=False )
[docs]class axis_text_y(themeable): """ y-axis tick labels Parameters ---------- theme_element : element_text """ def apply(self, ax): super(axis_text_y, self).apply(ax) properties = self.properties.copy() with suppress(KeyError): del properties['margin'] labels = ax.get_yticklabels() for l in labels: l.set(**properties) def blank(self, ax): super(axis_text_y, self).blank(ax) ax.yaxis.set_tick_params( which='both', labelleft=False, labelright=False )
[docs]class axis_text(axis_text_x, axis_text_y): """ Axis tick labels Parameters ---------- theme_element : element_text """ pass
[docs]class text(axis_text, legend_text, strip_text, title): """ All text elements in the plot Parameters ---------- theme_element : element_text """ @property def rcParams(self): rcParams = super(text, self).rcParams family = self.properties.get('family') style = self.properties.get('style') weight = self.properties.get('weight') size = self.properties.get('size') color = self.properties.get('color') if family: rcParams['font.family'] = family if style: rcParams['font.style'] = style if weight: rcParams['font.weight'] = weight if size: rcParams['font.size'] = size rcParams['xtick.labelsize'] = size rcParams['ytick.labelsize'] = size rcParams['legend.fontsize'] = size if color: rcParams['text.color'] = color return rcParams
# element_line themeables
[docs]class axis_line_x(themeable): """ x-axis line Parameters ---------- theme_element : element_line """ position = 'bottom' def apply(self, ax): super(axis_line_x, self).apply(ax) with suppress(KeyError): del self.properties['solid_capstyle'] ax.spines['top'].set_visible(False) ax.spines['bottom'].set(**self.properties) def blank(self, ax): super(axis_line_x, self).blank(ax) ax.spines['top'].set_visible(False) ax.spines['bottom'].set_visible(False)
[docs]class axis_line_y(themeable): """ y-axis line Parameters ---------- theme_element : element_line """ position = 'left' def apply(self, ax): super(axis_line_y, self).apply(ax) with suppress(KeyError): del self.properties['solid_capstyle'] ax.spines['right'].set_visible(False) ax.spines['left'].set(**self.properties) def blank(self, ax): super(axis_line_y, self).blank(ax) ax.spines['left'].set_visible(False) ax.spines['right'].set_visible(False)
[docs]class axis_line(axis_line_x, axis_line_y): """ x & y axis lines Parameters ---------- theme_element : element_line """ pass
[docs]class axis_ticks_minor_x(themeable): """ x-axis tick lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(axis_ticks_minor_x, self).apply(ax) d = deepcopy(self.properties) with suppress(KeyError): d['markeredgewidth'] = d.pop('linewidth') for tick in ax.xaxis.get_minor_ticks(): tick.tick1line.set(**d) def blank(self, ax): super(axis_ticks_minor_x, self).blank(ax) ax.xaxis.set_tick_params(which='minor', bottom=False)
[docs]class axis_ticks_minor_y(themeable): """ y-axis minor tick lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(axis_ticks_minor_y, self).apply(ax) d = deepcopy(self.properties) with suppress(KeyError): d['markeredgewidth'] = d.pop('linewidth') for tick in ax.yaxis.get_minor_ticks(): tick.tick1line.set(**d) def blank(self, ax): super(axis_ticks_minor_y, self).blank(ax) ax.yaxis.set_tick_params(which='minor', left=False)
[docs]class axis_ticks_major_x(themeable): """ x-axis major tick lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(axis_ticks_major_x, self).apply(ax) d = deepcopy(self.properties) del d['visible'] with suppress(KeyError): d['markeredgewidth'] = d.pop('linewidth') for tick in ax.xaxis.get_major_ticks(): tick.tick1line.set(**d) def blank(self, ax): super(axis_ticks_major_x, self).blank(ax) ax.xaxis.set_tick_params(which='major', bottom=False)
[docs]class axis_ticks_major_y(themeable): """ y-axis major tick lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(axis_ticks_major_y, self).apply(ax) d = deepcopy(self.properties) del d['visible'] with suppress(KeyError): d['markeredgewidth'] = d.pop('linewidth') for tick in ax.yaxis.get_major_ticks(): tick.tick1line.set(**d) def blank(self, ax): super(axis_ticks_major_y, self).blank(ax) ax.yaxis.set_tick_params(which='major', left=False)
[docs]class axis_ticks_major(axis_ticks_major_x, axis_ticks_major_y): """ x & y axis major tick lines Parameters ---------- theme_element : element_line """ pass
[docs]class axis_ticks_minor(axis_ticks_minor_x, axis_ticks_minor_y): """ x & y axis minor tick lines Parameters ---------- theme_element : element_line """ pass
[docs]class axis_ticks(axis_ticks_major, axis_ticks_minor): """ x & y major and minor axis tick lines Parameters ---------- theme_element : element_line """ pass
[docs]class panel_grid_major_x(themeable): """ Vertical major grid lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(panel_grid_major_x, self).apply(ax) ax.xaxis.grid(which='major', **self.properties) def blank(self, ax): super(panel_grid_major_x, self).blank(ax) ax.grid(False, which='major', axis='x')
[docs]class panel_grid_major_y(themeable): """ Horizontal major grid lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(panel_grid_major_y, self).apply(ax) ax.yaxis.grid(which='major', **self.properties) def blank(self, ax): super(panel_grid_major_y, self).blank(ax) ax.grid(False, which='major', axis='y')
[docs]class panel_grid_minor_x(themeable): """ Vertical minor grid lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(panel_grid_minor_x, self).apply(ax) ax.xaxis.grid(which='minor', **self.properties) def blank(self, ax): super(panel_grid_minor_x, self).blank(ax) ax.grid(False, which='minor', axis='x')
[docs]class panel_grid_minor_y(themeable): """ Horizontal minor grid lines Parameters ---------- theme_element : element_line """ def apply(self, ax): super(panel_grid_minor_y, self).apply(ax) ax.yaxis.grid(which='minor', **self.properties) def blank(self, ax): super(panel_grid_minor_y, self).blank(ax) ax.grid(False, which='minor', axis='y')
[docs]class panel_grid_major(panel_grid_major_x, panel_grid_major_y): """ Major grid lines Parameters ---------- theme_element : element_line """ pass
[docs]class panel_grid_minor(panel_grid_minor_x, panel_grid_minor_y): """ Minor grid lines Parameters ---------- theme_element : element_line """ pass
[docs]class panel_grid(panel_grid_major, panel_grid_minor): """ Grid lines Parameters ---------- theme_element : element_line """ pass
[docs]class line(axis_line, axis_ticks, panel_grid): """ All line elements Parameters ---------- theme_element : element_line """ @property def rcParams(self): rcParams = super(line, self).rcParams color = self.properties.get('color') linewidth = self.properties.get('linewidth') linestyle = self.properties.get('linestyle') d = {} if color: d['axes.edgecolor'] = color d['xtick.color'] = color d['ytick.color'] = color d['grid.color'] = color if linewidth: d['axes.linewidth'] = linewidth d['xtick.major.width'] = linewidth d['xtick.minor.width'] = linewidth d['ytick.major.width'] = linewidth d['ytick.minor.width'] = linewidth d['grid.linewidth'] = linewidth if linestyle: d['grid.linestyle'] = linestyle rcParams.update(d) return rcParams
# element_rect themeables
[docs]class legend_key(themeable): """ Legend key background Parameters ---------- theme_element : element_rect """ def apply_figure(self, figure): super(legend_key, self).apply_figure(figure) with suppress(KeyError): # list of lists all_drawings = figure._themeable['legend_key'] for drawings in all_drawings: for da in drawings: da.patch.set(**self.properties) def blank_figure(self, figure): super(legend_key, self).blank_figure(figure) with suppress(KeyError): # list of lists all_drawings = figure._themeable['legend_key'] for drawings in all_drawings: for da in drawings: _blankout_rect(da.patch)
[docs]class legend_background(themeable): """ Legend background Parameters ---------- theme_element : element_rect """ def apply_figure(self, figure): super(legend_background, self).apply_figure(figure) # anchored offset box with suppress(KeyError): aob = figure._themeable['legend_background'] aob.patch.set(**self.properties) if self.properties: aob._drawFrame = True # some small sensible padding if not aob.pad: aob.pad = .2 def blank_figure(self, figure): super(legend_background, self).blank_figure(figure) with suppress(KeyError): aob = figure._themeable['legend_background'] _blankout_rect(aob.patch)
[docs]class legend_box_background(themeable): """ Legend box background Parameters ---------- theme_element : element_rect Notes ----- Not Implemented. We would have to place the outermost VPacker/HPacker boxes that hold the individual legends onto an object that has a patch. """
[docs]class panel_background(themeable): """ Panel background Parameters ---------- theme_element : element_rect """ def apply(self, ax): super(panel_background, self).apply(ax) d = deepcopy(self.properties) if 'facecolor' in d and 'alpha' in d: d['facecolor'] = to_rgba(d['facecolor'], d['alpha']) del d['alpha'] ax.patch.set(**d) def blank(self, ax): super(panel_background, self).blank(ax) _blankout_rect(ax.patch)
[docs]class panel_border(themeable): """ Panel border Parameters ---------- theme_element : element_rect """ def apply(self, ax): super(panel_border, self).apply(ax) d = deepcopy(self.properties) # Be lenient, if using element_line with suppress(KeyError): d['edgecolor'] = d.pop('color') with suppress(KeyError): del d['facecolor'] if 'edgecolor' in d and 'alpha' in d: d['edgecolor'] = to_rgba(d['edgecolor'], d['alpha']) del d['alpha'] ax.patch.set(**d) def blank(self, ax): super(panel_border, self).blank(ax) ax.patch.set_linewidth(0)
[docs]class plot_background(themeable): """ Plot background Parameters ---------- theme_element : element_rect """ def apply_figure(self, figure): figure.patch.set(**self.properties) def blank_figure(self, figure): super(plot_background, self).blank_figure(figure) _blankout_rect(figure.patch)
[docs]class strip_background_x(themeable): """ Horizontal facet label background Parameters ---------- theme_element : element_rect """ def apply_figure(self, figure): super(strip_background_x, self).apply_figure(figure) with suppress(KeyError): bboxes = figure._themeable['strip_background_x'] for bbox in bboxes: bbox.set(**self.properties) def blank_figure(self, figure): super(strip_background_x, self).blank_figure(figure) with suppress(KeyError): rects = figure._themeable['strip_background_x'] for rect in rects: _blankout_rect(rect)
[docs]class strip_background_y(themeable): """ Vertical facet label background Parameters ---------- theme_element : element_rect """ def apply_figure(self, figure): super(strip_background_y, self).apply_figure(figure) with suppress(KeyError): bboxes = figure._themeable['strip_background_y'] for bbox in bboxes: bbox.set(**self.properties) def blank_figure(self, figure): super(strip_background_y, self).blank_figure(figure) with suppress(KeyError): rects = figure._themeable['strip_background_y'] for rect in rects: _blankout_rect(rect)
[docs]class strip_background(strip_background_x, strip_background_y): """ Facet label background Parameters ---------- theme_element : element_rect """ pass
[docs]class rect(legend_key, legend_background, panel_background, panel_border, plot_background, strip_background): """ All rectangle elements Parameters ---------- theme_element : element_rect """ pass
# value base themeables
[docs]class axis_ticks_length_major(themeable): """ Axis major-tick length Parameters ---------- theme_element : float Value in points. """ @property def rcParams(self): rcParams = super(axis_ticks_length_major, self).rcParams val = self.properties['value'] rcParams['xtick.major.size'] = val rcParams['ytick.major.size'] = val return rcParams
[docs]class axis_ticks_length_minor(themeable): """ Axis minor-tick length Parameters ---------- theme_element : float Value in points. """ @property def rcParams(self): rcParams = super(axis_ticks_length_minor, self).rcParams val = self.properties['value'] rcParams['xtick.minor.size'] = val rcParams['ytick.minor.size'] = val return rcParams
[docs]class axis_ticks_length(axis_ticks_length_major, axis_ticks_length_minor): """ Axis tick length Parameters ---------- theme_element : float Value in points. """ pass
[docs]class axis_ticks_pad_major(themeable): """ Axis major-tick padding Parameters ---------- theme_element : float Value in points. """ @property def rcParams(self): rcParams = super(axis_ticks_pad_major, self).rcParams val = self.properties['value'] rcParams['xtick.major.pad'] = val rcParams['ytick.major.pad'] = val return rcParams
[docs]class axis_ticks_pad_minor(themeable): """ Axis minor-tick padding Parameters ---------- theme_element : float """ @property def rcParams(self): rcParams = super(axis_ticks_pad_minor, self).rcParams val = self.properties['value'] rcParams['xtick.minor.pad'] = val rcParams['ytick.minor.pad'] = val return rcParams
[docs]class axis_ticks_pad(axis_ticks_pad_major, axis_ticks_pad_minor): """ Axis tick padding Parameters ---------- theme_element : float Value in points. """ pass
[docs]class axis_ticks_direction_x(themeable): """ x-axis tick direction Parameters ---------- theme_element : str in ``['in', 'out', 'inout']`` - ``in`` - ticks inside the panel - ``out`` - ticks outside the panel - ``inout`` - ticks inside and outside the panel """ @property def rcParams(self): rcParams = super(axis_ticks_direction_x, self).rcParams rcParams['xtick.direction'] = self.properties['value'] return rcParams
[docs]class axis_ticks_direction_y(themeable): """ y-axis tick direction Parameters ---------- theme_element : str in ``['in', 'out', 'inout']`` - ``in`` - ticks inside the panel - ``out`` - ticks outside the panel - ``inout`` - ticks inside and outside the panel """ @property def rcParams(self): rcParams = super(axis_ticks_direction_y, self).rcParams rcParams['ytick.direction'] = self.properties['value'] return rcParams
[docs]class axis_ticks_direction(axis_ticks_direction_x, axis_ticks_direction_y): """ axis tick direction Parameters ---------- theme_element : {'in', 'out', 'inout'} - ``in`` - ticks inside the panel - ``out`` - ticks outside the panel - ``inout`` - ticks inside and outside the panel """ pass
[docs]class panel_spacing_x(themeable): """ Horizontal spacing betweend the facet panels Parameters ---------- theme_element : float Size in inches of the horizontal margins between the facet panels. """ pass
[docs]class panel_spacing_y(themeable): """ Vertical spacing between the facet panels Parameters ---------- theme_element : float Size in inches of the vertical space between the facet panels """ pass
[docs]class panel_spacing(panel_spacing_x, panel_spacing_y): """ Spacing between the facet panels Parameters ---------- theme_element : float Size in inches of the space between the facet panels """ pass
[docs]class plot_margin(themeable): """ Plot Margin Parameters ---------- theme_element : float Must be in the [0, 1] range. It is specified as a fraction of the figure width and figure height. Values outside that range will stretch the figure. """ def setup_figure(self, figure): val = self.properties['value'] if val is not None: figure.subplots_adjust(left=val, right=1-val, bottom=val, top=1-val)
[docs]class panel_ontop(themeable): """ Place panel background & gridlines over/under the data layers Parameters ---------- theme_element : bool Default is False. """ def apply(self, ax): super(panel_ontop, self).apply(ax) ax.set_axisbelow(self.properties['value'])
[docs]class aspect_ratio(themeable): """ Aspect ratio of the panel(s) Parameters ---------- theme_element : float `panel_height / panel_width` Notes ----- For a fixed relationship between the ``x`` and ``y`` scales, use :class:`~plotnine.coords.coord_fixed`. """
[docs]class dpi(themeable): """ DPI with which to draw/save the figure Parameters ---------- theme_element : int """ @property def rcParams(self): rcParams = super(dpi, self).rcParams val = self.properties['value'] rcParams['figure.dpi'] = val rcParams['savefig.dpi'] = 'figure' return rcParams
[docs]class figure_size(themeable): """ Figure size in inches Parameters ---------- theme_element : tuple (width, height) in inches """ @property def rcParams(self): rcParams = super(figure_size, self).rcParams try: width, height = self.properties['value'] except ValueError: raise PlotnineError( 'figure_size should be a tuple (width, height) ' 'with the values in inches') rcParams['figure.figsize'] = '{}, {}'.format(width, height) return rcParams
[docs]class subplots_adjust(themeable): """ Adjust position of subplots on in the figure Useful if part of the plot (most likely the legend) are cut off. Full access to the underlying Matplolib subplot adjustment parameters Parameters ---------- theme_element : dict See :class:`matplotlib.figure.SubplotParams` for the keys that the dictionary *can* have. """ def apply_figure(self, figure): params = self.properties['value'] figure.subplots_adjust( wspace=params.get('wspace', None), hspace=params.get('hspace', None), ) def setup_figure(self, figure): params = self.properties['value'] figure.subplots_adjust( left=params.get('left', None), right=params.get('right', None), top=params.get('top', None), bottom=params.get('bottom', None), )
# Deprecated class facet_spacing(subplots_adjust): def __init__(self, *args, **kwargs): from warnings import warn warn("'facet_spacing' has been renamed to " "'subplots_adjust' and it will be removed " "in the future.", FutureWarning) super(facet_spacing, self).__init__(*args, **kwargs)
[docs]class legend_box(themeable): """ How to box up multiple legends Parameters ---------- theme_element : str in ``['vertical', 'horizontal']`` Whether to stack up the legends vertically or horizontally. """
[docs]class legend_box_margin(themeable): """ Padding between the legends and the box Parameters ---------- theme_element : int Value in points. """
[docs]class legend_box_just(themeable): """ Justification of legend boxes Parameters ---------- theme_element : str One of *left*, *right*, *center*, *top* or *bottom* depending the value of :class:`legend_box`. """
[docs]class legend_direction(themeable): """ Layout items in the legend Parameters ---------- theme_element : str in ``['vertical', 'horizontal']`` Vertically or horizontally """
[docs]class legend_key_width(themeable): """ Legend key background width Parameters ---------- theme_element : float Value in points """
[docs]class legend_key_height(themeable): """ Legend key background height Parameters ---------- theme_element : float Value in points. """
[docs]class legend_key_size(legend_key_width, legend_key_height): """ Legend key background width and height Parameters ---------- theme_element : float Value in points. """
[docs]class legend_margin(themeable): """ Padding between the legend the inner box Parameters ---------- theme_element : float Value in points """
[docs]class legend_box_spacing(themeable): """ Spacing between legend and the anchor point Parameters ---------- theme_element : float Value in inches. """
[docs]class legend_spacing(themeable): """ Spacing between two adjacent legends Parameters ---------- theme_element : float Value in points. """
[docs]class legend_position(themeable): """ Location of legend Parameters ---------- theme_element : str or tuple If a string it should be one of *right*, *left*, *top* *bottom* or *none*. If a tuple, it should be two floats each in the approximate range [0, 1]. The tuple specifies the location of the legend in screen coordinates. """
[docs]class legend_title_align(themeable): """ Alignment of legend title Parameters ---------- theme_element : str or tuple If a string it should be one of *right*, *left*, *center*, *top* or *bottom*. """
[docs]class legend_entry_spacing_x(themeable): """ Horizontal spacing between two entries in a legend Parameters ---------- theme_element : float Size in points """
[docs]class legend_entry_spacing_y(themeable): """ Vertical spacing between two entries in a legend Parameters ---------- theme_element : float Size in points """
[docs]class legend_entry_spacing(legend_entry_spacing_x, legend_entry_spacing_y): """ Spacing between two entries in a legend Parameters ---------- theme_element : float Size in points """
[docs]class strip_margin_x(themeable): """ Vertical margin between the strip background and the panel border Parameters ---------- theme_element : float Value as a proportion of the strip size. A good value should be the range :math:`[-1, 0.5]`. A negative value puts the strip inside the axes and a positive value creates a space between the strip and the axes. """
[docs]class strip_margin_y(themeable): """ Horizontal margin between the strip background and the panel border Parameters ---------- theme_element : float Value as a proportion of the strip size. A good value should be the range :math:`[-1, 0.5]`. A negative value puts the strip inside the axes and a positive value creates a space between the strip and the axes. """
[docs]class strip_margin(strip_margin_x, strip_margin_y): """ Margin between the strip background and the panel border Parameters ---------- theme_element : float Value as a proportion of the strip size. A good value should be the range :math:`[-1, 0.5]`. A negative value puts the strip inside the axes and a positive value creates a space between the strip and the axes. """