Guides¶

Axis Guides¶

Axis guide helpers can be supplied through position scales, for example scale_x_continuous(guide=guide_axis_manual(...)). The extended facets also apply plot-level guide additions when a matching axis can be inferred.

guide_axis_manual¶

plotnine_extra.guide_axis_manual(breaks=None, labels=None, label_colour=None, label_size=None, title=None, **kwargs)[source]¶

User-supplied axis breaks and labels.

Parameters:

breaks (Sequence | None)
labels (Sequence | None)
label_colour (str | Sequence[str] | None)
label_size (float | Sequence[float] | None)
title (str | None)

Return type:

GuideAxisSpec

guide_axis_colour¶

plotnine_extra.guide_axis_colour(colours=None, **kwargs)[source]¶

Colour axis tick labels individually.

Parameters:: colours (Sequence[str] | None)
Return type:: GuideAxisSpec

guide_axis_color¶

plotnine_extra.guide_axis_color(colours=None, **kwargs)¶

Colour axis tick labels individually.

Parameters:: colours (Sequence[str] | None)
Return type:: GuideAxisSpec

guide_axis_minor¶

plotnine_extra.guide_axis_minor(**kwargs)[source]¶

Render visible minor ticks and optional minor labels.

Return type:: GuideAxisSpec

guide_axis_logticks¶

plotnine_extra.guide_axis_logticks(sides='bl', short=0.5, mid=1.0, long=1.5, **kwargs)[source]¶

Render log-style tick marks on the requested sides.

Parameters:

sides (str)
short (float)
mid (float)
long (float)

Return type:

GuideAxisSpec

guide_axis_truncated¶

plotnine_extra.guide_axis_truncated(trunc_lower=None, trunc_upper=None, **kwargs)[source]¶

Truncate the axis spine to numeric or callable bounds.

Parameters:

trunc_lower (Any | Callable | None)
trunc_upper (Any | Callable | None)

Return type:

GuideAxisSpec

guide_axis_scalebar¶

plotnine_extra.guide_axis_scalebar(size=1.0, label=None, **kwargs)[source]¶

Draw a data-coordinate scalebar with an optional label.

Parameters:

size (float)
label (str | None)

Return type:

GuideAxisSpec

guide_axis_nested¶

plotnine_extra.guide_axis_nested(delim='_', extend=0.1, inv=False, nest_line=True, **kwargs)[source]¶

Multi-level axis labels split by delim.

Parameters:

delim (str)
extend (float)
inv (bool)
nest_line (bool)

Return type:

GuideAxisSpec

guide_dendro¶

plotnine_extra.guide_dendro(dendro=None, position='top', **kwargs)[source]¶

Draw a compact dendrogram aligned to tick order.

Parameters:

dendro (Any | None)
position (str)

Return type:

GuideAxisSpec

Legend Guides¶

guide_stringlegend¶

class plotnine_extra.guide_stringlegend(title=None, theme=<factory>, position=None, direction=None, reverse=False, order=0, nrow=None, ncol=None, byrow=False, override_aes=<factory>)[source]¶

Bases: plotnine.guide_legend

Text-only legend guide.

The guide uses the mapped aesthetic value as the label colour and does not allocate or draw key glyph boxes.

Parameters:

title (Optional[str])
theme (Theme)
position (Optional[LegendPosition])
direction (Optional[Orientation])
reverse (bool)
order (int)
nrow (Optional[int])
ncol (Optional[int])
byrow (bool)
override_aes (dict[str, Any])

setup(guides)[source]¶: Setup guide for drawing process

draw()[source]¶

Draw guide

Returns:: out – A drawing of this legend
Return type:: matplotlib.offsetbox.Offsetbox