Skip to main content

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, mappingQual, 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.

SlotDescription
value
color = '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. Writing ribbonColor: "grey" lands here. Every field keeps its opacity.
field
string = ''		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, mappingQual 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)
scale
maybeStringEnum (none)		none paints value and keeps the field for a switch back; unset, a field paints
domain
stringArray = []		a text column's labels that take the palette first, in order, and lead the key, the rest following sorted; a label left out keeps a colour derived from itself that no listed label paints, so every window and session agrees on it