Skip to main content

DensityBandMixin

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Provided by the canvas plugin. View source.

The density band: where the cursor is over it, what it draws, what it reads out, and the three foundation getters the band stands in for the too-large banner in.

Composes DensityTierMixin rather than sitting beside it, because the swap it decides is what every getter here keys off — a display taking the band takes the tier, in that order, and cannot compose them the wrong way round. A display with its own stand-in for the banner takes the tier alone, which is what LinearAlignmentsDisplay does.

Composed after the fetch foundation, whose displayPhase / svgReady it post-processes — types.compose resolves a collision to the later argument.

Members a composed model contributes are listed here too, so these tables are the whole surface.

Volatiles

MemberDescriptionDefined by
densityHover
densityHover: undefined as DensityHover | undefined		Where the cursor is over the density band, for its readout.DensityBandMixin
densityBins
densityBins: regionDataMap<FeatureDensity>('densityBins')		Features per bin by displayedRegionIndex, at the zoom bucket the last read was issued for. Cleared on chromosome navigation.DensityTierMixin
densityBinsRead
densityBinsRead: undefined as DensityRead | undefined		What the held bins were read over: the buffered regions, the zoom bucket and the adapter, so a pan or a zoom inside them re-reads nothing. Undefined until a read lands.DensityTierMixin
densityLoading
densityLoading: false		DensityTierMixin

Getters

MemberDescriptionDefined by
densityBandActive
boolean		Whether the band stands in for the features here — the tier's own decision, plus the view geometry the draw is mapped through.DensityBandMixin
densityBandLayer
DensityBandLayer		DensityBandMixin
densityPeakReadout
string		The band's line of text with no cursor over it: its peak alone, which is what the SVG export writes.DensityBandMixin
densityReadout
string		The band's line of text: its peak, and the source's value under the cursor while there is one. Blank until the first read lands, so the scrim is not captioned "no density data" for a read still in flight.DensityBandMixin
displayPhase
DisplayPhase		The foundation's phase with the too-large banner swapped for the band — see densityBandDisplayPhase.DensityBandMixin
svgReady
boolean		The export gate with the same swap — see densityBandSvgReady.DensityBandMixin
drawsWhenTooLarge
boolean		renderDisplaySvg's hook: the export paints the band in place of the too-large note, the same swap the chrome makes on screen.DensityBandMixin
densitySourceConfig
unknown		The densityAdapter slot of the adapter the gate measures, read off the live track config so a tiered display's swap follows it.DensityTierMixin
densityTierMode
"auto" | "density" | "features"		DensityTierMixin
densityTierThresholdBpPerPx
number		DensityTierMixin
densityBinsKey
string | undefined		The key of the read the held bins came from, which the fetch skeleton compares an issue against; undefined until a read lands.DensityTierMixin
hasDensitySource
boolean		DensityTierMixin
densityTierActive
boolean		Whether the band stands in for features right now.DensityTierMixin
fetchSuspended
boolean		MultiRegionDisplayMixin's hook, from resolveFetchSuspended over the tier's verdict. A display whose band needs somewhere to draw (alignments, whose coverage band can be hidden) overrides it with that term.DensityTierMixin

Actions

MemberDescriptionDefined by
setDensityHoverPx
(px?: number | undefined) => void		The cursor's view px, or nothing when it leaves. Kept only while the band is up, so a pointer over features writes nothing here.DensityBandMixin
setDensityBins
(entries: { displayedRegionIndex: number; bins: FeatureDensity; }[], read: DensityRead) => void
DensityTierMixin
clearDensityBins
() => void		DensityTierMixin
setDensityLoading
(loading: boolean) => void		DensityTierMixin