RibbonColor
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the linear-comparative-view plugin. View source.
The multi-way synteny display's ribbons.encoding.color: one color for
every ribbon, or a field each ribbon carries: the record's strand (the
default, while the channel names neither a field nor a color), a
measurement through its preset (identity, mapq, dnds,
syntenicDepth), or a column the table declares in attributeColumns,
through the same slots as the synteny view's
SyntenyColor. A string is the field.
Example usage
{
type: 'MultiWaySyntenyDisplay',
ribbons: { encoding: { color: { value: 'grey' } } },
}{ type: 'MultiWaySyntenyDisplay', ribbons: { encoding: { color: 'strand' } } }{
type: 'MultiWaySyntenyDisplay',
ribbons: {
encoding: {
color: {
field: 'strand',
scale: {
domain: ['1', '-1'],
range: ['#1b9e77', '#d95f02'],
names: ['Kept', 'Inverted'],
},
},
},
},
}{
type: 'MultiWaySyntenyDisplay',
ribbons: {
encoding: {
color: {
field: 'group',
scale: { domain: ['core', 'shell'], invalid: 'lightgrey' },
},
},
},
}Preset fields
A field named here paints through its own scale while scale.type is unset, and range and names index its levels in order while domain is unwritten.
| Field | Scale | Levels | Names | Other defaults |
|---|---|---|---|---|
mapq |
threshold | 1, 10, 30 |
MAPQ 0 (multi-mapping), MAPQ 1-9 (low), MAPQ 10-29, MAPQ 30+ (high confidence) | scheme: cividis; key "Mapping quality" |
identity |
linear | domainMin: 0; domainMax: 1; scheme: redgreyblue; key "Identity" |
||
dnds |
linear | domainMin: 0; domainMax: 2; domainMid: 1; scheme: redyellowblue; reverse: true; key "dN/dS" |
||
syntenicDepth |
threshold | 2, 3 |
One-to-one, Shared by 2 genes, Shared by 3 or more | range: #bdbdbd, #fdae6b, #e6550d; key "Syntenic depth" |
strand |
ordinal | 1, -1, 0 |
Forward strand, Reverse strand, No strand | range: tomato, cornflowerblue, goldenrod |
Config slots
A setting written to it replaces it whole: a member left out returns to its default. 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 color of every ribbon while no field paints. |
| scale RibbonColorScale sub-schema |
How the field's values map to colors, Vega-Lite's scale object. |
| legend RibbonColorLegend sub-schema |
The key this channel draws. |
fieldstring = '' |
field to color each ribbon by: strand reads the relative strand between the two lanes the ribbon joins (the two placements' orientations multiplied out, not the drawn twist, so a flipped lane still shows its inversions); identity and dnds paint their preset ramps, mapq its bins and syntenicDepth one-to-one against shared orthologs, as the synteny view's do; any other name is a column the table declares in attributeColumns, a ramp over the values seen for numbers and one color per label for text (or the color a color column put beside it) |
scale.typemaybeStringEnum ('linear', 'threshold', 'ordinal') |
linear runs a number along a ramp, threshold bins it at the cuts domain lists, and ordinal paints a column's values one color each, numbers included (a measurement keeps its preset); a written type wins over the values, so a text value under linear or threshold paints as missing; unset, a measurement uses its preset scale and a column linear for numbers and ordinal once a value is text |
scale.domainstringArray of strings or numbers = [] |
a text column's labels that take the palette first, in order, and lead the key, the rest following sorted, strand's values (1, -1) in the order range colors them, or a threshold's cuts; a label left out takes a color no listed label or label met before it paints, the first time the view meets it, and keeps it |
scale.rangecolorArray = [] |
CSS colors a text column's labels or strand's values take, in domain order, continuing past its end into the scheme where one is set, else the default palette; with no domain, each label takes one of them by its name; on a ramp (identity, dnds or a numeric column), its stops, evenly spaced, in place of the field's default stops; under threshold, one per interval |
scale.schememaybeStringEnum ('viridis', 'magma', 'inferno', 'cividis', 'juicebox', 'fall', 'reds', 'blues', 'redblue', 'purpleorange', 'redgreyblue', 'redyellowblue') |
a named ramp: a ramp scale colors along it; a threshold scale that writes cuts gives each interval one color from end to end; an ordinal scale that lists a domain gives each value one color; range's colors, where it lists any, win over it |
scale.reversemaybeBoolean |
turns the ramp round, so its last color paints the bottom of a ramp's domain or a threshold's lowest interval; unset follows the field's preset, else runs as written |
scale.domainMidmaybeNumber |
the value the ramp's middle stop sits at, so a diverging ramp centres somewhere other than the middle of the domain, both sides on one scale: the farther end of the domain reaches its end color and equal distances from the middle take equal colors; unset, the stops are evenly spaced across it |
scale.domainMinmaybeNumber |
the bottom of a ramp's domain; unset follows the loaded values |
scale.domainMaxmaybeNumber |
the top of a ramp's domain; unset follows the loaded values |
scale.namesstringArray of strings or numbers = [] |
key name for each domain value, one each in order, or under threshold for each interval from the lowest; a value past the end of the list shows its own |
scale.unknownmaybeColor |
color for a value missing from domain. Unset: the next palette color where the display deals one, and the levels a preset field names, such as strand's, keep their own colors. A color: that color. "": no color dealt, so a feature paints the no-value grey, a variant cell the alt hue, and a row keeps the color it already has |
scale.invalidmaybeColor |
color for a feature with no value under an ordinal scale's field; unset, the display's no-value color |
legend.titlemaybeString |
key title; unset keeps the display's own heading, "" draws none |
legend.descendingmaybeBoolean |
threshold key lists the highest interval first; unset follows the field's preset, else the lowest first |