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: {
          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.

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.