layout_corner_insets

layout_corner_insets(num_insets: int, corner: Literal['NE', 'NW', 'SE', 'SW'] = 'NE', *, inset_grid_size: Tuple[float, float] | float = 0.5, inset_margin_size: Tuple[float, float] | float = 0.1, inset_pad_ratio: Tuple[float, float] | float = 0.1, transpose: bool = False) List[Tuple[float, float, float, float]][source]

Lay out positions for n inset plots in a specified corner.

The frames are filled from the chosen corner outwards, filling successive diagonals perpendicular to the cornder. Inset subfigure positions are ordered so that inset number increases left-to-right, top-to-bottom.

Parameters:
  • num_insets (int) – The number of inset plots to be generated.

  • corner (Literal["NE", "NW", "SE", "SW"], default "NE") – The corner of the grid where the insets will be positioned.

  • inset_margin_size (Union[Tuple[float, float], float], default 0.5) – How far should grid be spaced from source plot boundaries, relative to the source plot size?

  • inset_grid_size (Union[Tuple[float, float], float], default 0.5) – The size of the grid of inset plots relative to the source plot.

  • inset_pad_ratio (Union[Tuple[float, float], float], default 0.1) – Pad size between inset plots as a fraction of inset plot size.

  • transpose (bool, default False) – Should inset grid layout be ordered top-to-bottom, left-to-right?

Returns:

A list of tuples, each representing (x, y, width, height) of an inset plot fractionally relative to source plot axes.

Return type:

List[Tuple[float, float, float, float]]

See also

outset.util.inset_outsets

Manipulates plot structure to apply corner inset layout calculated by layout_corner_insets, placing outset plots in specified positions over the source plot axes.