geom_band#

geom_band(mapping=None, *, data=None, stat=None, position=None, show_legend=None, inherit_aes=None, sampling=None, tooltips=None, color_by=None, fill_by=None, **other_args)#

Add a straight vertical or horizontal band to the plot.

Parameters:
mappingFeatureSpec

Set of aesthetic mappings created by aes() function. Aesthetic mappings describe the way that variables in the data are mapped to plot “aesthetics”.

datadict or Pandas or Polars DataFrame

The data to be displayed in this layer. If None, the default, the data is inherited from the plot data as specified in the call to ggplot.

statstr, default=’identity’

The statistical transformation to use on the data for this layer, as a string.

positionstr or FeatureSpec, default=’identity’

Position adjustment. Either a position adjustment name: ‘dodge’, ‘dodgev’, ‘jitter’, ‘nudge’, ‘jitterdodge’, ‘fill’, ‘stack’ or ‘identity’, or the result of calling a position adjustment function (e.g., position_dodge() etc.).

show_legendbool, default=True

False - do not show legend for this layer.

inherit_aesbool, default=True

False - do not combine the layer aesthetic mappings with the plot shared mappings.

samplingFeatureSpec

Result of the call to the sampling_xxx() function. To prevent any sampling for this layer pass value “none” (string “none”).

tooltipslayer_tooltips

Result of the call to the layer_tooltips() function. Specify appearance, style and content. Set tooltips=’none’ to hide tooltips from the layer.

color_by{‘fill’, ‘color’, ‘paint_a’, ‘paint_b’, ‘paint_c’}, default=’color’

Define the color aesthetic for the geometry.

fill_by{‘fill’, ‘color’, ‘paint_a’, ‘paint_b’, ‘paint_c’}, default=’fill’

Define the fill aesthetic for the geometry.

other_args

Other arguments passed on to the layer. These are often aesthetics settings used to set an aesthetic to a fixed value, like color=’red’, fill=’blue’, size=3 or shape=21. They may also be parameters to the paired geom/stat.

Returns:
LayerSpec

Geom object specification.

Notes

geom_band() understands the following aesthetics mappings:

  • xmin : x-axis value.

  • xmax : x-axis value.

  • ymin : y-axis value.

  • ymax : y-axis value.

  • alpha : transparency level of a layer. Accept values between 0 and 1.

  • color (colour) : color of the geometry lines. For more info see Color and Fill.

  • fill : fill color. For more info see Color and Fill.

  • size : lines width.

  • linetype : type of the line. Accept codes or names (0 = ‘blank’, 1 = ‘solid’, 2 = ‘dashed’, 3 = ‘dotted’, 4 = ‘dotdash’, 5 = ‘longdash’, 6 = ‘twodash’), a hex string (up to 8 digits for dash-gap lengths), or a list pattern [offset, [dash, gap, …]] / [dash, gap, …]. For more info see Line Types.

Examples

1from lets_plot import *
2LetsPlot.setup_html()
3ggplot() + geom_band(xmin=-1, xmax=1)


 1import numpy as np
 2import pandas as pd
 3from lets_plot import *
 4LetsPlot.setup_html()
 5groups = ["A", "B", "C"]
 6n, m = 15, len(groups)
 7np.random.seed(42)
 8points_df = pd.DataFrame({
 9    'x': np.random.normal(size=m*n),
10    'y': np.concatenate([np.random.normal(loc=loc, size=n)
11                         for loc in np.random.uniform(-1, 1, size=m)]),
12    'g': np.random.choice(groups, size=m*n),
13})
14vertical_bands_df = points_df.groupby('g')['y'].agg(['min', 'max']).reset_index()
15ggplot() + \
16    geom_band(aes(ymin='min', ymax='max', paint_a='g'), data=vertical_bands_df, \
17              fill_by='paint_a', alpha=.2, size=0) + \
18    geom_point(aes('x', 'y', paint_a='g'), data=points_df, color_by='paint_a')
On this page