Aesthetics Reference¶
This page is auto-generated from runtime model metadata (Track.options()).
Track styles are configured through nested aesthetics=... models.
When using GenomicFigure helper methods (for example gf.bigwig(...)),
aesthetics and label kwargs can also be passed directly and are routed automatically.
Shorthand example:
gf.bigwig(
"signal.bw",
title="Sample",
title_color="black",
style="std",
color="#1f77b4",
alpha=0.8,
)
Equivalent explicit form:
gf.bigwig(
"signal.bw",
aesthetics={"style": "std", "color": "#1f77b4", "alpha": 0.8},
label={"title": "Sample", "title_color": "black"},
)
BedTrack¶
Aliases: bed
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | pathlib.Path | pandas.DataFrame | str | Any | None | — | — | False | BED/BigBed path or in-memory interval table-like object. |
| height | float | 1.0 | — | False | Relative panel height for this track. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.78 | — | False | Opacity of interval rectangles (0-1). |
| color | str | steelblue | — | False | Fill color for interval rectangles. |
| display | DisplayMode | collapsed | collapsed, expanded | False | Collapsed draws all intervals on one row; expanded stacks overlaps. |
| draw_edges | bool | True | — | False | Draw rectangle borders for intervals. |
| edge_color | str | black | — | False | Stroke color for interval borders. |
| font_size | int | 8 | — | False | Font size for interval labels. |
| interval_height | float | 0.45 | — | False | Rectangle height in normalized track coordinates. |
| label_field | str | name | — | False | Column name used to populate interval labels. |
| max_rows | int | 5 | — | False | Maximum stacked rows when display is expanded. |
| rect_linewidth | float | 0.7 | — | False | Border line width for interval rectangles. |
| show_labels | bool | False | — | False | Show text labels for intervals. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
BigWigCollection¶
Aliases: bigwig_collection
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| files | list[str] | (required) | — | True | List of BigWig file paths for the collection. |
| height | float | 2.0 | — | False | Relative panel height for this track. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.6 | — | False | Opacity applied to rendered collection traces. |
| colors | list[str] | None | — | — | False | Optional per-file colors used when creating component tracks. |
| labels | list[str] | None | — | — | False | Optional legend/title labels for each file in the collection. |
| style | CollectionStyle | overlay | overlay, stacked | False | Collection layout mode: overlay all traces or stack them. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
BigWigDiff¶
Aliases: bigwig_diff
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| file_a | str | (required) | — | True | Path to first BigWig input. |
| file_b | str | (required) | — | True | Path to second BigWig input. |
| height | float | 1.5 | — | False | Relative panel height for this track. |
| method | BigWigDiffMethod | subtract | subtract, ratio, log2ratio | False | Computation used to derive differential signal values. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| bar_alpha | float | 0.45 | — | False | Opacity of diff bars (0-1). |
| linewidth | float | 0.7 | — | False | Edge line width for diff bars. |
| negative_color | str | #1f77b4 | — | False | Bar color for negative differences. |
| positive_color | str | #d62728 | — | False | Bar color for positive differences. |
| zero_line_alpha | float | 0.8 | — | False | Opacity of the zero baseline. |
| zero_line_color | str | #333333 | — | False | Color of the horizontal zero baseline. |
| zero_line_width | float | 0.6 | — | False | Line width for the zero baseline. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
BigWigTrack¶
Aliases: bigwig
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | pathlib.Path | pandas.DataFrame | str | None | — | — | False | BigWig file path or bedgraph-like DataFrame data source. |
| height | float | 1.0 | — | False | Relative vertical height allocated to this track. |
| title | str | None | — | — | False | Display title for the track panel. |
| y_max | float | None | — | — | False | Computed upper y-limit for the last plotted region. |
| y_min | float | None | — | — | False | Computed lower y-limit for the last plotted region. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.9 | — | False | Opacity for rendered signal glyphs (0-1). |
| baseline_alpha | float | 0.85 | — | False | Opacity of the y=0 signal baseline. |
| baseline_color | str | #b8bec8 | — | False | Color of the y=0 signal baseline. |
| baseline_linewidth | float | 0.6 | — | False | Line width of the y=0 signal baseline. |
| color | str | #2171b5 | — | False | Primary color used to draw the signal. |
| fill | bool | True | — | False | Fill the area under the signal curve when supported. |
| linewidth | float | 0.8 | — | False | Line width for line/fragment style rendering. |
| max_value | float | None | — | — | False | Optional fixed upper y-limit; auto-derived when omitted. |
| min_value | float | None | — | — | False | Optional fixed lower y-limit; auto-derived when omitted. |
| scatter_point_size | float | 1.0 | — | False | Marker area for scatter style rendering. |
| show_baseline | bool | True | — | False | Draw a subtle baseline at y=0. |
| smoothing_center | bool | True | — | False | Center the smoothing window around each bin when enabled. |
| smoothing_method | Literal['mean', 'median'] | mean | — | False | Aggregation used for smoothing when smoothing_window > 1. |
| smoothing_window | int | 1 | — | False | Rolling window size in bins for optional signal smoothing. |
| style | PlotStyle | std | std, fill, line, scatter, heatmap, fragment | False | Style for rendering the signal track, for options see PlotStyle enum. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
CapcruncherTrack¶
Aliases: capcruncher
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| balance | bool | True | — | False | Use balanced matrix values when available. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| file | str | (required) | — | True | Path to cooler/mcool matrix file. |
| height | float | 2.5 | — | False | Relative panel height for this track. |
| normalisation | str | None | — | — | False | Optional normalization mode label. |
| resolution | int | None | — | — | False | Resolution bin size for .mcool files. |
| title | str | None | — | — | False | Display title for the track panel. |
| transform | CoolerTransform | none | log, log2, log10, none | False | Transform applied to matrix values before plotting. |
| viewpoint | str | None | — | — | False | Optional viewpoint identifier for capture-centric views. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| cmap | str | RdBu_r | — | False | Matplotlib colormap used to render matrix intensity. |
| max_value | float | None | — | — | False | Optional fixed upper bound for colormap normalization. |
| min_value | float | None | — | — | False | Optional fixed lower bound for colormap normalization. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
CoolerAverage¶
Aliases: cooler_average
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| balance | bool | True | — | False | Use balanced matrices where available. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| files | list[str] | (required) | — | True | List of cooler/mcool files to average. |
| height | float | 2.5 | — | False | Relative panel height for this track. |
| resolution | int | None | — | — | False | Resolution bin size for .mcool input files. |
| title | str | None | — | — | False | Display title for the track panel. |
| transform | CoolerTransform | none | log, log2, log10, none | False | Transform applied before averaging and plotting. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| cmap | str | RdBu_r | — | False | Matplotlib colormap used to render matrix intensity. |
| max_value | float | None | — | — | False | Optional fixed upper bound for colormap normalization. |
| min_value | float | None | — | — | False | Optional fixed lower bound for colormap normalization. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
CoolerTrack¶
Aliases: cooler
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| balance | bool | True | — | False | Use balanced matrix values when available. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| file | str | (required) | — | True | Path to cooler/mcool matrix file. |
| height | float | 2.5 | — | False | Relative panel height for this track. |
| resolution | int | None | — | — | False | Resolution bin size for .mcool files. |
| title | str | None | — | — | False | Display title for the track panel. |
| transform | CoolerTransform | none | log, log2, log10, none | False | Transform applied to matrix values before plotting. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| cmap | str | RdBu_r | — | False | Matplotlib colormap used to render matrix intensity. |
| max_value | float | None | — | — | False | Optional fixed upper bound for colormap normalization. |
| min_value | float | None | — | — | False | Optional fixed lower bound for colormap normalization. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
Genes¶
Aliases: genes
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | pathlib.Path | str | pandas.DataFrame | None | — | — | False | Gene annotation source (BED12/GTF file path or DataFrame). |
| gene_count | int | 0 | — | False | Number of genes drawn in the last plotting pass. |
| genome | str | None | — | — | False | Bundled genome key used when data is not provided (e.g., hg38). |
| height | float | 1.5 | — | False | Relative panel height for this track. |
| row_scale | float | 1.0 | — | False | Internal row scaling factor used during layout. |
| small_relative | float | 0.01 | — | False | Internal small-offset ratio used for annotation geometry. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 1.0 | — | False | Opacity for rendered gene bodies (0-1). |
| arrow_size | float | 0.12 | — | False | Arrow marker size for transcript direction cues. |
| chevron_height_ratio | float | 0.22 | — | False | Chevron height relative to track row height. |
| chevron_margin_bp | float | 20.0 | — | False | Margin near transcript edges where chevrons are omitted. |
| chevron_max_count | int | 10 | — | False | Maximum number of chevrons drawn per gene body. |
| chevron_min_width_bp | float | 40.0 | — | False | Minimum chevron width in base pairs. |
| chevron_target_spacing_bp | float | 9000.0 | — | False | Target spacing in bp between directional chevrons. |
| chevron_vertical_offset_ratio | float | 0.0 | — | False | Vertical offset ratio used when drawing directional chevrons. |
| chevron_width_fraction | float | 0.035 | — | False | Default chevron width as fraction of viewport width. |
| color | str | black | — | False | Primary color used for gene glyphs. |
| display | DisplayMode | collapsed | collapsed, expanded | False | Collapsed uses one row; expanded stacks overlapping genes. |
| exon_color | str | black | — | False | Fill color for exon rectangles. |
| exon_edge_color | str | black | — | False | Edge color for exon rectangles. |
| exon_linewidth | float | 0.8 | — | False | Line width for exon outlines. |
| fill | bool | True | — | False | Fill exon bodies instead of outlines only. |
| gene_label_font_size | int | 10 | — | False | Font size for gene name labels. |
| gene_label_style | GeneLabelStyle | italic | normal, italic, oblique | False | Font style for gene name labels. |
| interval_height | float | 0.1 | — | False | Vertical thickness of exon rectangles. |
| intron_color | str | black | — | False | Color for intron connector lines. |
| intron_linewidth | float | 0.5 | — | False | Line width for intron connector lines. |
| label_connector_linewidth | float | 0.7 | — | False | Line width for label connector lines. |
| label_connectors | bool | False | — | False | Draw connector lines between displaced labels and their gene models. |
| label_max_chars | int | 20 | — | False | Maximum characters to show for each gene label before truncation. |
| label_min_overlap_bp | int | 200 | — | False | Do not draw labels for genes clipped at viewport edges when visible overlap is below this bp threshold. |
| label_min_overlap_fraction | float | 0.15 | — | False | Do not draw labels for clipped edge genes when overlap is below this fraction of total gene length. |
| label_offset_fraction | float | 0.005 | — | False | Horizontal gene label offset as a fraction of viewport width. |
| label_overlap_strategy | GeneLabelOverlapStrategy | auto | auto, smart, stagger, suppress, auto_expand | False | How to handle overlapping labels: auto resolves by display mode, smart uses lane stacking + horizontal nudging, stagger alternates vertical offsets, suppress hides collisions, auto_expand switches collapsed mode to expanded. |
| label_stagger_offset | float | 0.15 | — | False | Vertical offset (in row units) used by staggered label placement. |
| label_vertical_offset | float | 0.14 | — | False | Vertical offset (in row units) for non-stagger label placement. |
| max_number_of_rows | int | 4 | — | False | Maximum rows shown when display mode is expanded. |
| minimum_gene_length | int | 0 | — | False | Minimum feature length (bp) required to draw a gene. |
| show_labels | bool | True | — | False | Draw gene name labels. |
| style | PlotStyle | std | std, fill, line, scatter, heatmap, fragment | False | Gene rendering style preset. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
GenomicAxis¶
Aliases: axis
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| height | float | 0.2 | — | False | Relative panel height for this compact track. |
| show_chromosome | bool | False | — | False | Whether to draw the chromosome name on this axis track. |
| title | str | — | False | Optional title shown for the axis track. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| axis_linewidth | float | 1.1 | — | False | Line width of the horizontal axis baseline. |
| chromosome_fontweight | FontWeight | bold | normal, bold | False | Font weight of the chromosome text label. |
| color | str | #666666 | — | False | Color of axis baseline and chromosome label. |
| font_size | int | 9 | — | False | Font size for tick and chromosome labels. |
| num_ticks | int | 5 | — | False | Target number of tick marks across the region. |
| show_chromosome | bool | True | — | False | Render chromosome name label near the axis. |
| tick_color | str | #333333 | — | False | Color for tick marks and tick labels. |
| tick_height | float | 0.15 | — | False | Tick length drawn downward from axis baseline. |
| tick_linewidth | float | 0.9 | — | False | Line width of tick marks. |
| use_human_readable_labels | bool | False | — | False | Format genomic coordinates using k/M suffixes instead of raw integers. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
HLineTrack¶
Aliases: hline
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| height | float | 0.0 | — | False | Zero-height overlay track. |
| title | str | None | — | — | False | Display title for the track panel. |
| y_value | float | (required) | — | True | Y-axis value where the horizontal line is drawn. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.8 | — | False | Opacity of the reference line (0-1). |
| color | str | red | — | False | Color used to draw reference lines. |
| linestyle | str | -- | — | False | Matplotlib line style pattern for the line. |
| linewidth | float | 1.0 | — | False | Line width for the reference line. |
| zorder | int | 10 | — | False | Matplotlib z-order used when drawing the line. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
HighlightsFromFile¶
Aliases: highlight
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | pathlib.Path | pandas.DataFrame | str | (required) | — | True | BED/BigBed-like regions data source for highlight overlays. |
| height | float | 0.0 | — | False | Zero-height overlay track spanning plotted axes. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.3 | — | False | Opacity of highlighted regions (0-1). |
| color | str | yellow | — | False | Fill color for highlighted regions. |
| edge_color | str | None | — | — | False | Optional border color for highlighted regions. |
| linewidth | float | 1.0 | — | False | Border line width when edge_color is provided. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
LinksTrack¶
Aliases: links
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | pathlib.Path | pandas.DataFrame | str | (required) | — | True | BEDPE-like interactions data source (file path or DataFrame). |
| height | float | 2.0 | — | False | Relative panel height for this track. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.55 | — | False | Opacity of interaction arcs (0-1). |
| cmap | str | viridis | — | False | Colormap used when coloring arcs by score. |
| color | str | steelblue | — | False | Default arc color when score coloring is disabled. |
| color_by_score | bool | False | — | False | Use score column values to map each arc color via cmap. |
| edge_color | str | None | — | — | False | Optional stroke override for arc edges. |
| linewidth | float | 0.8 | — | False | Line width for interaction arcs. |
| max_height | float | 0.8 | — | False | Maximum normalized arc height relative to track bounds. |
| max_score | float | None | — | — | False | Optional maximum score bound for score-based color mapping. |
| min_score | float | None | — | — | False | Optional minimum score bound for score-based color mapping. |
| y_baseline | float | 0.1 | — | False | Baseline y position from which arcs originate. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
NarrowPeakTrack¶
Aliases: narrowpeak
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | pathlib.Path | pandas.DataFrame | str | Any | None | — | — | False | BED/BigBed path or in-memory interval table-like object. |
| height | float | 1.0 | — | False | Relative panel height for this track. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.78 | — | False | Opacity of interval rectangles (0-1). |
| cmap | str | Oranges | — | False | Colormap used when color_by is enabled. |
| color | str | #d95f02 | — | False | Fallback color for peaks. |
| color_by | plotnado.tracks.enums.NarrowPeakColorBy | None | signalValue | score, signalValue, pValue, qValue | False | Optional narrowPeak field used for colormap-based coloring. |
| display | DisplayMode | collapsed | collapsed, expanded | False | Collapsed draws all intervals on one row; expanded stacks overlaps. |
| draw_edges | bool | True | — | False | Draw rectangle borders for intervals. |
| edge_color | str | black | — | False | Stroke color for interval borders. |
| font_size | int | 8 | — | False | Font size for interval labels. |
| interval_height | float | 0.28 | — | False | Rectangle height in normalized track coordinates for peak intervals. |
| label_field | str | name | — | False | Column name used to populate interval labels. |
| max_rows | int | 5 | — | False | Maximum stacked rows when display is expanded. |
| max_score | float | None | — | — | False | Optional upper score bound for colormap normalization. |
| min_score | float | None | — | — | False | Optional lower score bound for colormap normalization. |
| rect_linewidth | float | 0.7 | — | False | Border line width for interval rectangles. |
| show_labels | bool | False | — | False | Show text labels for intervals. |
| show_summit | bool | True | — | False | Draw summit marker when peak offset is available. |
| summit_color | str | black | — | False | Color of summit marker lines. |
| summit_width | float | 0.8 | — | False | Line width of summit marker lines. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
OverlayTrack¶
Aliases: bigwig_overlay, overlay
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| height | float | 2.0 | — | False | Relative panel height for this track. |
| title | str | None | — | — | False | Display title for the track panel. |
| tracks | list[plotnado.tracks.base.Track | pandas.DataFrame | pathlib.Path | str] | (required) | — | True | List of Track instances, in-memory signal DataFrames, or BigWig-like file paths to overlay. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.5 | — | False | Opacity applied to overlaid signal traces. |
| colors | list[str] | None | — | — | False | Optional per-track color overrides for overlaid subtracks. |
| max_value | float | None | — | — | False | Optional shared maximum y-value for all overlaid tracks. |
| min_value | float | None | — | — | False | Optional shared minimum y-value for all overlaid tracks. |
| show_labels | bool | True | — | False | Render labels for component tracks in overlay contexts. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
QuantNadoCoverageTrack¶
Aliases: quantnado_coverage
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| coverage_data | Any | None | — | — | False | Optional precomputed xarray-like coverage data with dims (sample, position). |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| dataset_path | str | None | — | — | False | Path to a QuantNado dataset opened lazily when needed. |
| height | float | 1.0 | — | False | Relative vertical height allocated to this track. |
| quantnado | Any | None | — | — | False | Runtime QuantNado instance used to fetch track data. |
| sample | str | (required) | — | True | Sample name to render from QuantNado data. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.75 | — | False | Opacity for coverage fill and line. |
| baseline_alpha | float | 0.85 | — | False | Baseline opacity. |
| baseline_color | str | #b8bec8 | — | False | Baseline color. |
| baseline_linewidth | float | 0.6 | — | False | Baseline line width. |
| color | str | #2171b5 | — | False | Primary color for coverage rendering. |
| fill | bool | True | — | False | Fill area under the coverage profile. |
| linewidth | float | 0.8 | — | False | Line width for stepped coverage trace. |
| max_value | float | None | — | — | False | Optional fixed upper y-limit. |
| min_value | float | None | — | — | False | Optional fixed lower y-limit. |
| show_baseline | bool | True | — | False | Draw baseline at y=0 when visible. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
QuantNadoMethylationTrack¶
Aliases: quantnado_methylation
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| dataset_path | str | None | — | — | False | Path to a QuantNado dataset opened lazily when needed. |
| height | float | 1.0 | — | False | Relative vertical height allocated to this track. |
| methylation_data | Any | None | — | — | False | Optional precomputed methylation xarray-like data with dims (sample, position). |
| methylation_variable | str | methylation_pct | — | False | Variable fetched from QuantNado methylation store. |
| quantnado | Any | None | — | — | False | Runtime QuantNado instance used to fetch track data. |
| sample | str | (required) | — | True | Sample name to render from QuantNado data. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.75 | — | False | Opacity for methylation points. |
| color | str | #2a9d8f | — | False | Scatter color for methylation points. |
| max_value | float | None | 100.0 | — | False | Upper y-limit (default 100). |
| min_value | float | None | 0.0 | — | False | Lower y-limit (default 0). |
| point_size | float | 10.0 | — | False | Marker area for methylation points. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
QuantNadoStrandedCoverageTrack¶
Aliases: quantnado_stranded_coverage
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| coverage_fwd_data | Any | None | — | — | False | Optional forward-strand xarray-like coverage data with dims (sample, position). |
| coverage_rev_data | Any | None | — | — | False | Optional reverse-strand xarray-like coverage data with dims (sample, position). |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| dataset_path | str | None | — | — | False | Path to a QuantNado dataset opened lazily when needed. |
| height | float | 1.0 | — | False | Relative vertical height allocated to this track. |
| quantnado | Any | None | — | — | False | Runtime QuantNado instance used to fetch track data. |
| sample | str | (required) | — | True | Sample name to render from QuantNado data. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.7 | — | False | Opacity for stranded coverage traces. |
| baseline_alpha | float | 0.8 | — | False | Baseline opacity. |
| baseline_color | str | #444444 | — | False | Baseline color. |
| baseline_linewidth | float | 0.6 | — | False | Baseline line width. |
| color | str | #1f78b4 | — | False | Color for forward strand signal. |
| fill | bool | True | — | False | Fill areas for forward and reverse signals. |
| linewidth | float | 0.8 | — | False | Line width for stepped traces. |
| max_value | float | None | — | — | False | Optional fixed upper y-limit. |
| min_value | float | None | — | — | False | Optional fixed lower y-limit. |
| reverse_color | str | None | — | — | False | Optional color override for reverse strand signal; defaults to color. |
| show_baseline | bool | True | — | False | Draw baseline at y=0. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
QuantNadoVariantTrack¶
Aliases: quantnado_variant
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| allele_depth_alt_data | Any | None | — | — | False | Optional precomputed alt-depth xarray-like data with dims (sample, position). |
| allele_depth_alt_variable | str | allele_depth_alt | — | False | Alternate-allele depth variable name in QuantNado variants store. |
| allele_depth_ref_data | Any | None | — | — | False | Optional precomputed ref-depth xarray-like data with dims (sample, position). |
| allele_depth_ref_variable | str | allele_depth_ref | — | False | Reference-allele depth variable name in QuantNado variants store. |
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| dataset_path | str | None | — | — | False | Path to a QuantNado dataset opened lazily when needed. |
| fetch_genotype | bool | True | — | False | Fetch genotype data from QuantNado variants store when available. |
| genotype_data | Any | None | — | — | False | Optional precomputed genotype xarray-like data with dims (sample, position). |
| genotype_variable | str | genotype | — | False | Genotype variable name in QuantNado variants store. |
| height | float | 1.0 | — | False | Relative vertical height allocated to this track. |
| quantnado | Any | None | — | — | False | Runtime QuantNado instance used to fetch track data. |
| sample | str | (required) | — | True | Sample name to render from QuantNado data. |
| title | str | None | — | — | False | Display title for the track panel. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.8 | — | False | Opacity for lollipop stems/markers. |
| baseline_alpha | float | 0.75 | — | False | Baseline opacity. |
| baseline_color | str | #444444 | — | False | Baseline color. |
| baseline_linewidth | float | 0.6 | — | False | Baseline line width. |
| het_color | str | #1f77b4 | — | False | Color for heterozygous variants. |
| hom_alt_color | str | #d62728 | — | False | Color for homozygous-alt variants. |
| linewidth | float | 0.9 | — | False | Lollipop stem line width. |
| marker_size | float | 24.0 | — | False | Lollipop marker area. |
| max_value | float | None | 1.08 | — | False | Upper y-limit (default 1.08). |
| min_value | float | None | 0.0 | — | False | Lower y-limit (default 0). |
| show_baseline | bool | True | — | False | Draw baseline at y=0. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
ScaleBar¶
Aliases: scale, scalebar
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| height | float | 0.3 | — | False | Relative panel height for this compact track. |
| title | str | ScaleBar | — | False | Optional title for the scale bar track. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| bar_linewidth | float | 1.8 | — | False | Line width of the main horizontal scale bar. |
| color | str | #333333 | — | False | Color of scale bar line, ticks, and label. |
| font_size | int | 8 | — | False | Font size for the scale label. |
| label_offset | float | 0.25 | — | False | Vertical distance between bar baseline and text label. |
| position | Position | left | left, right, center | False | Horizontal anchor of the scale bar. |
| scale_distance | float | None | — | — | False | Explicit scale bar length in base pairs; auto-selected if omitted. |
| style | PlotStyle | std | std, fill, line, scatter, heatmap, fragment | False | Scale bar style variant. |
| tick_height | float | 0.1 | — | False | Half-height of terminal ticks in axis units. |
| tick_linewidth | float | 1.4 | — | False | Line width of terminal scale ticks. |
| title | str | Scale | — | False | Human-readable name for this style preset. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
Spacer¶
Aliases: spacer
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| height | float | 0.5 | — | False | Relative vertical spacing height. |
| title | str | — | False | Optional title for the spacer track. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |
VLineTrack¶
Aliases: vline
Track fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| autoscale_group | str | None | — | — | False | Tracks sharing the same group id are y-scaled together. |
| color_group | str | None | — | — | False | Tracks sharing this id use the same autocolor/theme-palette color. |
| data | Any | None | — | — | False | Primary data source consumed by the track implementation. |
| height | float | 0.0 | — | False | Zero-height overlay track. |
| title | str | None | — | — | False | Display title for the track panel. |
| x_position | int | str | (required) | — | True | Genomic position where the vertical line is drawn. |
Aesthetics fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| alpha | float | 0.8 | — | False | Opacity of the reference line (0-1). |
| color | str | red | — | False | Color used to draw reference lines. |
| linestyle | str | -- | — | False | Matplotlib line style pattern for the line. |
| linewidth | float | 1.0 | — | False | Line width for the reference line. |
| zorder | int | 10 | — | False | Matplotlib z-order used when drawing the line. |
Label fields¶
| Name | Type | Default | Choices | Required | Description |
|---|---|---|---|---|---|
| data_range_style | DataRangeStyle | text | text, colorbar, none | False | How to render the data range annotation for the track. |
| label_box_alpha | float | 0.9 | — | False | Opacity of the label background box (0-1). |
| label_box_enabled | bool | True | — | False | Draw a translucent white box behind label text for legibility. |
| label_on_track | bool | False | — | False | Draw labels inside the track plotting area instead of margins. |
| plot_scale | bool | True | — | False | Show the y-scale range annotation. |
| plot_title | bool | True | — | False | Show the track title text. |
| scale_color | str | #666666 | — | False | Text color for scale annotation. |
| scale_font | str | DejaVu Sans | — | False | Font family for scale annotation. |
| scale_height | float | 0.8 | — | False | Relative vertical position for scale text in data coordinates. |
| scale_location | Position | right | left, right, center | False | Side of the track where scale text is anchored. |
| scale_precision | int | 2 | — | False | Decimal precision used when formatting scale values. |
| scale_size | int | 9 | — | False | Font size for scale annotation. |
| scale_weight | FontWeight | normal | normal, bold | False | Font weight for scale annotation. |
| title_color | str | #333333 | — | False | Text color for title label. |
| title_font | str | DejaVu Sans | — | False | Font family for title label. |
| title_height | float | 0.8 | — | False | Relative vertical position for title text in data coordinates. |
| title_location | Position | left | left, right, center | False | Side of the track where the title is anchored. |
| title_size | int | 10 | — | False | Font size for the title label. |
| title_weight | FontWeight | bold | normal, bold | False | Font weight for title label. |