Skip to main content

DotplotView

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

DotplotView - Properties​

property: id​

// type signature
any
// code
id: ElementId

property: type​

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

property: height​

// type signature
number
// code
height: defaultHeight

property: borderSize​

// type signature
number
// code
borderSize: defaultBorderSize

property: tickSize​

// type signature
number
// code
tickSize: defaultTickSize

property: vtextRotation​

// type signature
number
// code
vtextRotation: 0

property: htextRotation​

// type signature
number
// code
htextRotation: defaultHtextRotation

property: fontSize​

// type signature
number
// code
fontSize: defaultFontSize

property: trackSelectorType​

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

property: assemblyNames​

// type signature
IArrayType<ISimpleType<string>>
// code
assemblyNames: types.array(types.string)

property: drawCigar​

// type signature
true
// code
drawCigar: true

property: hview​

// type signature
IOptionalIType<any, [undefined]>
// code
hview: types.optional(DotplotHView, {})

property: vview​

// type signature
IOptionalIType<any, [undefined]>
// code
vview: types.optional(DotplotVView, {})

property: tracks​

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

property: viewTrackConfigs​

this represents tracks specific to this view specifically used for read vs ref dotplots where this track would not really apply elsewhere

// type signature
IArrayType<any>
// code
viewTrackConfigs: types.array(pm.pluggableConfigSchemaType('track'))

property: init​

used for initializing the view from a session snapshot

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

DotplotView - Getters​

getter: width​

// type
number

getter: assemblyErrors​

// type
string

getter: assembliesInitialized​

// type
boolean

getter: initialized​

// type
boolean

getter: hticks​

// type
any[]

getter: vticks​

// type
any[]

getter: hasSomethingToShow​

// type
boolean

getter: showLoading​

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

// type
boolean

getter: showImportForm​

Whether to show the import form

// type
boolean

getter: loadingMessage​

// type
string

getter: viewWidth​

// type
number

getter: viewHeight​

// type
number

getter: views​

// type
any[]

getter: error​

// type
unknown

DotplotView - Methods​

method: renderProps​

// type signature
renderProps: () => any

method: menuItems​

// type signature
menuItems: () => { label: string; onClick: () => any; icon: any; }[]

DotplotView - Actions​

action: importFormRemoveRow​

// type signature
importFormRemoveRow: (idx: number) => void

action: clearImportFormSyntenyTracks​

// type signature
clearImportFormSyntenyTracks: () => void

action: setImportFormSyntenyTrack​

// type signature
setImportFormSyntenyTrack: (arg: number, val: ImportFormSyntenyTrack) => void

action: setShowPanButtons​

// type signature
setShowPanButtons: (flag: boolean) => void

action: setWheelMode​

// type signature
setWheelMode: (str: string) => void

action: setCursorMode​

// type signature
setCursorMode: (str: string) => void

action: setDrawCigar​

// type signature
setDrawCigar: (flag: boolean) => void

action: clearView​

returns to the import form

// type signature
clearView: () => void

action: setBorderX​

// type signature
setBorderX: (n: number) => void

action: setBorderY​

// type signature
setBorderY: (n: number) => void

action: setWidth​

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

action: setHeight​

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

action: setError​

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

action: setInit​

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

action: zoomOut​

// type signature
zoomOut: () => void

action: zoomIn​

// type signature
zoomIn: () => void

action: activateTrackSelector​

// type signature
activateTrackSelector: () => any

action: showTrack​

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

action: hideTrack​

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

action: toggleTrack​

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

action: setAssemblyNames​

// type signature
setAssemblyNames: (target: string, query: string) => void

action: setViews​

// type signature
setViews: (arr: any[]) => void

action: getCoords​

// type signature
getCoords: (mousedown: Coord, mouseup: Coord) => any[]

action: zoomInToMouseCoords​

zooms into clicked and dragged region

// type signature
zoomInToMouseCoords: (mousedown: Coord, mouseup: Coord) => void

action: calculateBorders​

Calculate borders synchronously for a given zoom level

// type signature
calculateBorders: () => {
  borderX: number
  borderY: number
}

action: showAllRegions​

// type signature
showAllRegions: () => void

action: initializeDisplayedRegions​

// type signature
initializeDisplayedRegions: () => void

action: onDotplotView​

creates a linear synteny view from the clicked and dragged region

// type signature
onDotplotView: (mousedown: Coord, mouseup: Coord) => void

action: exportSvg​

creates an svg export and save using FileSaver

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

action: squareView​

// type signature
squareView: () => void

action: squareViewProportional​

// type signature
squareViewProportional: () => void