Skip to main content

MultiLinearWiggleDisplay

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

MultiLinearWiggleDisplay - Properties​

property: type​

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

property: layout​

// type signature
IOptionalIType<IType<Source[], Source[], Source[]>, [undefined]>
// code
layout: types.optional(types.frozen<Source[]>(), [])

MultiLinearWiggleDisplay - Getters​

getter: featureUnderMouse​

// type
Feature

getter: TooltipComponent​

// type
React.ComponentType<any>

getter: rendererTypeName​

// type
string

getter: needsScalebar​

// type
boolean

getter: needsFullHeightScalebar​

// type
boolean

getter: isMultiRow​

// type
boolean

getter: needsCustomLegend​

can be used to give it a "color scale" like a R heatmap, not implemented like this yet but flag can be used for this

// type
boolean

getter: canHaveFill​

// type
boolean

getter: renderColorBoxes​

the multirowxy and multiline don't need to use colors on the legend boxes since their track is drawn with the color. sort of a stylistic choice

// type
boolean

getter: prefersOffset​

positions multi-row below the tracklabel even if using overlap tracklabels for everything else

// type
any

getter: sources​

// type
{ color: string; baseUri?: string; name: string; group?: string; }[]

getter: quantitativeStatsReady​

// type
boolean

getter: rowHeight​

// type
number

getter: rowHeightTooSmallForScalebar​

// type
boolean

getter: useMinimalTicks​

// type
any

getter: ticks​

// type
{ range: number[]; values: number[]; format: (d: NumberValue) => string; position: ScaleLinear<number, number, never> | ScaleQuantize<number, never>; }

getter: colors​

// type
string[]

getter: quantitativeStatsRelevantToCurrentZoom​

unused currently

// type
boolean

getter: hasResolution​

// type
boolean

getter: hasGlobalStats​

// type
boolean

getter: fillSetting​

// type
;0 | 1 | 2

MultiLinearWiggleDisplay - Methods​

method: adapterProps​

// type signature
adapterProps: () => any

method: renderProps​

// type signature
renderProps: () => any

method: trackMenuItems​

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

MultiLinearWiggleDisplay - Actions​

action: setLayout​

// type signature
setLayout: (layout: Source[]) => void

action: clearLayout​

// type signature
clearLayout: () => void

action: setSources​

// type signature
setSources: (sources: Source[]) => void

action: setFeatureUnderMouse​

// type signature
setFeatureUnderMouse: (f?: Feature) => void

action: renderSvg​

// type signature
renderSvg: (opts: ExportSvgDisplayOptions) => Promise<Element>