Skip to main content

CanvasFeatureGateMixin

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 axis of the region-too-large gate, composed after MultiRegionDisplayMixin by the canvas feature displays: how the features-per-pixel number is measured and the worker budget for it. The byte axis is entirely RegionTooLargeMixin's. A display opts in by composing this and calling commitGateMeasurements from its fetch's onComplete.

Volatiles

MemberDescription
densityStatsPerRegion
densityStatsPerRegion: regionDataMap<RegionDensityStats>(
        'densityStatsPerRegion',
      )
Per-region feature counts, keyed by displayedRegionIndex, so the verdict is a live max at the current bpPerPx. Cleared on navigation.

Getters

MemberDescription
gateEnabled
boolean		The byte-gate opt-in, contributed here. types.compose resolves a collision to the later argument, so this mixin must follow the one that declares it; no-restricted-syntax fails the other order.
densityGateEnabled
boolean		The density axis is on where something measures it.
visibleFeatureDensityPerPx
number		Density at the debounced coarseBpPerPx, so the verdict shares the layout cadence. Zero before the view is measured.
maxFeatureDensity
number | undefined		The worker's density budget; undefined when the axis may not act.
densityTooLarge
boolean		The density axis of the verdict, through the same overDensityBudget the worker's short-circuits use.

Methods

MemberDescription
observedMaxDensity
(bpPerPx: number) => number		Highest features-per-pixel across the visible regions at bpPerPx.

Actions

MemberDescription
setDensityStats
(displayedRegionIndex: number, stats: RegionDensityStats) => void
clearGateMeasurements
() => void
commitGateMeasurements
(measurements: RegionGateMeasurement[], issued: GateFetchState) => void
Commit a batch of per-region fetch results on the density axis, judged by the tier captured at issue. The byte axis is commitFetchBytes.