plotnine.geoms.geom_label

class plotnine.geoms.geom_label(*args, **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,
           format_string=None, label_r=0.25, label_padding=0.25,
           fontstyle='normal', family=None, label_size=0.7, boxstyle='round',
           nudge_x=0, parse=False, nudge_y=0, ha='center', va='center',
           tooth_size=None, fontweight='normal', **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:
mapping : aes, 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  
lineheight 1.2
size 11

The bold aesthetics are required.

data : dataframe, 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.

stat : str or stat, optional (default: 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.

position : str or position, optional (default: identity)

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

na_rm : bool, optional (default: False)

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

inherit_aes : bool, optional (default: True)

If False, overrides the default aesthetics.

show_legend : bool 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.

boxstyle : str, optional (default: round)

Options are:

'circle'
'darrow'
'larrow'
'rarrow'
'round '
'round4'
'roundtooth'
'sawtooth'
'square'
label_padding : float, optional (default: 0.25)

Amount of padding

label_r : float, optional (default: 0.25)

Rounding radius of corners.

label_size : float, optional (default: 0.7)

Linewidth of the label boundary.

tooth_size : float, 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.
class:matplotlib.patches.BoxStyle for the parameters that affect the boxstyle.