Skip to content

Commit 4aa5c56

Browse files
committed
docs(inset): document align_to="footer"
1 parent fcc8106 commit 4aa5c56

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

plotnine/composition/_inset_element.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ class inset_element:
4848
- `"plot"` — the panel plus axes, labels, titles, captions
4949
and legends
5050
- `"full"` — everything the host plot occupies plus plot margin
51+
- `"footer"` — the footer band at the bottom of the plot. Only
52+
non-degenerate when the host has footer text (set with
53+
`labs(footer=...)`); without it the band has zero height, the
54+
inset is skipped, and a warning is issued. The band does not
55+
grow to fit a taller inset — the inset overflows beyond it
56+
instead.
5157
on_top :
5258
When `True` (default) the inset paints above the host plot.
5359
When `False`, the inset paints between the host's

0 commit comments

Comments
 (0)