inset_outsets

inset_outsets(outset_grid: OutsetGrid, insets: Literal['NE', 'NW', 'SE', 'SW'] | Sequence[Tuple[float, float, float, float]] = 'NE', *, equalize_aspect: bool = True, strip_axes: bool = False, strip_labels: bool = True, strip_spines: bool = False, strip_ticks: bool = True, strip_titles: bool = True) → None[source]

Rearrange OutsetGrid figure to superimpose outset axes over source axes.

Parameters:

  • outset_grid (OutsetGrid) – OutsetGrid to transform.

  • insets (Union[Literal["NE", "NW", "SE", "SW"], Sequence[Tuple[float,) –

  • float –

    Where to place outset plots over source plot.

    If “NE”, “NW”, “SE”, or “SW”, the outset plots will be inset in the specified corner of the grid. Alternately, inset positioning can be specified directly by providing a sequence of tuples (x0, y0, width, height) for the position of each plot in fractional coordinates of sourceplot.

  • float –

    Where to place outset plots over source plot.

    If “NE”, “NW”, “SE”, or “SW”, the outset plots will be inset in the specified corner of the grid. Alternately, inset positioning can be specified directly by providing a sequence of tuples (x0, y0, width, height) for the position of each plot in fractional coordinates of sourceplot.

  • float]]] –

    Where to place outset plots over source plot.

    If “NE”, “NW”, “SE”, or “SW”, the outset plots will be inset in the specified corner of the grid. Alternately, inset positioning can be specified directly by providing a sequence of tuples (x0, y0, width, height) for the position of each plot in fractional coordinates of sourceplot.

  • "NW" (deefault) –

    Where to place outset plots over source plot.

    If “NE”, “NW”, “SE”, or “SW”, the outset plots will be inset in the specified corner of the grid. Alternately, inset positioning can be specified directly by providing a sequence of tuples (x0, y0, width, height) for the position of each plot in fractional coordinates of sourceplot.

  • equalize_aspect (bool, default True) – Should the aspect ratio of the inset plots be equalized?

  • strip_label (bool, default True) – Should x and y labels be stripped from inset plots.

  • strip_spines (bool, default False) – Should removes the spines of the inset plots.

  • strip_ticks (bool, default True) – If True, removes the ticks from the inset plots.

  • strip_titles (bool, default True) – If True, removes the title from the inset plots.

Return type:

None

See also

outset.util.layout_corner_insets

Underlying engine implementing corner inset layout when “NE”, “NW”, “SE”, or “SW” is passed to inset_outsets. The function layout_corner_insets can be called directly to provide the insets kwarg to tweak corner inset layouts.