Skip to main content

RegionTooLargeMixin

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Built into JBrowse core. View source.

The region-too-large gate: a display opts in by overriding gateEnabled and passing byteLimit: self.resolvedByteLimit() to its fetch RPC. The RPC measures the index before it downloads and answers a refusal when a region is over budget; the fetch runners commit what it measured, and regionTooLarge is derived from that last measurement. While the banner is up the fetch runs once per settled viewport, which is the re-measure. Composed by MultiRegionDisplayMixin and GlobalFetchMixin. The rules and the numbers behind them: agent-docs/reference/REGION_TOO_LARGE.md.

Volatiles

MemberDescription
forceLoadTrack
forceLoadTrack: false		The force-load button's track-wide approval. Volatile so it never reaches a saved session; the forceLoad config slot is the durable form.
byteEstimate
byteEstimate: undefined as ByteEstimate | undefined		The last byte measurement: bytes, the span they were taken at, and whether zooming has been shown not to shrink them. Survives clearAllRpcData; dropped on chromosome navigation and on a tier swap.
gateMeasuredViewportKey
gateMeasuredViewportKey: undefined as string | undefined		The viewport key the gate last asked the adapter about, on either axis. Separate from byteEstimate because a density refusal measures no bytes.

Getters

MemberDescription
gateEnabled
boolean		The opt-in. Overridden with a literal true by gated displays, and check-gated-adapter-budgets insists on a literal: this mixin returns early on it in an autorun and in commitFetchBytes.
densityGateEnabled
boolean		Whether the density axis applies. CanvasFeatureGateMixin contributes true beside its measurement; byte-only displays leave it.
byteGateAdapterConfig
Record<string, unknown>		The adapter config the gate measures — the one at byteGateAdapterPath. Overridable for a display whose adapter config is synthesized rather than read off the track.
configuredFetchSizeLimit
number		The display's fetchSizeLimit slot, from regionTooLargeConfigSchemaFields.
densityTooLarge
boolean		The density axis's verdict; canvas overrides it.
byteGateAdapterPath
string[]		Where on the track config the measured adapter sits. A tiered display overrides this one hook (MAF: ['adapter', 'summaryAdapter'] while showSummary), and both the measurement and the budget follow it.
adapterFetchSizeLimit
number | undefined		The measured adapter's own fetchSizeLimit slot, read off the live track config rather than the adapterConfig snapshot, which omits slots at their default.
configForceLoad
boolean		The declarative forceLoad slot.
gateViewport
GateViewport | undefined		What a measurement taken now would be about: the span on screen and a key for the stretch of genome it covers. Undefined until the view is measured, and the mixin's only read of the view. Captured before the fetch's round trip, never at commit.
byteGateAdapterKey
string		Which tier the estimate is about, as a comparable string.
aboveForceLoadFloor
boolean		Whether the span on screen is at or above AUTO_FORCE_LOAD_BP, the one comparison against that constant. False on an unmeasured view.
gateExempt
boolean		Nothing may gate on either axis: the forceLoad slot or the button.
estimatedFetchBytes
number | undefined		The stored estimate's bytes; undefined when nothing has been measured.
gateMeasurementStale
boolean		Whether the last measurement is about a viewport the user has since left. True before any measurement.
gateByteLimit
number		The byte budget: the adapter's limit, else the display's, doubled below AUTO_FORCE_LOAD_BP. Read only through resolvedByteLimit().
gateActive
boolean		Whether the gate may act right now, on any axis: opted in, not exempt, view measured. The view is read last, so an ungated display never touches it.
densityGateActive
boolean		gateActive plus the density axis's own terms: the axis is on, and the span is above the floor.
tooLargeStatus
RegionTooLargeStatus		The verdict and its banner text, from the stored estimate against resolvedByteLimit() and the density axis when it may act.
regionTooLarge
boolean
regionTooLargeReason
string		Banner text for the axis that tripped; empty when not too large.
zoomCanReleaseGate
boolean		Whether "zoom in to see features" is honest advice. Density always releases on zoom; bytes only if the last zoom-in moved the estimate.
gateSkipsMeasuredViewport
boolean		The skip both fetch skeletons apply: the banner is up and its measurement already describes the viewport on screen.

Methods

MemberDescription
resolvedByteLimit
() => number | undefined		The budget the worker enforces and the banner compares against — the one spelling of that pair. Undefined when the gate may not act.
gateFetchState
() => GateFetchState		The gate as it stands for a fetch about to be issued. Calling it is the capture, which is why it is a method.

Actions

MemberDescription
setByteEstimate
(measurement: { bytes: number; viewport: GateViewport; }) => void
The bytes half of a measurement alone, for a test staging a display. Production commits through commitFetchBytes.
clearByteEstimate
() => void		Drops the estimate and the viewport stamp. forceLoadTrack survives: it is a track-wide approval.
setForceLoadTrack
(flag: boolean) => void
reload
() => void		Overridden by the composing display.
commitFetchBytes
(perRegionBytes: (number | undefined)[], issued: GateFetchState) => void
The byte axis of a finished fetch, called by the fetch runners with the gateFetchState() they captured at issue. Commits the per-region max; an empty batch, or an ungated display, commits nothing.
forceLoad
() => void		The banner's button: exempt the track on both axes and refetch.