GlobalFetchMixin
Auto-generated from the @jbrowse/mobx-state-tree model in the source. See the developer guide for concepts. Built into JBrowse core. View source.
The foundation for a display holding one non-regional dataset: HiC's contact
matrix, the LD triangle, multi-way synteny's lanes. Composes
RegionTooLargeMixin, RenderLifecycleMixin and KeyedFetchMixin, and adds
the host, the block signatures and the readiness getters that read the view.
It installs no autoruns: each display installs its fetch with
installGlobalFetchAutorun.
Each section ends with the members a composed model contributes, linked to the page that documents them.
Volatiles
19 inherited volatiles from 4 models
From KeyedFetchMixin: loadedFetchKey
From FetchMixin: activeSignal, fetchGeneration, reloadCounter, statusWindow, error, statusMessage, statusProgress, fetchCanceled, fetchRotation
From RenderLifecycleMixin: canvasDrawn, paintCount, currentRenderingBackend, renderTick, renderError, offScreen
From RegionTooLargeMixin: forceLoadTrack, byteEstimate, gateMeasuredViewportKey
Getters
| Member | Description |
|---|---|
hostRegionHost |
The view this display reads regions, viewport and scale from; see containingHost. |
canvasWidthPxnumber |
The CSS width of this display's on-screen canvas, in px; see trackCanvasWidthPx. A heatmap laid out over the whole content reads the content width instead (TriangleMatrixMixin.canvasWidth). |
staticBlockSignaturestring | undefined |
The static-block set as a signature, undefined before the view is measured: what a viewSignature starts from. HiC appends its resolution. |
dynamicBlockSignaturestring | undefined |
The same over dynamicBlocks, for a display whose fetch window is the live viewport rather than the snapped block set (LD). |
viewportEmptyboolean |
No content block is on screen, so there is nothing to fetch or paint; see viewportEmpty.ts. |
canRenderboolean |
RenderLifecycleMixin's hook: the view has initialized. |
rendersCanvasboolean |
RenderLifecycleMixin's hook: a display that will not fetch shows a placeholder where its canvas would be. |
paintInertboolean |
RenderLifecycleMixin's paintInert hook; see foundationPaintInert. Overridable for a further inert state. |
svgReadyboolean |
An SVG export can read this display's data; off-screen renderers wait on it through awaitSvgReady(model). See foundationSvgReady. |
displayPhaseDisplayPhase |
The display's visual state, mapped by foundationDisplayPhase. This family's staleness argument is the constant true: the last frame is genomic and draws correctly under the live view, so a pan or zoom shows no scrim beyond the isLoading window. A displayed-regions change drops the frame instead (clearForDisplayedRegions). |
34 inherited getters from 4 models
From KeyedFetchMixin: viewSignature, dataSuperseded, currentFetchKey, dataCurrent
From FetchMixin: isLoading, isLoadingOrCanceled, fetchInert, awaitingPrerequisite, awaitingDependentData, fetchHeld, settingsFetchInputs
From RenderLifecycleMixin: paintSuperseded, painted
From RegionTooLargeMixin: gateEnabled, byteGateAdapterConfig, densityTooLarge, byteGateAdapterPath, adapterFetchSizeLimit, gateViewportSpanBp, gateViewport, configuredFetchSizeLimit, configForceLoad, aboveForceLoadFloor, gateExempt, estimatedFetchBytes, gateByteLimit, gateActive, gateMeasurementStale, densityGateActive, tooLargeStatus, regionTooLarge, regionTooLargeReason, zoomCanReleaseGate, gateSkipsMeasuredViewport
Methods
2 inherited methods from one model
Actions
| Member | Description |
|---|---|
clearDisplaySpecificData() => void |
Overridable hook (no-op base): drop the payload this display holds for its displayed regions. Called by clearForDisplayedRegions. |
clearForDisplayedRegions() => void |
installGlobalFetchAutorun's reset on a displayed-regions change: supersede the in-flight fetch, so its landing commits nothing, and drop the held payload, its key and the canvas-drawn flag, so the display reads loading until the new regions' fetch lands. A payload is placed along the displayed regions, so held past the change it would draw on the wrong sequence. A standing user cancel is left to the viewport-change lapse. |
25 inherited actions from 4 models
From KeyedFetchMixin: commitFetchResult, reload
From FetchMixin: setError, setStatusMessage, stopActiveFetch, openStatusStream, cancelFetch, cancelFetchByUser, beforeDestroy, beginFetch, endFetch, lapseHeldFetch, runFetch
From RenderLifecycleMixin: markCanvasDrawn, resetCanvasDrawn, stopRenderingBackend, renderNow, setOffScreen, setRenderError, attachRenderingBackend
From RegionTooLargeMixin: clearByteEstimate, clearGateMeasurements, setForceLoadTrack, commitFetchBytes, forceLoad