MultiFigure¶

class texfigure.MultiFigure(nrows, ncols, reference='', continuation=False)[source]¶

Bases: _abcoll.Sequence

A Multifigure is a container object for building subfigures from texfigure.Figure classes.

Parameters:

nrows : int

Number of rows for the MultiFigure.

ncols : int

Number of columns for the MultiFigure.

Examples

\begin{pycode}

muti = texfigure.MultiFigure(1,2)

X = [[5,6], [7,8]]
Y = [[1,2], [3,4]]

for x,y in zip(X,Y):
    fig = plt.figure()
    plt.plot(x, y, 'o')

    Fig1 = texfigure.Figure(fig)
    multi.append(Fig)
\end{pycode}

\py|multi|

Attributes

figures	(`numpy.ndarray`) Array holding `texfigure.Figure` objects, has a shape of (nrows, ncols).
caption	(`str`) The caption to use when representing the figure. (Default `Figure reference`)
label	(`str`) The latex label assigned to the figure envrionment. (Default `fig:reference`)
placement	(`str`) The figure envrionment placement value. (Default `h`)
frontmatter	(`str`) LaTeX code included in the first line of the figure environment. (Default `\centering`)

Attributes Summary

fig_str

Methods Summary

Attributes Documentation

fig_str = '\n\\begin{{figure*}}\n {frontmatter}\n {myfig}\n \\caption{{{caption}}}\n \\label{{{label}}}\n\\end{{figure*}}\n'¶

Methods Documentation

append(figure)[source]¶: Add a texfigure.Figure object to the next empty slot in the MultiFigure.