marsilea.base.CompositeBoard#

class CompositeBoard(main_board, keep_legends=False, align_main=True, margin=0)#

Bases: LegendMaker

Layout multiple canvas

Parameters:
main_boardWhiteBoard or ClusterBoard

The main canvas

keep_legendsbool, default: False

Whether to keep the legends in each canvas If False, you can group all legends with .add_legends()

align_mainbool, default: True

Whether to force the size of other canvas to align with the main canvas

marginfloat, default: 0

The margin space reserved around the whole canvas

append(side, other, pad=0)#
figure = None#
get_ax(board_name, ax_name)#
get_main_ax(name)#
layout = None#
new_board(board)#
save(fname, **kwargs)#
set_margin(margin)#