API Reference

Dr. Yasser Mustafa edited this page Feb 16, 2026 · 1 revision

PipePlotly API Reference

Detailed reference for all PipePlotly visualization verbs, optimized for the >> operator.

1. Initialization

Verb	Description	Example
`Plot(df)`	Primary entry point	`df >> Plot()`

2. Geometry Verbs (Geoms)

Verb	Description	Parameters
`plot_points`	Scatter plot	`x`, `y`
`plot_lines`	Line plot	`x`, `y`
`plot_bars`	Bar chart	`x`, `y` (optional)
`plot_histogram`	Histogram	`x`, `bins`
`plot_box`	Box plot	`x`, `y`
`plot_violin`	Violin plot	`x`, `y`
`plot_density`	Density plot	`x`
`plot_heatmap`	Heatmap	`x`, `y`, `color`

3. Aesthetic Verbs

Verb	Description	Usage
`add_color`	Map data to color	`>> add_color('category')`
`add_size`	Map data to size	`>> add_size('population')`
`add_shape`	Map data to point shape	`>> add_shape('type')`
`add_facets`	Create subplots	`>> add_facets(cols='species')`
`add_labels`	Set titles and axes	`>> add_labels(title='My Plot')`
`add_smooth`	Add trend lines	`>> add_smooth(method='loess')`

4. Output Verbs

Verb	Description
`show()`	Render plot
`save(path)`	Export to file
`to_interactive()`	Switch to Plotly
`to_static()`	Switch to plotnine