Skip to main content

LinearSyntenyView

Note: this document is automatically generated from 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​

extends

LinearSyntenyView - Properties​

property: type​

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

property: /​

// type signature
true
// code
drawCIGAR: true

property: drawCurves​

// type signature
false
// code
drawCurves: false

LinearSyntenyView - Methods​

method: headerMenuItems​

includes a subset of view menu options because the full list is a little overwhelming

// type signature
headerMenuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMenuItem | RadioMenuItem | SubMenuItem | { ...; } | { ...; } | { ...; })[]

method: menuItems​

// type signature
menuItems: () => MenuItem[]

LinearSyntenyView - Actions​

action: toggleCurves​

// type signature
toggleCurves: () => void

action: toggleCIGAR​

// type signature
toggleCIGAR: () => void

action: showAllRegions​

// type signature
showAllRegions: () => void

action: exportSvg​

// type signature
exportSvg: (opts: ExportSvgOptions) => Promise<void>