gpe.plot_utils
==============

.. py:module:: gpe.plot_utils


Attributes
----------

.. autoapisummary::

   gpe.plot_utils.hv


Classes
-------

.. autoapisummary::

   gpe.plot_utils.MPLFigure
   gpe.plot_utils.MPLGrid


Module Contents
---------------

.. py:data:: hv

.. py:class:: MPLFigure(data, **kwargs)

   Bases: :py:obj:`hv`


   Wraps a matplotlib figure.


.. py:class:: MPLGrid(fig=None, subplot_spec=None, ax=None, direction='down', right=False, scale=True, space=None, share=False, size=1, **kw)

   Object for stacking plots.

   After initializing the object, call next() to get the next axis.  By
   default axes will stack vertically.

   .. attribute:: down

      If True, then stack elements vertically growing down.  Otherwise stack
      elements horizontally growing right.

      :type: bool

   .. attribute:: ratios

      List of relative size of each entry.

      :type: [float]

   .. attribute:: axes

      List of axes of nested grid objects.

      :type: [Axes, MPLGrid]

   .. attribute:: direction

      Direction of growth.

      :type: ['down', 'right']

   .. attribute:: right

      Specify if y axis labels should be on the right or left.

      :type: bool

   .. attribute:: scale

      If False, then when a parent MPLGrid is being adjusted, the ratio for
      this grid component will be the sum of the ratios rather than the
      specified parent ratio.  If True, then all the components will be
      scaled to fit into the parents ratio.

      :type: bool

   .. attribute:: share

      If `True`, then axes in the growth direction are shared, and tick labels
      etc. are suppressed except for the final one.

      :type: bool

   .. attribute:: space

      Space (hspace or wspace) between grids.  If this is None, then the space
      is set of zero if the axes are shared and 0.1 otherwise.

      :type: float, None

   .. attribute:: size

      Default size for new elements.

      :type: float


   .. py:attribute:: fig
      :value: None



   .. py:attribute:: subplot_spec
      :value: None



   .. py:attribute:: shape
      :value: [0, 0]



   .. py:attribute:: kw


   .. py:attribute:: right
      :value: False



   .. py:attribute:: share
      :value: False



   .. py:attribute:: direction
      :value: 'down'



   .. py:attribute:: _ratios
      :value: []



   .. py:attribute:: axes
      :value: []



   .. py:attribute:: space
      :value: None



   .. py:attribute:: scale
      :value: True



   .. py:attribute:: size
      :value: 1



   .. py:method:: __getitem__(key)


   .. py:method:: adjust()

      Adjust the positions of all the axes.



   .. py:method:: __repr__()


   .. py:property:: ratios

      Return the size ratios for the various axes.

      If the sub-axis is an MPLGrid instance with scale == False, then the
      ratio is the sum of the sub-grid's ratios.


   .. py:property:: _gridspec


   .. py:method:: next(size=None)

      Return the next axis.



   .. py:method:: empty(size=None)

      Return the next axis but hide it so it acts as a space.



   .. py:method:: grid(size=None, **kw)

      Insert a sub-grid and return it.



   .. py:method:: rescale(tight=None, scalex=True, scaley=True, force=False)