Reference
This page summarizes the high-level API contract. For visual examples, start with Quick Start, Track Catalog, and Aesthetics. For generated field lookup, use Compact Options.
Core track helpers
bigwig(data, **kwargs) |
Continuous signal. |
BigWig path/URL or table with chrom, start, end, value. |
bed(data, **kwargs) |
Genomic intervals. |
BED/BigBed path or table with chrom, start, end. |
narrowpeak(data, **kwargs) |
ENCODE narrowPeak intervals. |
narrowPeak path or compatible table. |
links(data, **kwargs) |
Interaction arcs. |
BEDPE-like table. |
genes(genome="hg38", **kwargs) |
Gene models. |
Built-in genome name or custom annotation data. |
overlay(tracks, **kwargs) |
Multiple signals in one panel. |
List of signal sources or BigWigTrack objects. |
bigwig_collection(files, **kwargs) |
Multi-file signal collection. |
BigWig file list. |
bigwig_diff(file_a, file_b, **kwargs) |
Difference between two signal files. |
Two BigWig files. |
scalebar(**kwargs) |
Genomic distance cue. |
No external data. |
axis(**kwargs) |
Coordinate ticks. |
No external data. |
spacer(height=0.5, **kwargs) |
Blank vertical space. |
No external data. |
Editing after build
fig["track title"]
fig[0]
fig["track title"].color = "coral"
fig.update_track("title", color="purple", max_value=500)
fig.update_track(height=0.2)
fig.update_track(track_type="bigwig", height=0.3)
fig.update_track(group="group_1", max_value=1000)
fig.update_track(where=lambda t: "CD" in (t.title or ""), color="coral")
fig.remove_track("title")
fig.bigwig("extra.bw", title="extra", position="top")
Loading external definitions
fig = GenomicFigure.from_template("template.yaml")
fig, locus = GenomicFigure.from_igv_session("session.xml")
fig.plot(locus)
fig.to_toml("figure.toml")
fig2 = GenomicFigure.from_toml("figure.toml")
Runtime option discovery
GenomicFigure.available_track_aliases()
GenomicFigure.track_options("bigwig")
GenomicFigure.track_options_markdown("bigwig")