Skip to main content

ReadConnectionsStrokeWidth

Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the alignments plugin. View source.

The read connections' encoding.strokeWidth, the width each arc or line strokes at. By default each connection's reads, the reads that agree on it, run through a log scale from 1 px at one read to 4 px at 44 or more, so each doubling adds the same width. A number is the constant every connection takes, whatever its reads, and is written to value.

Example usage

{
  type: 'LinearAlignmentsDisplay',
  readConnections: { show: true, encoding: { strokeWidth: 2 } },
}
{
  type: 'LinearAlignmentsDisplay',
  readConnections: {
    show: true,
    encoding: { strokeWidth: { field: 'reads', scale: { range: [1, 8] } } },
  },
}

Config slots

A setting written to it replaces it whole, since its members are alternatives: 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.

SlotDescription
value
maybeNumber		The px every connection strokes at while no field is written; the Line width menu writes it. Unset, reads maps through the scale.
field
maybeStringEnum (reads)		reads, the reads that agree on a connection, the one count a width reads; a written field maps through scale over any value.
scale
ConfigurationSchema(
  'ReadConnectionsStrokeWidthScale',
  {
    type: {
      type: 'stringEnum',
      model: types.enumeration('ReadConnectionsStrokeWidthScaleType', [
        ...READ_CONNECTIONS_WIDTH_SCALES,
      ]),
      defaultValue: 'log',
      description:
        'log adds the same width per doubling of reads; linear the same per read',
    },
    range: {
      type: 'stringArray',
      defaultValue: [],
      description: 'px at one read and at 44; empty is 1 to 4',
    },
  },
  {
    closed: true,
    preProcessSnapshot: (snap: Record<string, unknown> = {}) =>
      Array.isArray(snap.range)
        ? { ...snap, range: snap.range.map(String) }
        : snap,
  },
)
How reads map to a width: from one read to 44, past which more reads add no width.
type
stringEnum (log, linear) = 'log'		log adds the same width per doubling of reads; linear the same per read
range
stringArray = []		The px at one read and at 44, thinnest first. Empty is 1 to 4.