Skip to main content

LinearReadArcsDisplaySettingsMixin

Note: this document is automatically generated from @jbrowse/mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info

Also note: this document represents the state model API for the current released version of jbrowse. If you are not using the current version, please cross reference the markdown files in our repo of the checked out git tag

Source code

GitHub page

Docs​

Mixin for LinearReadArcsDisplay-specific settings Contains arc rendering options like line width, jitter, and connection toggles

LinearReadArcsDisplaySettingsMixin - Properties​

property: lineWidth​

Width of the arc lines (thin, bold, extra bold)

// type signature
IMaybe<ISimpleType<number>>
// code
lineWidth: types.maybe(types.number)

property: jitter​

Jitter amount for x-position to better visualize overlapping arcs

// type signature
IMaybe<ISimpleType<number>>
// code
jitter: types.maybe(types.number)

property: drawInter​

Whether to draw inter-region vertical lines

// type signature
true
// code
drawInter: true

property: drawLongRange​

Whether to draw long-range connections

// type signature
true
// code
drawLongRange: true

LinearReadArcsDisplaySettingsMixin - Getters​

getter: lineWidthSetting​

// type
any

getter: jitterVal​

// type
number

LinearReadArcsDisplaySettingsMixin - Actions​

action: setDrawInter​

Toggle drawing of inter-region vertical lines

// type signature
setDrawInter: (f: boolean) => void

action: setDrawLongRange​

Toggle drawing of long-range connections

// type signature
setDrawLongRange: (f: boolean) => void

action: setLineWidth​

Set the line width (thin=1, bold=2, extrabold=5, etc)

// type signature
setLineWidth: (n: number) => void

action: setJitter​

Set jitter amount for x-position Helpful to jitter the x direction so you see better evidence when e.g. 100 long reads map to same x position

// type signature
setJitter: (n: number) => void