MultiWayRibbons
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: the bands joining each gene's
placements in adjacent lanes.
Example usage
{ type: 'MultiWaySyntenyDisplay', ribbons: { encoding: { color: 'identity' } } }Curved sides, the linear synteny view's mark spelled the same:
{ type: 'MultiWaySyntenyDisplay', ribbons: { mark: { interpolate: 'bump' } } }Denser ribbons, and only the pairs at 98% identity or more, as the linear
synteny view's encoding.opacity and filter write them:
{
type: 'MultiWaySyntenyDisplay',
ribbons: {
encoding: { opacity: 0.6 },
filter: [{ field: 'identity', gte: 0.98 }],
},
}Config slots
A setting written to it names members one by one: a member left out stays as it is, and null resets one. 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 |
|---|---|
| encoding MultiWayRibbonsEncoding sub-schema |
The channels each ribbon paints through. |
| encoding.color RibbonColor |
{ value } paints every ribbon; "strand" the record's strand, "identity" a preset ramp and "group" a declared column. |
| encoding.opacity SyntenyOpacity |
A SyntenyOpacity object: 0.6 draws every ribbon at that opacity, a field fades each by its value; unset, 0.3. |
| mark SyntenyMark |
How each ribbon draws: interpolate picks straight or S-curved sides. |
| filter list of FieldPredicate entries |
The ribbons drawn, a list of FieldPredicate entries a ribbon must all pass. A field is any field color takes, or length, the record's bp. "Hide unlabelled rows" writes { field, valid: true } for the field the ribbons paint by. |