Skip to main content

LinearReadArcsDisplay

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​

the arc display is a non-block-based track, so draws to a single canvas and can connect multiple regions extends

LinearReadArcsDisplay - Properties​

property: type​

// type signature
ISimpleType<"LinearReadArcsDisplay">
// code
type: types.literal('LinearReadArcsDisplay')

property: configuration​

// type signature
any
// code
configuration: ConfigurationReference(configSchema)

property: showLegend​

// type signature
IMaybe<ISimpleType<boolean>>
// code
showLegend: types.maybe(types.boolean)

LinearReadArcsDisplay - Getters​

getter: colorBy​

Get the color settings (from override or configuration)

// type
any

getter: filterBy​

Get the filter settings (from override or configuration)

// type
any

LinearReadArcsDisplay - Methods​

method: legendItems​

Returns legend items based on current colorBy setting

// type signature
legendItems: () => LegendItem[]

method: svgLegendWidth​

Returns the width needed for the SVG legend if showLegend is enabled. Used by SVG export to add extra width for the legend area.

// type signature
svgLegendWidth: () => number

method: renderProps​

// type signature
renderProps: () => any

method: trackMenuItems​

// type signature
trackMenuItems: () => any[]

method: renderSvg​

// type signature
renderSvg: (opts: ExportSvgDisplayOptions) => Promise<React.ReactNode>

LinearReadArcsDisplay - Actions​

action: setShowLegend​

// type signature
setShowLegend: (s: boolean) => void

action: reload​

Reload the display (clears error state)

// type signature
reload: () => void