colour.plotting.decorate

colour.plotting.decorate(**kwargs)

Sets the figure decorations.

Other Parameters:  

• title (unicode, optional) – Figure title.
• x_label (unicode, optional) – X axis label.
• y_label (unicode, optional) – Y axis label.
• legend (bool, optional) – Whether to display the legend. Default is False.
• legend_columns (int, optional) – Number of columns in the legend. Default is 1.
• legend_location (unicode, optional) – Matplotlib legend location. Default is upper right.
• x_ticker (bool, optional) – Whether to display the X axis ticker. Default is True.
• y_ticker (bool, optional) – Whether to display the Y axis ticker. Default is True.
• x_ticker_locator (Locator, optional) – Locator type for the X axis ticker.
• y_ticker_locator (Locator, optional) – Locator type for the Y axis ticker.
• grid (bool, optional) – Whether to display the grid. Default is False.
• grid_which (unicode, optional) – Controls whether major tick grids, minor tick grids, or both are affected. Default is both.
• grid_axis (unicode, optional) – Controls which set of grid-lines are drawn. Default is both.
• x_axis_line (bool, optional) – Whether to draw the X axis line. Default is False.
• y_axis_line (bool, optional) – Whether to draw the Y axis line. Default is False.
• aspect (unicode, optional) – Matplotlib axes aspect.
• no_axes (bool, optional) – Whether to turn off the axes. Default is False.

Returns:

Current axes.

Return type:

Axes