.. _`Layout Figures in Subplots`:

.. _`org.sysess.sympathy.visualize.figuresubplot`:

Layout Figures in Subplots
``````````````````````````

.. image:: figuresubplots.svg
   :width: 48


Layout a list of Figures in a Subplot




Documentation
:::::::::::::

Layout the Figures in a list of Figures into subplots.

The number of rows and columns is automatically adjusted to an approximate
square. Empty axes in a non-empty row will be not shown.


Definition
::::::::::


Input ports
...........

    **input**  [figure]
        List of Figures


Output ports
............

    **figure**  figure
        A Figure with several subplot axes




Configuration
.............

    **Number of columns** (columns)
        Specify the number of columns, or 0 for auto.If rows and columns are both 0, the node with attempt to create an approximately square layout.
    **Make parent's colorbar global** (join_colorbars)
        If checked, the colorbar from the parent figure is placed as a global colorbar for all subplots. Note that it is up to you to make sure that the colorbar is actually valid for all subplots.
    **Make parent's legend global** (join_legends)
        If checked, the legend(s) in the first figure are kept as global legends and all other legends are discarded. Note that it is up to you to make sure that the legend is actually valid for all subplots.
    **Parent figure:** (parent_figure)
        Specify the figure from which colorbar and legend are copied.
    **Auto recolor** (recolor)
        Specify if artists should be assigned new colors automatically to prevent duplicate colors.
    **Number of rows** (rows)
        Specify the number of rows, or 0 for auto.If rows and columns are both 0, the node with attempt to create an approximately square layout.
    **Share X axes** (share_x_axes)
        If None, each subplot has an independent X axis. Othewise, subplots will share X axis, meaning that zooming/panning in one subplot also affects other subplots.
    **Share Y axes** (share_y_axes)
        If None, each subplot has an independent Y axis. Othewise, subplots will share Y axis, meaning that zooming/panning in one subplot also affects other subplots.





Related nodes
.............

* :ref:`org.sysess.sympathy.visualize.figure`

* :ref:`org.sysess.sympathy.visualize.figures`

* :ref:`org.sysess.sympathy.visualize.figurecompressorgui`

* :ref:`org.sysess.sympathy.visualize.bokehfigure`




Examples
........

* :download:`Figures.syx </Examples/Sympathy/Visual/Figure/Figures.syx>`




Implementation
..............

.. automodule:: node_figure
    :noindex:

.. class:: SubplotFigures
    :noindex: