Concatenate multiple x-layout
=============================


For situations where a single x-layout is insufficient to demonstrate your data,
you may want to concatenate multiple x-layouts together.

Suppose you have a blue heatmap and a green heatmap, as shown below:

.. plot::
    :context: close-figs

        >>> import marsilea as ma
        >>> data1 = np.random.rand(20, 20)
        >>> h1 = ma.Heatmap(data1, cmap="Blues", width=4, height=4, name="h1")
        >>> h1.add_title(top="Blue", align="left")
        >>> h1.add_legends()
        >>> h1.render()


.. plot::
    :context: close-figs

    >>> data2 = np.random.rand(10,10)
    >>> h2 = ma.Heatmap(data2, cmap="Greens", width=2, height=2, name="h2")
    >>> h2.add_title(top="Green", align="left")
    >>> h2.add_legends()
    >>> h2.render()


To concatenate heatmaps horizontally, simply use the add operator **+**.

.. plot::
    :context: close-figs

    >>> (h1 + h2).render()

But if the heatmaps appear too close together,
you can add space between them by including a number:

.. plot::
    :context: close-figs

    >>> (h1 + .2 + h2).render()

For vertical concatenation, use the divide operator **/**:

.. plot::
    :context: close-figs

    >>> (h1 / .2 / h2).render()

Take note that when concatenating,
the width of the secondary heatmap(s) will be adjusted to match the main heatmap's layout.
For example, the width of :code:`h2` becomes 5 to match :code:`h1`


Legends
-------

Marsilea can effectively rearrange legends from all your heatmaps.

Here, the concatenated result has legends added to the left side using
the :meth:`add_legends() <heatgraphy.base.LegendMaker.add_legends>` method.

.. plot::
    :context: close-figs

    >>> c = (h1 + .2 + h2)
    >>> c.add_legends()
    >>> c.render()


The example also demonstrates how to arrange multiple legends.

.. plot::
    :context: close-figs

        >>> from marsilea.plotter import MarkerMesh
        >>> h1.add_dendrogram("left")
        >>> h2.add_dendrogram("right")
        >>> layer1 = MarkerMesh(data1 > 0.8, color='red', marker='o', label="> 0.8")
        >>> layer2 = MarkerMesh(data2 > 0.5, color='orange', label="> 0.5")
        >>> h1.add_layer(layer1, name='marker1')
        >>> h2.add_layer(layer2, name='marker2')
        >>> c = h1 + .2 + h2
        >>> c.add_legends(side="right", order=["h1", "marker1", "h2", "marker2"],
        ...               stack_by='row', stack_size=2, align_legends='center')
        >>> c.render()