Skip to main content

CircularView

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

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: -Math.PI / 2

property: bpPerPx​

// type signature
number
// code
bpPerPx: 200

property: tracks​

// type signature
IArrayType<IAnyType>
// 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: 25

property: spacingPx​

// type signature
number
// code
spacingPx: 10

property: paddingPx​

// type signature
number
// code
paddingPx: 80

property: lockedPaddingPx​

// type signature
number
// code
lockedPaddingPx: 100

property: minVisibleWidth​

// type signature
number
// code
minVisibleWidth: 6

property: minimumBlockWidth​

// type signature
number
// code
minimumBlockWidth: 20

property: trackSelectorType​

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

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
number

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: 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: SnapshotOrInstance<IModelType<{ refName: ISimpleType<string>; start: ISimpleType<number>; end: ISimpleType<number>; reversed: IOptionalIType<ISimpleType<boolean>, [...]>; } & { ...; }, { ...; }, _NotCustomized, _NotCustomized>>[]) => void

action: activateTrackSelector​

// type signature
activateTrackSelector: () => Widget

action: toggleTrack​

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

action: setError​

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

action: showTrack​

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

action: addTrackConf​

// type signature
addTrackConf: (configuration: { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>, initialSnapshot?: {}) => void

action: hideTrack​

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

action: toggleFitToWindowLock​

// type signature
toggleFitToWindowLock: () => boolean

action: exportSvg​

creates an svg export and save using FileSaver

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