AlignmentsColor
Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the alignments plugin. View source.
Example usage
{ type: 'LinearAlignmentsDisplay', color: { field: 'strand' } }
{
type: 'LinearAlignmentsDisplay',
color: { field: 'tags.HP', domain: ['1', '2'], range: ['#d95f02', '#1b9e77'] },
}
{
type: 'LinearAlignmentsDisplay',
color: { field: 'tags.NM', scale: 'linear', scheme: 'viridis' },
}
{
type: 'LinearAlignmentsDisplay',
color: { field: 'insertSize', domain: ['150', '600'] },
}
See the Config slots section below for all available configuration fields.
The alignments displays' color setting: one colour for every read, or a
field each read carries. A read dimension paints its own vocabulary
(strand, firstOfPairStrand, pairOrientation, insertSize,
insertSizeAndOrientation, mateRefName) or ramp (mapq), tags.XX reads
a SAM tag and any other name a feature attribute. A string is the constant.
The per-base layer over the reads is
AlignmentsBaseColor.
Related links
- Extended by: LGVSyntenyColor
Config slots
These slots go on a display entry: "displays": [{ "type": "AlignmentsColor", ... }], or in the track's displayDefaults when this is its default display. 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 |
|---|---|
valuemaybeColor | The fill of every read while no field paints, and of a read carrying no value under a tag or attribute. Writing color: "steelblue" lands here. Unset, the theme's read colour. |
fieldstring = '' | what colours a read: strand, firstOfPairStrand, pairOrientation, insertSize, insertSizeAndOrientation, mateRefName and mapq paint their own vocabulary or ramp; tags.XX reads a SAM tag and any other name a feature attribute |
scalemaybeStringEnum (none, categorical, linear, threshold) | none paints value and keeps the field for a switch back; categorical a range colour per value; linear a ramp over a numeric tag or attribute between domainMin and domainMax; threshold the bins domain cuts; unset, threshold over insertSize and insertSizeAndOrientation and categorical over any other field |
domainstringArray = [] | for a categorical scale, the values that take the range first, in order; for a threshold scale, the cut points, which over insertSize are the two between short, normal and long, where the sampled distribution otherwise sets them |
domainMinmaybeNumber | the bottom of a linear or log scale's domain; unset follows the loaded values |
domainMaxmaybeNumber | the top of a linear or log scale's domain; unset follows the loaded values |
rangecolorArray = [] | CSS colours a categorical scale hands its domain in order, a threshold scale its bins, or a linear scale's stops, evenly spaced; empty is the tag palette or viridis |
schememaybeStringEnum (viridis) | a named ramp for a linear or log scale; range's colours, where it lists any, win over it |
reverseboolean = false | turns a linear or log scale's ramp round, so its last colour paints the bottom of the domain |
domainMidmaybeNumber | the value the ramp's middle stop sits at, so a diverging ramp centres somewhere other than the middle of the domain; unset, the stops are evenly spaced across it |