# VariantsBand

Auto-generated from the config schema in the source — see the [config guide](https://jbrowse.org/jb2/docs/config_guide) for concepts. Provided by the `variants` plugin. [View source](https://github.com/GMOD/jbrowse-components/blob/main/plugins/variants/src/LinearMultiSampleVariantDisplay/variantsBandConfigSchema.ts).

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

```js
{ 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](https://jbrowse.org/jb2/docs/config_guides/slot_types). Slots a base configuration contributes are listed here too, so this table is the whole surface.

| Slot | Description |
| --- | --- |
| **show**<br>[`boolean`](https://jbrowse.org/jb2/docs/config_guides/slot_types#boolean) = <code>false</code> | draw the variants themselves above the genotype rows, at their genomic positions |
| **height**<br>[`number`](https://jbrowse.org/jb2/docs/config_guides/slot_types#number) = <code>40</code> | height of the band in pixels, taken from the rows |
| **showLabels**<br>[`stringEnum`](https://jbrowse.org/jb2/docs/config_guides/slot_types#stringenum) (auto, nameAndDescription, name, description, none) = <code>'auto'</code> | 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. |