Skip to main content

FeatureColor

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Built into JBrowse core. View source.

Example usage

{ type: 'LinearBasicDisplay', color: 'goldenrod' }
{
  type: 'LinearBasicDisplay',
  color: { field: 'gene_biotype', range: ['#1f77b4', '#ff7f0e'] },
}

See the Config slots section below for all available configuration fields.

The canvas feature displays' color setting: a CSS colour or jexl: callback in value, or a field whose values each take a range colour, with a key. A string is the constant; the object binds the field, and scale: "none" beside a field paints the constant while keeping the field for the way back.

Config slots

These slots go on a display entry: "displays": [{ "type": "FeatureColor", ... }], 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
maybeColor		A CSS colour, or a jexl callback over feature returning one. Writing color: "red" or color: "jexl:…" lands here. Unset, a feature's own BED itemRgb paints it if it has one, else goldenrod.
callback args: feature
field
featureField = ''		a feature field, or a jexl expression over feature, whose values each paint one range colour with a key; a transcript and its parts paint the transcript's value, or its gene's where the transcript has none; strand paints forward tomato and reverse cornflowerblue unless domain or range says otherwise
scale
maybeStringEnum (none, categorical)		none paints value and keeps the field for a switch back; categorical a range colour per value of field; unset follows field
domain
stringArray = []		the values that take the range first, in order; a value left out keeps a colour derived from itself that no listed value paints, so every region agrees on it
range
colorArray = []		CSS colours the domain takes, in order, continuing into the default palette past its end