# ReadsPileup

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 `alignments` plugin. [View source](https://github.com/GMOD/jbrowse-components/blob/main/plugins/alignments/src/LinearAlignmentsDisplay/readsPileupConfigSchema.ts).

LinearAlignmentsDisplay's `pileup`: the [Pileup](../pileup) band with the
per-base layer over the reads, `bases`, which a synteny block, having no
qualities or basecaller tags, goes without.

## Example usage

```js
{
  type: 'LinearAlignmentsDisplay',
  pileup: { bases: { show: true, encoding: { color: 'modifications' } } },
}
```

## Related links

- **Base config:** [Pileup](../pileup)

## 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 |
| --- | --- |
| **bases**<br>[PileupBases](../pileupbases) | The per-base layer: `show` and `encoding.color`. |
| <span class="slot-group">Inherited from [Pileup](../pileup) | <span class="slot-group-count">7 slots |
| **show**<br>[`boolean`](https://jbrowse.org/jb2/docs/config_guides/slot_types#boolean) = <code>true</code> | draw the pileup band |
| **mark**<br>[PileupMark](../pileupmark) | The bar each read draws as: `height`. |
| **maxLayoutHeight**<br>[`number`](https://jbrowse.org/jb2/docs/config_guides/slot_types#number) = <code>6000</code> | the tallest the pileup's layout grows in pixels; reads past it are not stacked, and coverage still counts them. Not the display's growMaxHeight, which caps how tall the track grows<br>_advanced_ |
| **mismatches**<br>[PileupMismatches](../pileupmismatches) | How reads differ from the reference: `show`, and `encoding.opacity`, the fade by base quality. |
| **softClips**<br>[PileupSoftClips](../pileupsoftclips) | The soft-clipped ends of each read: `show`. |
| **connectors**<br>[PileupConnectors](../pileupconnectors) | Lines over the pileup joining each read to its mate or split segment: `show`. |
| **fadeLowFrequency**<br>[`boolean`](https://jbrowse.org/jb2/docs/config_guides/slot_types#boolean) = <code>true</code> | fade each sub-pixel mismatch, insertion, deletion and clip mark by the share of reads at its position that have it: a mark every read has stays opaque, and one under the depth-dependent noise threshold drops to the sub-pixel floor and, past one base per pixel, takes no clicks. Off draws them all at full opacity. The coverage band is not faded (see runCoveragePipeline)<br>_advanced_ |

