# RowAnnotation

Auto-generated from the config schema in the source. See the [config guide](https://jbrowse.org/jb2/docs/config_guide) for concepts. Built into JBrowse core. [View source](https://github.com/GMOD/jbrowse-components/blob/main/packages/display-kit/src/rowAnnotationConfigSchema.ts).

One entry of `rows.annotations`: a color column beside the row labels, the
row attribute `field` through a categorical `scale` as `rows.color` deals
one, with a key of its own titled `legend.title`. A string is the field.
An entry naming no field, or `name`, which the label already shows, is
refused.

## Example usage

```js
{ type: 'LinearVariantDisplay', rows: { annotations: ['population', 'sex'] } }
```

```js
{
  type: 'LinearVariantDisplay',
  rows: {
    annotations: [
      {
        field: 'sex',
        scale: { domain: ['female', 'male'], range: ['#d95f02', '#1b9e77'] },
        legend: { title: 'Sex (reported)' },
      },
    ],
  },
}
```

## Config slots

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 |
| --- | --- |
| **field**<br>[`string`](https://jbrowse.org/jb2/docs/config_guides/slot_types#string) = <code>''</code> | The row attribute whose values take the column's colors: a column of a multi-sample adapter's `samplesTsvLocation`, such as `population`, or a subtrack's `group`. |
| **scale**<br>[RowAnnotationScale sub-schema](#slot-scaledomain) | Which color each value of the field takes: `domain` paired with `range`, the rest dealt from the column's own palette. |
| **scale.domain**<br><code>"the field's values that get a color, in order"</code> | The field's values that get a color, in order. |
| **scale.range**<br><code>"the CSS color each value in domain takes, in the same order; past them, the column's palette"</code> | The CSS color each value in `domain` takes, in the same order; past them, the column's palette. |
| **scale.unknown**<br><code>'a color: every row the scale leaves out takes it. Unset: each value deals the next color of the column\'s palette; "" leaves the rows domain does not list without a color'</code> | The color every row the scale leaves out takes; `''` for none. |
| **legend**<br>[RowAnnotationLegend sub-schema](#slot-legendtitle) | The column's key. |
| **legend.title**<br>[`maybeString`](https://jbrowse.org/jb2/docs/config_guides/slot_types#the-maybe-types) | The title of the column's key and the label over its column; unset, the field capitalised. |