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 and what it reads out. Composing DensityTierMixin rather than sitting beside it forces the order, since every getter here keys off the swap the tier decides.

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

Volatiles

MemberDescriptionDefined by
densityHoverPx
densityHoverPx: undefined as number | undefined		The cursor's view px, not the bp under it: a wheel zoom under a stationary cursor fires no mousemove, and the px stays true through it.DensityBandMixin
coarseTier
coarseTier: regionDataMap<P>('coarseTier')		The coarse payload by displayedRegionIndex, over the regions the last read was issued for. Cleared on chromosome navigation.CoarseTierMixin
coarseTierRead
coarseTierRead: undefined as CoarseTierRead | undefined		What the held payloads were read over — the buffered regions and the read key — so a pan or a zoom inside them re-reads nothing. Undefined until a read lands.CoarseTierMixin
coarseTierLoading
coarseTierLoading: false		CoarseTierMixin

Getters

MemberDescriptionDefined by
coarseTierStandsIn
boolean		DensityBandMixin
densityBandLayer
DensityBandLayer		DensityBandMixin
densityHover
DensityHover | undefined		DensityBandMixin
densityPeakReadout
string		The band's line of text with no cursor over it, which is what the SVG export writes.DensityBandMixin
densityReadout
string		Blank until the first read lands, so the scrim is not captioned "no density data" for a read still in flight.DensityBandMixin
coarseAdapterSlot
string		DensityTierMixin
densityTierMode
"auto" | "density" | "features"		The densityTier slot's value.DensityTierMixin
densityTierThresholdBpPerPx
number		DensityTierMixin
coarseTierMode
CoarseTierMode		DensityTierMixin
coarseTierPastThreshold
boolean		auto also swaps from the densityTierBpPerPx slot outward, where a track asks for the band before the region is too large to fetch.DensityTierMixin
coarseReadKey
string		The bins are read at the view's bp/px, so a real zoom re-reads at the level the sidecar keeps for it and a small one reuses what is held.DensityTierMixin
coarseTierGated
boolean		Overridable hook (default false): the coarse read is a feature download the byte gate has to measure. The gate then measures the coarse adapter while the tier is up, its refusal is the banner, the detail fetch stands down outright since the coarse read is the measurement pass, and the swap is by threshold alone — the verdict is about whichever tier is up, so it cannot also pick the tier. A read bounded by construction (bins per screen pixel) leaves this off.CoarseTierMixin
coarseSourceConfig
unknown		The coarse source's config, read off the live track config so a re-pointed adapter follows.CoarseTierMixin
hasCoarseSource
boolean		CoarseTierMixin
coarseTierActive
boolean		Whether the coarse tier stands in for the detail right now.CoarseTierMixin
gateMeasuresCoarse
boolean		The byte gate is measuring the coarse read rather than the detail fetch, so its verdict is about the tier on screen.CoarseTierMixin
byteGateAdapterPath
string[]		RegionTooLargeMixin's hook: measure the adapter of the fetch that is about to run, so the estimate and the budget describe one file.CoarseTierMixin
gateRefusesDetail
boolean		The gate's refusal is about the detail fetch, so that fetch owes the re-measure the gate releases through.CoarseTierMixin
coarseTierIssueKey
string		The whole key a read is held under: the coarse adapter and the display's own term.CoarseTierMixin
fetchSuspended
boolean		MultiRegionDisplayMixin's hook, from resolveFetchSuspended over coarseTierStandsIn.CoarseTierMixin
displayPhase
DisplayPhase		The foundation's phase with the too-large banner swapped for the tier — see coarseTierDisplayPhase.CoarseTierMixin
svgReady
boolean		The export gate under the same swap — see coarseTierSvgReady.CoarseTierMixin
drawsWhenTooLarge
boolean		renderDisplaySvg's hook: the export paints the tier in place of the too-large note, the same swap the chrome makes on screen — unless the note is about the coarse read itself.CoarseTierMixin

Actions

MemberDescriptionDefined by
setDensityHoverPx
(px?: number | undefined) => void		Kept only while the band is up, so a pointer over features writes nothing here.DensityBandMixin
fetchCoarseTier
(read: CoarseTierRead, ctx: FetchContext) => Promise<CoarseTierResult<FeatureDensity>>
DensityTierMixin
setCoarseTier
(entries: CoarseTierEntry<P>[], read: CoarseTierRead) => void		CoarseTierMixin
clearCoarseTier
() => void		CoarseTierMixin
setCoarseTierLoading
(loading: boolean) => void		CoarseTierMixin