RibbonColor
Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the linear-comparative-view plugin. View source.
Example usage
{ type: 'MultiWaySyntenyDisplay', ribbonColor: 'rgba(130,130,130,0.3)' }{ type: 'MultiWaySyntenyDisplay', ribbonColor: { field: 'strand' } }{
type: 'MultiWaySyntenyDisplay',
ribbonColor: { field: 'group', domain: ['core', 'shell'] },
}See the Config slots section below for all available configuration fields.
The multi-way synteny display's ribbonColor setting: one colour for every
ribbon, or a field each ribbon carries: the record's strand, a measurement
on its preset ramp (identity, mapq, dnds), or a column the
table declares in attributeColumns. A string is the constant.
Config slots
These slots go on a display entry: "displays": [{ "type": "RibbonColor", ... }], 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 |
|---|---|
valuecolor = 'rgba(130,130,130,0.3)' | The colour of every ribbon under the none scale, and of a pair carrying no value under a field. |
fieldstring = '' | what colours a ribbon: 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, mapq and dnds paint the synteny view's ramps; any other name is a column the table declares in attributeColumns, a ramp over the values seen for numbers and one colour per label for text (or the colour a color column put beside it) |
scalemaybeStringEnum (none) | none paints value and keeps the field for a switch back; unset, a field paints |
domainstringArray = [] | a text column's labels that take the palette first, in order, and lead the key, the rest following sorted; a label left out takes a colour no listed label or label met before it paints, the first time the view meets it, and keeps it |
rangecolorArray = [] | CSS colours a text column's labels take, in domain order, continuing into the default palette past its end; with no domain, each label takes one of them by its name; on a ramp (identity, mapq, dnds or a numeric column), its stops, evenly spaced, in place of the field's own |
schememaybeStringEnum (viridis, magma, inferno, cividis, juicebox, fall, reds, blues, redblue, purpleorange, redgreyblue) | 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, both sides on one scale: the farther end of the domain reaches its end colour and equal distances from the middle take equal colours; unset, the stops are evenly spaced across it |
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 |
labelsstringArray = [] | what the key names each domain value, one each in order, or under threshold each interval from the lowest; one past the list keeps its own name |
titlemaybeString | key title; unset keeps the display's own heading, "" draws none |