plotnine.geoms.geom_ribbon

class plotnine.geoms.geom_ribbon(mapping: Aes | None = None, data: DataLike | None = None, **kwargs: Any)[source]

Ribbon plot

Usage

geom_ribbon(mapping=None, data=None, stat='identity', position='identity',
            na_rm=False, inherit_aes=True, show_legend=None, raster=False,
            outline_type='both', **kwargs)

Only the data and mapping 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

x

ymax

ymin

alpha

1

color

'none'

fill

'#333333'

group

linetype

'solid'

size

0.5

where

True

The bold aesthetics are required.

Aesthetics Descriptions

where

Define where to exclude horizontal regions from being filled. Regions between any two False values are skipped. For sensible demarcation the value used in the where predicate expression should match the ymin value or expression. i.e.

aes(ymin=0, ymax='col1', where='col1 > 0')  # good
aes(ymin=0, ymax='col1', where='col1 > 10')  # bad

aes(ymin=col2, ymax='col1', where='col1 > col2')  # good
aes(ymin=col2, ymax='col1', where='col1 > col3')  # bad
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.

rasterbool, optional (default: False)

If True, draw onto this layer a raster (bitmap) object even ifthe final image is in vector format.

outline_type'upper' | 'lower' | 'both' | 'full'
How to stroke to outline of the region / area.

  • 'upper' - draw only upper bounding line'

  • 'lower' - draw only lower bounding line'

  • 'both' - draw both upper & lower bounding lines

  • 'full' - draw closed polygon around the area.