figureflow.figure_panel.FigurePanel.label_images

figureflow.figure_panel.FigurePanel.label_images = <function FigurePanel.label_images>

Label images in panel. If no texts are supplied, images will be labeled with incrementing numbers.

Parameters:
  • texts – Text that should be used as labels; should match the number of different values in the defined category Same labels that are adjacent are only labeled once across all affected images

  • text_prefix – If texts is None, what text should be added in front of incrementing numbers

  • site – String of site at image grid at which labels should be adde (“top”, “bottom”, “left” or “right”). Depending on the dimension (columns or rows) in which the category is, top/bottom (for columns) might is better for left/right (for rows).

  • label_sub_remapped – Whether the new image numbers after remapped accoding to defined _sub categories should be used (if True) or whether original image numbers should be used (if False)

  • font_size – font_size of labels; if None default for figure_panel will be used

  • padding – Padding in pt of labels from images

  • font_size_factor – Factor by which the default font_size should be scaled to obtain font size for labels

  • label_orientation – “hor” or “vert” default is horizontal for “top” and “bottom” site and vertical for “left” and “right” site