Skip to main content

CircularView

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​

extends

CircularView - Properties​

property: type​

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

property: offsetRadians​

similar to offsetPx in linear genome view

// type signature
number
// code
offsetRadians: defaultOffsetRadians

property: bpPerPx​

// type signature
number
// code
bpPerPx: defaultBpPerPx

property: tracks​

// type signature
IArrayType<any>
// code
tracks: types.array(
          pluginManager.pluggableMstType('track', 'stateModel'),
        )

property: hideVerticalResizeHandle​

// type signature
false
// code
hideVerticalResizeHandle: false

property: hideTrackSelectorButton​

// type signature
false
// code
hideTrackSelectorButton: false

property: lockedFitToWindow​

// type signature
true
// code
lockedFitToWindow: true

property: disableImportForm​

// type signature
false
// code
disableImportForm: false

property: height​

// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
height: types.optional(types.number, defaultHeight)

property: scrollX​

// type signature
number
// code
scrollX: 0

property: scrollY​

// type signature
number
// code
scrollY: 0

property: minimumRadiusPx​

// type signature
number
// code
minimumRadiusPx: defaultMinimumRadiusPx

property: spacingPx​

// type signature
number
// code
spacingPx: defaultSpacingPx

property: paddingPx​

// type signature
number
// code
paddingPx: defaultPaddingPx

property: lockedPaddingPx​

// type signature
number
// code
lockedPaddingPx: defaultLockedPaddingPx

property: minVisibleWidth​

// type signature
number
// code
minVisibleWidth: defaultMinVisibleWidth

property: minimumBlockWidth​

// type signature
number
// code
minimumBlockWidth: defaultMinimumBlockWidth

property: trackSelectorType​

// type signature
string
// code
trackSelectorType: 'hierarchical'

property: init​

used for initializing the view from a session snapshot

// type signature
IType<CircularViewInit, CircularViewInit, CircularViewInit>
// code
init: types.frozen<CircularViewInit | undefined>()

CircularView - Getters​

getter: width​

// type
number

getter: visibleSection​

// type
{
  rho: [number, number]
  theta: [number, number]
}

getter: circumferencePx​

// type
number

getter: radiusPx​

// type
number

getter: bpPerRadian​

// type
number

getter: pxPerRadian​

// type
any

getter: centerXY​

// type
;[number, number]

getter: totalBp​

// type
number

getter: maximumRadiusPx​

// type
number

getter: maxBpPerPx​

// type
number

getter: minBpPerPx​

// type
any

getter: atMaxBpPerPx​

// type
boolean

getter: atMinBpPerPx​

// type
boolean

getter: tooSmallToLock​

// type
boolean

getter: figureDimensions​

// type
;[number, number]

getter: figureWidth​

// type
any

getter: figureHeight​

// type
any

getter: elidedRegions​

this is displayedRegions, post-processed to elide regions that are too small to see reasonably

// type
SliceRegion[]

getter: assemblyNames​

// type
string[]

getter: initialized​

// type
any

getter: assemblyErrors​

// type
any

getter: error​

// type
unknown

getter: loadingMessage​

// type
string

getter: hasSomethingToShow​

// type
boolean

getter: showLoading​

Whether to show a loading indicator instead of the import form or view

// type
any

getter: showView​

Whether the view is fully initialized and ready to display

// type
any

getter: showImportForm​

Whether to show the import form (when not ready to display and import form is enabled, or when there's an error)

// type
boolean

getter: staticSlices​

// type
any[]

getter: visibleStaticSlices​

// type
any[]

CircularView - Methods​

method: menuItems​

return the view menu items

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

CircularView - Actions​

action: setWidth​

// type signature
setWidth: (newWidth: number) => number

action: setHeight​

// type signature
setHeight: (newHeight: number) => number

action: resizeHeight​

// type signature
resizeHeight: (distance: number) => number

action: resizeWidth​

// type signature
resizeWidth: (distance: number) => number

action: rotateClockwiseButton​

// type signature
rotateClockwiseButton: () => void

action: rotateCounterClockwiseButton​

// type signature
rotateCounterClockwiseButton: () => void

action: rotateClockwise​

// type signature
rotateClockwise: (distance?: number) => void

action: rotateCounterClockwise​

// type signature
rotateCounterClockwise: (distance?: number) => void

action: zoomInButton​

// type signature
zoomInButton: () => void

action: zoomOutButton​

// type signature
zoomOutButton: () => void

action: setBpPerPx​

// type signature
setBpPerPx: (newVal: number) => void

action: setModelViewWhenAdjust​

// type signature
setModelViewWhenAdjust: (secondCondition: boolean) => void

action: setDisplayedRegions​

// type signature
setDisplayedRegions: (regions: Region[]) => void

action: activateTrackSelector​

// type signature
activateTrackSelector: () => any

action: toggleTrack​

// type signature
toggleTrack: (trackId: string) => void

action: setError​

// type signature
setError: (error: unknown) => void

action: setInit​

// type signature
setInit: (init?: CircularViewInit) => void

action: showTrack​

// type signature
showTrack: (trackId: string, initialSnapshot?: {}) => void

action: addTrackConf​

// type signature
addTrackConf: (configuration: AnyConfigurationModel, initialSnapshot?: {}) => void

action: hideTrack​

// type signature
hideTrack: (trackId: string) => void

action: toggleFitToWindowLock​

// type signature
toggleFitToWindowLock: () => boolean

action: exportSvg​

creates an svg export and save using FileSaver

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