VariantsBand
Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the variants plugin. View source.
The multi-sample variant display's variants setting: a
LinearVariantDisplay-style band above the genotype rows, one mark per
record at its genomic span, colored by whatever "Color by → Cells" is set
to. Overlapping records stack while the band has room and share a row once
it has not; hovering a mark reports the record, clicking opens its details,
and right-clicking opens the menu a genotype cell does. At genomic positions
only.
Example usage
{ type: 'LinearMultiSampleVariantDisplay', variants: { show: true } }Config slots
A setting written to it names members one by one: a member left out stays as it is, and null resets one. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.
| Slot | Description |
|---|---|
showboolean = false | draw the variants themselves above the genotype rows, at their genomic positions |
heightnumber = 40 | height of the band in pixels, taken from the rows |
showLabelsstringEnum (auto, nameAndDescription, name, description, none) = 'auto' | Letter the marks with each record's VCF ID and/or its description, as a LinearVariantDisplay letters the same record. That display's fit ladder decides what the band has room for: descriptions drop first, then IDs are thinned, then dropped. |