plotnine.geoms.geom_label

class plotnine.geoms.geom_label(mapping=None, data=None, **kwargs)[source]

Textual annotations with a background

Usage

geom_label(mapping=None, data=None, stat='identity', position='identity',
           na_rm=False, inherit_aes=True, show_legend=None, path_effects=None,
           tooth_size=None, label_padding=0.25, boxstyle='round',
           fontweight='normal', nudge_x=0, adjust_text=None,
           fontstyle='normal', label_r=0.25, boxcolor=None, family=None,
           format_string=None, nudge_y=0, label_size=0.7, parse=False,
           **kwargs)

Only the mapping and data can be positional, the rest must be keyword arguments. **kwargs can be aesthetics (or parameters) used by the stat.

Parameters
mappingaes, optional

Aesthetic mappings created with aes(). If specified and inherit.aes=True, it is combined with the default mapping for the plot. You must supply mapping if there is no plot mapping.

Aesthetic

Default value

label

x

y

alpha

1

angle

0

color

'black'

fill

'white'

group

ha

'center'

lineheight

1.2

size

11

va

'center'

The bold aesthetics are required.

Aesthetics Descriptions

ha

Horizontal alignment. One of left, center or right.

va

Vertical alignment. One of top, center, bottom, baseline.

datadataframe, optional

The data to be displayed in this layer. If None, the data from from the ggplot() call is used. If specified, it overrides the data from the ggplot() call.

statstr or stat, optional (default: stat_identity)

The statistical transformation to use on the data for this layer. If it is a string, it must be the registered and known to Plotnine.

positionstr or position, optional (default: position_identity)

Position adjustment. If it is a string, it must be registered and known to Plotnine.

na_rmbool, optional (default: False)

If False, removes missing values with a warning. If True silently removes missing values.

inherit_aesbool, optional (default: True)

If False, overrides the default aesthetics.

show_legendbool or dict, optional (default: None)

Whether this layer should be included in the legends. None the default, includes any aesthetics that are mapped. If a bool, False never includes and True always includes. A dict can be used to exclude specific aesthetis of the layer from showing in the legend. e.g show_legend={'color': False}, any other aesthetic are included by default.

boxstylestr, optional (default: round)

Options are:

'circle'
'darrow'
'larrow'
'rarrow'
'round '
'round4'
'roundtooth'
'sawtooth'
'square'
boxcolor: None, str or rgba tuple (default: None)

Color of box around the text. If None, the color is the same as the text.

label_paddingfloat, optional (default: 0.25)

Amount of padding

label_rfloat, optional (default: 0.25)

Rounding radius of corners.

label_sizefloat, optional (default: 0.7)

Linewidth of the label boundary.

tooth_sizefloat, optional (default: None)

Size of the roundtooth or sawtooth if they are the chosen boxstyle. The default depends on Matplotlib

See also

plotnine.geoms.geom_text

For documentation of the parameters. matplotlib.patches.BoxStyle for the parameters that affect the boxstyle.