objects_interface.md
221 lines · skills/seaborn/references/objects_interface.md at 5f2bc03
Seaborn Objects Interface
Reviewed against Seaborn 0.13.2's objects API and released source on 2026-10-01. Upstream still calls this interface experimental and incomplete. Use it when composing layers helps; use the function interface for plot types it does not implement, such as bivariate KDE.
Raw lines 1 to 7Build, retain, and render a specification
Plot methods return a new specification. Assign the result or chain methods; calling p.add(...) without retaining the return value does not update p. Mappings belong in Plot/add; constant visual properties belong in the mark. so.Dot(alpha=.4) sets opacity directly; add(so.Dot(), alpha=.4) creates a constant data mapping whose default scale need not render opacity .4.
import numpy as np
import pandas as pd
import matplotlib.pyplot as plt
import matplotlib.dates as mdates
import seaborn as sns
import seaborn.objects as so
# Small offline fixture; repeated measurements are independent here by design.
df = pd.DataFrame({
'category': np.repeat(['A', 'B'], 8),
'group': ['control', 'control', 'treated', 'treated'] * 4,
'value': [1, 2, 3, 5, 2, 3, 4, 6, 3, 5, 6, 8, 4, 6, 7, 9],
'x': np.tile(np.arange(8), 2),
})
p = so.Plot(df, x='x', y='value', color='category').add(so.Dot(alpha=.4))
p = p.add(so.Line(), so.PolyFit(order=1)) # Default PolyFit order is 2
p.save('objects-scatter.png', dpi=150, bbox_inches='tight')In notebooks the last expression can display automatically. In scripts use .show(), .save(), or .plot(). Include bbox_inches='tight' on exports when an external legend would otherwise be clipped. To customize an existing Matplotlib axes, .on(ax) needs a subsequent compilation call:
fig, ax = plt.subplots(figsize=(5, 3))
p.on(ax).plot()
ax.set_ylabel('Response (units)')
fig.savefig('objects-on-axes.pdf', bbox_inches='tight')Raw lines 8 to 46Layers and estimation
Plot.add(mark, *transforms, orient=None, legend=True, label=None, data=None, **variables) supports at most one Stat, placed first, followed by Moves. orient='x' means grouping along x and estimation along y ('v' is a synonym); 'y'/'h' reverses this. A layer can override data and mapped variables.
An estimator computes interval columns but does not make every mark draw them. Line and Bar use the point estimate; add Band or Range for uncertainty. Use the same estimator, seed, grouping, and dodge on both layers.
est = so.Est(func='mean', errorbar=('ci', 95), n_boot=1000, seed=7)
bars = (
so.Plot(df, x='category', y='value', color='group')
.add(so.Bar(), est, so.Dodge())
.add(so.Range(), est, so.Dodge())
.label(y='Mean response', color='Group')
)
bars.save('objects-intervals.png', dpi=150, bbox_inches='tight')For a line plus interval use .add(so.Line(), est).add(so.Band(), est). Est(errorbar='sd') depicts spread, not a confidence interval. Est has no units= constructor parameter for multilevel bootstrap; compute design-aware intervals outside Seaborn when rows are dependent, then map ymin/ymax. Weights passed as a layer variable are supported for a mean with bootstrap CI or no error bars, not arbitrary estimators or complex sampling designs.
Choose marks by their actual geometry
| Mark | Behavior and useful constant properties |
|---|---|
Dot | Individual points: color, alpha, marker, pointsize, stroke, fill, edgecolor, edgewidth. No fillcolor or fillalpha constructor arguments. |
Line, Path | Line sorts on the orientation axis; Path follows row order. linewidth, linestyle, marker/pointsize, fillcolor, edgecolor. Neither aggregates by itself. |
Bar, Bars | Baseline to value; Bar is flexible, Bars batches artists with histogram-friendly defaults. Neither adds error bars. width is relative to the spacing on the orientation axis, not a universal physical data-unit width. |
Area, Band | Filled baseline-to-value area versus interval between bounds. Area has baseline; Band has no baseline. Map ymin/ymax (or horizontal bounds) for a band. |
Range | Segment between minimum and maximum values/bounds. color, alpha, linewidth, linestyle; no endpoint marker, pointsize, or edgewidth properties. |
Dash | Short segment per observation; width controls relative length, with line properties. |
Text | text, color, fontsize, halign, valign; offset is a scalar in points, not an (x, y) tuple. |
Marks accept artist_kws={...} for underlying Matplotlib customization; they do not accept arbitrary unknown keyword properties. Faster plural Dots, Lines, and Paths also exist; consult their own properties rather than assuming all singular-mark options apply.
labels = df.groupby('category', as_index=False).agg(x=('x', 'mean'), value=('value', 'mean'))
text_plot = (
so.Plot(labels, x='x', y='value', text='category')
.add(so.Dot())
.add(so.Text(offset=6, valign='bottom'))
)
text_plot.save('objects-labels.png', dpi=150, bbox_inches='tight')Raw lines 76 to 102Statistical transforms
| Stat | Parameters and interpretation |
|---|---|
Agg(func='mean') | Aggregate along the value axis; string or callable, without intervals. |
Est(func='mean', errorbar=('ci',95), n_boot=1000, seed=None) | Estimate plus bounds; seed controls bootstrap repeatability. Use a range/band layer to show bounds. |
Hist(stat='count', bins='auto', binwidth=None, binrange=None, common_norm=True, common_bins=True, cumulative=False, discrete=False) | Counts or normalized bins; binwidth overrides bins. |
KDE(bw_adjust=1, bw_method='scott', common_norm=True, common_grid=True, gridsize=200, cut=3, cumulative=False) | Univariate density. common_norm=False normalizes each group separately; use comparable grids/bandwidths and inspect support. |
Count() | Count observations in groups. |
PolyFit(order=2, gridsize=100) | Polynomial prediction curve; no confidence interval or causal inference. Set order=1 for linear regression. |
Perc(k=5, method='linear') | Compute k equally spaced percentiles including 0 and 100; k=[25,75] selects the IQR. It returns values, not ymin/ymax bounds. |
Band can span the values returned by Perc([25,75]); with the default Perc(5) it spans the full min/max range, not the IQR. A Range can display the same bounds at discrete x positions. Use NumPy-compatible percentile methods.
hist = (
so.Plot(df, x='value', color='group')
.add(so.Bars(), so.Hist(bins=np.arange(.5, 10.5), stat='density', common_norm=False))
)
hist.save('objects-hist.png', dpi=150, bbox_inches='tight')
kde = (
so.Plot(df, x='value', color='group')
.add(so.Line(), so.KDE(common_norm=False, cut=0))
)
kde.save('objects-kde.png', dpi=150, bbox_inches='tight')Histogram and KDE overlays must share normalization semantics. Gaussian KDE can misrepresent boundaries and discrete data; cut=0 limits drawing but does not correct boundary bias. Use sns.kdeplot(x=..., y=...) for bivariate KDE.
Moves
Dodge(empty='keep', gap=0, by=None): separate overlapping groups along the orientation axis.emptycan be'keep','drop', or'fill'.Stack(): stack values, normally afterAgg,Count, orHist.Jitter(width=..., x=0, y=0, seed=None):widthscales displacement by mark width on the orientation axis;x/yspecify displacement in data units. There is noheightargument. Set a seed when positional reproducibility matters.Shift(x=0, y=0): constant displacements in data units.Norm(func='max', where=None, by=None, percent=False): divide value-axis data by a grouped aggregate.whereis a query expression, not an axis selector.funcaccepts a pandas aggregation name or callable, not an invented'area'normalization mode. Specifybywhen the denominator's grouping matters.
jitter = (
so.Plot(df, x='category', y='value', color='group')
.add(so.Dot(alpha=.6), so.Dodge(), so.Jitter(width=.2, seed=7))
)
jitter.save('objects-jitter.png', dpi=150, bbox_inches='tight')Raw lines 136 to 157Facets and paired grids
facet(col=..., row=..., order=..., wrap=...) takes either a list for one facet variable or a dictionary keyed by **col and row**, not data column names. Wrapping supports only a single faceting dimension.
facets = p.facet(col='category', order={'col': ['B', 'A']}).layout(size=(7, 3))
facets.save('objects-facets.png', dpi=150, bbox_inches='tight')pair(x=[...], y=[...], cross=True) forms the Cartesian product of the given lists. With cross=False, equal-length x/y lists are zipped. Supplying only x repeats the existing y mapping; it does not infer an all-by-all scatter matrix.
pairs = so.Plot(df).pair(x=['x', 'value'], y=['x', 'value']).add(so.Dot())
pairs.save('objects-pairs.png', dpi=150, bbox_inches='tight')Raw lines 158 to 177Scales, labels, and layout
scale(x=..., y=..., color=..., pointsize=...): scales transform values before statistics run; a log scale can therefore change the estimated quantity.Continuous(values=None, norm=None, trans=None):normis a domain pair, not a normalization function. For color, use a palette/colormap name asvalues; do not pass(0,1)as though it were a color range.transsupports strings such as'log','sqrt','symlog','logit','pow10', or a(forward, inverse)callable pair, not a single callable.Continuous.tick(locator=None, at=None, upto=None, count=None, every=None, between=None, minor=None)uses keyword-only options afterlocator..label(formatter=None, like=None, base=..., unit=None)formats ticks.Nominal(values=None, order=None)controls categorical ordering and property values.Booleanhandles a True/False domain.Temporal(values=None, norm=None)has notrans;.tick(locator=None, upto=None)accepts a Matplotlib date locator, notevery=('month',1)..label(x=..., y=..., color=..., title=...)labels axes/legends/facets..limit(x=(lo,hi), y=(lo,hi))controls view limits..share(x=True, y=False)changes facet scale sharing;'row'/'col'work too..theme({...})takes a positional rcParams dictionary..layout(size=(width,height), extent=(left,bottom,right,top), engine=...)configures figure inches, fractional subplot extent, and layout engine.
styled = p.scale(
x=so.Continuous().tick(every=2),
y=so.Continuous().label(like='{x:.1f}'),
color=so.Nominal({'A': '#0072B2', 'B': '#D55E00'}),
).theme({**sns.axes_style('whitegrid'), **sns.plotting_context('paper')})
styled.save('objects-styled.pdf', bbox_inches='tight')
dated = df.assign(date=pd.date_range('2026-01-01', periods=len(df)))
date_plot = (
so.Plot(dated, x='date', y='value')
.add(so.Dot())
.scale(x=so.Temporal().tick(mdates.DayLocator(interval=4)).label(concise=True))
)
date_plot.save('objects-dates.png', dpi=150, bbox_inches='tight')For measured trajectories, inspect connectivity and use explicit segment groups when observations are missing; see patterns_and_troubleshooting.md. The synthetic recipes above were rendered with the dependency stack in SKILL.md. They demonstrate plotting contracts, not validity of an analysis on a user's data.