GridSpec
========

.. currentmodule:: ultraplot.gridspec

.. autoclass:: GridSpec
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~GridSpec.bottom
      ~GridSpec.figure
      ~GridSpec.gridheight
      ~GridSpec.gridwidth
      ~GridSpec.hpad
      ~GridSpec.hpad_panel
      ~GridSpec.hpad_total
      ~GridSpec.hratios
      ~GridSpec.hratios_panel
      ~GridSpec.hratios_total
      ~GridSpec.hspace
      ~GridSpec.hspace_panel
      ~GridSpec.hspace_total
      ~GridSpec.left
      ~GridSpec.ncols
      ~GridSpec.ncols_panel
      ~GridSpec.ncols_total
      ~GridSpec.nrows
      ~GridSpec.nrows_panel
      ~GridSpec.nrows_total
      ~GridSpec.panelheight
      ~GridSpec.panelwidth
      ~GridSpec.right
      ~GridSpec.spaceheight
      ~GridSpec.spacewidth
      ~GridSpec.top
      ~GridSpec.wpad
      ~GridSpec.wpad_panel
      ~GridSpec.wpad_total
      ~GridSpec.wratios
      ~GridSpec.wratios_panel
      ~GridSpec.wratios_total
      ~GridSpec.wspace
      ~GridSpec.wspace_panel
      ~GridSpec.wspace_total

   .. rubric:: Methods Summary

   .. autosummary::

      ~GridSpec.copy
      ~GridSpec.get_geometry
      ~GridSpec.get_grid_positions
      ~GridSpec.get_height_ratios
      ~GridSpec.get_panel_geometry
      ~GridSpec.get_subplot_params
      ~GridSpec.get_total_geometry
      ~GridSpec.get_width_ratios
      ~GridSpec.locally_modified_subplot_params
      ~GridSpec.set_height_ratios
      ~GridSpec.set_width_ratios
      ~GridSpec.subgridspec
      ~GridSpec.tight_layout
      ~GridSpec.update

   .. rubric:: Attributes Documentation

   .. autoattribute:: bottom
   .. autoattribute:: figure
   .. autoattribute:: gridheight
   .. autoattribute:: gridwidth
   .. autoattribute:: hpad
   .. autoattribute:: hpad_panel
   .. autoattribute:: hpad_total
   .. autoattribute:: hratios
   .. autoattribute:: hratios_panel
   .. autoattribute:: hratios_total
   .. autoattribute:: hspace
   .. autoattribute:: hspace_panel
   .. autoattribute:: hspace_total
   .. autoattribute:: left
   .. autoattribute:: ncols
   .. autoattribute:: ncols_panel
   .. autoattribute:: ncols_total
   .. autoattribute:: nrows
   .. autoattribute:: nrows_panel
   .. autoattribute:: nrows_total
   .. autoattribute:: panelheight
   .. autoattribute:: panelwidth
   .. autoattribute:: right
   .. autoattribute:: spaceheight
   .. autoattribute:: spacewidth
   .. autoattribute:: top
   .. autoattribute:: wpad
   .. autoattribute:: wpad_panel
   .. autoattribute:: wpad_total
   .. autoattribute:: wratios
   .. autoattribute:: wratios_panel
   .. autoattribute:: wratios_total
   .. autoattribute:: wspace
   .. autoattribute:: wspace_panel
   .. autoattribute:: wspace_total

   .. rubric:: Methods Documentation

   .. automethod:: copy
   .. automethod:: get_geometry
   .. automethod:: get_grid_positions
   .. automethod:: get_height_ratios
   .. automethod:: get_panel_geometry
   .. automethod:: get_subplot_params
   .. automethod:: get_total_geometry
   .. automethod:: get_width_ratios
   .. automethod:: locally_modified_subplot_params
   .. automethod:: set_height_ratios
   .. automethod:: set_width_ratios
   .. automethod:: subgridspec
   .. automethod:: tight_layout
   .. automethod:: update