RowAnnotation
Auto-generated from the config schema in the source. See the config guide for concepts. Built into JBrowse core. View source.
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
{ type: 'LinearVariantDisplay', rows: { annotations: ['population', 'sex'] } }{
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. Slots a base configuration contributes are listed here too, so this table is the whole surface.
| Slot | Description |
|---|---|
fieldstring = '' |
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 RowAnnotationScale sub-schema |
Which color each value of the field takes: domain paired with range, the rest dealt from the column's own palette. |
scale.domain"the field's values that get a color, in order" |
The field's values that get a color, in order. |
| scale.range |
The CSS color each value in domain takes, in the same order; past them, the column's palette. |
| scale.unknown |
The color every row the scale leaves out takes; '' for none. |
| legend RowAnnotationLegend sub-schema |
The column's key. |
legend.titlemaybeString |
The title of the column's key and the label over its column; unset, the field capitalised. |