Skip to main content

Base1DView

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Built into JBrowse core. View source.

used in non-lgv view representations of a 1d view e.g. the two axes of the dotplot use this. categorized General rather than View because it is not a pluggable view type, which the name-suffix heuristic would otherwise assume

Properties

MemberDescription
id
id: ElementId
displayedRegions
displayedRegions: types.optional(types.frozen<IRegion[]>(), [])
bpPerPx
bpPerPx: 0
offsetPx
offsetPx: 0
minimumBlockWidth
minimumBlockWidth: types.stripDefault(types.number, 0)

Volatiles

MemberDescription
volatileWidth
volatileWidth: 0

Getters

MemberDescription
width
number
minBpPerPx
number		zoom-in floor; overridden by extensions (e.g. the dotplot axes)
maxBpPerPx
number		zoom-out ceiling; overridden by extensions (e.g. the dotplot axes)
assemblyNames
string[]
displayedRegionsTotalPx
number
maxOffset
number
minOffset
number
totalBp
number
dynamicBlocks
BlockSet
staticBlocks
BlockSet
currBp
number

Methods

MemberDescription
pxToBp
(px: number) => PxToBpResult
bpToPx
(args: { refName: string; coord: number; displayedRegionIndex?: number | undefined; }) => number | undefined

Actions

MemberDescription
setDisplayedRegions
(regions: Region[]) => void
setBpPerPx
(val: number) => void
setVolatileWidth
(width: number) => void
showAllRegions
() => void		this makes a zoomed out view that shows all displayedRegions that makes the overview bar square with the scale bar
zoomOut
() => void
zoomIn
() => void
zoomTo
(bpPerPx: number, offset?: any) => number
scrollTo
(offsetPx: number) => number
centerAt
(coord: number, refName: string | undefined, displayedRegionIndex: number) => void
scroll
(distance: number) => number		note: the scroll is clamped to keep the view on the main screen
moveTo
(start?: BpOffset | undefined, end?: BpOffset | undefined) => void
offset is the base-pair-offset in the displayed region, index is the index of the displayed region in the linear genome view