LinearMafDisplay
Auto-generated from the @jbrowse/mobx-state-tree model in the source. See the developer guide for concepts. Provided by the maf plugin. View source.
Draws the multiple alignment in a MafTrack, one row per aligned species,
under a conservation band.
Example usage
A complete MafTrack config to paste into tracks. samples lists the
aligned species in track order; the rows divide the track height the
bands leave between them:
{
type: 'MafTrack',
trackId: 'multiz',
name: 'Multiz alignment',
assemblyNames: ['hg38'],
adapter: {
type: 'BigMafAdapter',
bigBedLocation: { uri: 'https://example.com/multiz.bb' },
samples: ['hg38', 'panTro4', 'mm10'],
},
displays: [
{
type: 'LinearMafDisplay',
displayId: 'multiz-LinearMafDisplay',
height: 400,
coverage: { show: true },
},
],
}The configuration slots for this model are documented on its config schema page.
Each section ends with the members a composed model contributes, linked to the page that documents them.
Properties
| Member | Description |
|---|---|
type"LinearMafDisplay" |
Always "LinearMafDisplay", the name a snapshot selects this model by. |
configurationLinearMafDisplayConfig |
The config node this model reads its settings from, through getConf. Its slots are documented on its config schema page. |
5 inherited properties from 3 models
From TreeSidebarMixin: runClustering, clusterRegion, sortRowsBy
From ParkedColorMixin: parkedColors
From BaseDisplay: id
Volatiles
| Member | Description |
|---|---|
framesGateBlockedboolean |
The byteLimit refused the last frames fetch, so the strip stops drawing; the menu reads this to say so.Never in rpcProps(): the fetch writes it, the loop trap FETCH_KEYS.md names. |
reportedRowsMafRow[] |
The worker's authoritative row set, in tree (leaf) order. arrangedRows arranges and colors it by rows, and drawnRows narrows that by the focus. |
treeNewickVolatilestring | undefined |
The adapter's guide tree as newick, which rowTree draws while some rotation of it lists rows.sort in order. |
speciesListedboolean |
Whether the adapter lists its species, by a samples config or its guide tree, rather than discovering them from the blocks it reads. |
sampleWarningsstring[] |
What the adapter's samples table disagreed with its species about. |
refSampleIdVolatilestring | undefined |
The reference sample row the worker resolved, held here because the region store that delivers it empties on chromosome navigation. Last write wins, not a latch: a re-pointed adapter or edited refAssemblyName keeps the display instance. |
32 inherited volatiles from 11 models
From ScoreScaleMixin: unclippedFenceQuantile
From ContextMenuMixin:
From TreeSidebarMixin: hoveredTreeNode, treeCanvas, mouseoverCanvas
From LegendMixin: dismissedLegendSections
From CoarseTierMixin: coarseTier, coarseTierRead, coarseTierLoading, coarseTierRotation
From StoredHoverMixin: storedHoveredFeature
From MultiRegionDisplayMixin: loadedRegions
From FetchMixin: activeSignal, fetchGeneration, reloadCounter, statusWindow, error, statusMessage, statusProgress, fetchCanceled, fetchRotation
From RenderLifecycleMixin: canvasDrawn, paintCount, currentRenderingBackend, renderTick, renderError, offScreen
From RegionTooLargeMixin: forceLoadTrack, byteEstimate, gateMeasuredViewportKey
From TrackHeightMixin: scrollTop, hostHeight
Getters
| Member | Description |
|---|---|
viewLinearGenomeView |
|
prefersOffsetboolean |
A band's y-axis, else the species rows and their names, sits at the top-left. |
rowProportionnumber |
|
showAlignmentsboolean |
|
showConservationboolean |
|
conservationHeightnumber |
|
conservationUnit"base" | "codon" |
|
colorField"identity" | "refNameRank" | undefined |
|
colorValuestring | undefined |
encoding.color.value, the constant fill, read alone so a key edit re-encodes nothing. |
colorSettingColorSetting & { value: string | undefined; } |
encoding.color as written, with the key's names and title. |
colorEncodingstring | FieldColorEncoding | undefined |
encoding.color as it paints, through its field's preset: one scale per field, so scale.type is never written. A string is the constant, and undefined the theme's. |
colorKeyTitlestring |
The key's heading: the written legend.title, else the field's own. |
identityRampContinuousRef | undefined |
encoding.color while it paints identity along a ramp, else undefined. |
identityColorsUint32Array<ArrayBufferLike> |
The identity ramp's packed color at each hundredth, the default ramp unless encoding.color is identity. One array per ramp, so a color edit that leaves the ramp alone re-encodes nothing. |
| colorScheme |
The named ramp identity paints along, the preset's where encoding.color writes none or is not identity, and none while a written scale.range paints instead. |
refNameRankPalettereadonly number[] |
Each source sequence rank's packed color, the written encoding.color.scale.range's while encoding.color is refNameRank. One array per range, as identityColors. |
yField"identity" | undefined |
|
showMismatchesboolean |
|
basesField"base" | "codon" | undefined |
The per-position layer's field while alignments.bases.show is on. |
showFramesboolean |
|
showInversionsboolean |
|
showReferenceRowboolean |
|
showCoverageboolean |
|
coverageHeightnumber |
|
showCoverageAllelesboolean |
Whether the coverage band colors its allele segments, coverage.alleles.show |
coverageMinAlleleFractionnumber |
|
interbaseIndicatorRuleInterbaseIndicatorRule |
coverage.interbase.filter as the worker's triangle rule. |
showInterbaseboolean |
|
referenceSampleIdstring | undefined |
The reference sample row as the worker resolved it (MafRegionSink), and until a detail region loads, the row naming the view's assembly or one of its aliases: the HPRC summary tier names hg38's row GRCh38.Every consumer reads this getter, so the codon conservation band and the per-base band exclude the same row. |
framesAdapterConfigRecord<string, unknown> | undefined |
The MAF adapter's framesAdapter (UCSC mafFrames), or undefined. Read by slot path off the live parent track, since a slot read against a snapshot misses defaulted slots. |
framesActiveboolean |
The CDS frame strip draws: a frames adapter is configured and alignments.frames.show is on. |
framesInUseboolean |
A frames adapter is configured and something reads its frames: the strip, the codon view or the codon band. |
discoveredRowsMafRow[] |
TreeSidebarMixin's hook: the worker's species, in the order it reported them. Empty until the first fetch populates the set; rowsReported is the readiness question. |
guideTreeNewickstring | undefined |
TreeSidebarMixin's hook: the adapter's guide tree. |
rowColorFieldsreadonly string[] |
TreeSidebarMixin's hook: none, since a species row has no attribute to color it by. |
rowsListedUpFrontboolean |
TreeSidebarMixin's hook: whether the track's config lists its species, so a rows.kept name none has is named; a copy row (mm10~2) exists at some loci only, and unmatchedKeptNames leaves it out. |
rowAliasRowAlias | undefined |
TreeSidebarMixin's, read off the copy row's name rather than the rows: a copy row exists at some loci only, so a name a rows.kept or rows.sort entry gives one answers to its sample where no block here aligns that copy. An order, label, color or focus written against the sample reaches its copies. Undefined while no row is a copy. |
shownRowsMafRow[] |
arrangedRows narrowed to the focus by the worker's own rule, visibleSamples, so the rows drawn are the rows shipped. |
drawnRowsMafRow[] |
The display rows: shownRows, less the reference row when showReferenceRow is off. An empty array means no fetch yet or a focus with no rows; rowsReported tells them apart. |
liveNoticesstring[] |
What the samples table disagreed with the track's samples about, and rowNotices: a rows.kept naming no row, or naming species the config does not list. |
autoClusterReadyboolean |
Two or more display rows, so a hidden reference row does not count. |
rowsReportedboolean |
Whether the species list has arrived from the adapter. rowsVisible and the render callback's first-paint gate read this, since an empty drawnRows is ambiguous. |
rowFocusKeystring[] | undefined |
The focus rows.kept as the worker sees it: a sorted plain array read off config alone. The sort keeps a re-cluster's new leaf order out of the fetch key (reference/FETCH_KEYS.md, "Row order is not a fetch input"). |
coarseAdapterSlotstring |
|
coarseTierPastThresholdboolean |
Whether the view is zoomed out past the force-load floor, read from RegionTooLargeMixin's gate so the tier swap and the gate agree on the floor. |
| summaryReadArgs |
What the summary RPC reads beyond its regions and byte budget: the adapter and the focus it filters records by. The detail fetch's other settings never reach it. |
| coarseReadKey |
summaryReadArgs, and whether the strip wants frames read beside the summary: the detail tier always reads them, the summary tier only for the strip. |
coverageBandActiveboolean |
The coverage band is on and has data: showCoverage alone is not enough, since the summary tier has no coverage.coverageDepths.topBands reads this as the band's active half, and the data questions (autoscaling, the depth rules) read it directly; whatever places something in the band reads topBands.rects. Only the track menu reads showCoverage, so the tick keeps the user's choice across zoom. Same split as rowPlan vs the slots it resolves. |
conservationBandActiveboolean |
The conservation band is on and has data: twin of coverageBandActive, since the identity scores are computed from alignment blocks, which the summary tier lacks.topBands and the conservation encode read this; the menu tick reads showConservation. |
rowIndexBySrcMap<string, number> |
Maps a src (species) to its display row index. The single source for the src→row projection used by the summary-bar and CDS-frame overlays and the frame hover lookup, so they can't disagree on row placement. The same object while the row order is, since every region's placement and encode keys on it: a relabel or recolor moves no row. |
defaultCodonSpeciesstring | undefined |
The anchor species whose mafFrames reading frame translates every row (UCSC codonDefault). Tied to the reference assembly's referenceSampleId, not the top row, since codons compare against the reference sequence (block.refSeqBytes). Falls back to the worker's first row when the reference is not a listed sample. |
referenceRowIndexnumber |
The reference's display row for the band's codon mode, matching the per-base band's worker-side refSampleId; -1 where the reference is no drawn row. |
detailPayloadsReadonlyMap<number, MafRegionPayload<MafWireRegionData>> |
The detail tier's store: MultiRegionDisplayMixin's per-region payloads narrowed to the worker's columnar rows plus the CDS frames from the same fetch. A reorder re-places from here without refetching. |
rpcDataMapReadonlyMap<number, MafRegionData> |
detailPayloads with every row assigned its on-screen rowIndex (placeMafRegionData). Everything that draws, hit-tests or measures rows reads this.The memo is held in this closure so it outlives a context-loss recovery; afterAttach installs the observer it needs. |
detailOnScreenReadonlyMap<number, MafRegionData> |
rpcDataMap while the detail tier draws, and nothing on the summary tier: CoarseTierMixin keeps the detail store under the tier, so whatever marks, hovers or navigates by the alignment reads this. |
framesDataMapReadonlyMap<number, MafFrameRecord[]> |
Per-region CDS frame rows (UCSC mafFrames) for the frames strip. The tier on screen is checked first and the other tier fills gaps, so the strip stays visible across the summary-detail swap. |
bandPlot{ height: number; floor: number; } |
The plot the bands share with the rows: the track height less the sidebar's lines above the rows, keeping the rows a floor while they show. |
| statedBands |
Each band's switch and stated height, coverage above conservation. |
| statedTopBands |
The band stack as stated (mafTopBands): the stated heights bound against bandPlot. The band drags read it, so hiding the rows moves no stated height. |
| topBands |
The band stack as drawn, coverage above conservation: the stated stack while the rows show, and while they are hidden the bands filling the plot (drawnMafTopBands), under the canvas's backing-store limit: the conservation band at its stated height and the coverage taking the rest, or with coverage off, the conservation band alone. Every top, height and offset reads this; a band that reserves 0 px does not draw. |
rowsHeaderHeightnumber |
TreeSidebarMixin's hook: where the band stack ends. Every rows hit-test, draw and export offset reads the mixin's rowsTopOffset over it, so adding a band or the focus chip's line can't desync them. |
nrownumber |
Number of displayed rows (at least 1, so dividing the rows' height by it is safe). |
maxRowsHeightnumber |
Max CSS-px height the rows may take: one canvas holds the band stack and the rows, and it stops where its backing store (× dpr) hits the browser/GPU canvas limit, so the rows get what the bands leave of that. |
rowsHeightnumber |
Height of the per-sample rows area, which the rows fit: the track's height slot minus the stacked bands, never grown by the row count, so more species shrink the rows rather than grow the track. Zero when alignments are hidden. Capped at maxRowsHeight so the canvas, bands plus rows, stays under its backing-store limit. |
effectiveRowHeightnumber |
Per-row height: the rows area split evenly across the rows, so the rows always fit the track and never scroll. A taller track or a narrower row focus is how a reader gets taller rows. Sub-pixel is legitimate for more species than pixels; only a non-positive height, which every consumer divides by, is floored (agent-docs/reference/ROW_HEIGHT_AND_FIT.md). |
rowsVisibleboolean |
The per-sample rows area has something to draw: the view can place it, the rows have px and the row set is known. The visible* getters share this gate instead of re-spelling it. |
scrollViewportHeightnumber |
|
drawsTreeboolean |
TreeSidebarMixin's hook: off while the alignments are hidden, since the tree lays against rows that are not drawn. |
heightnumber |
Override BaseLinearDisplay.height so the track container matches the rendering canvases exactly (stacked bands + rows viewport). With the rows hidden the bands fill the track's own height, so a drag resizes from it. |
treeRootHierarchyNode<NewickNode> | undefined |
TreeSidebarMixin's hook: root with a hidden reference row pruned, since root is already narrowed to the focus. |
SvgSidebarProps |
|
colorPaletteMafColorPalette |
Theme-derived color palette (per-base colors plus match, gap, mismatch, unknown, insertion), read by rowsEncodeProps() and renderState. Derived from the session theme, so it exists in headless SVG export and RPC. A theme change re-encodes on the main thread without a refetch. |
encodeBinBpnumber |
Genomic bp the GPU encoder merges into one cell: the foundation's settledSubPixelBinBp. Zoomed in this is 1; once a base falls below half a CSS pixel the encoder samples one per bin. |
statsInViewVisibleStats<MafCoverageRegion, ScoreStats> | undefined |
The depth stats over the visible content blocks, from the worker-shipped coverage.coverageDepths. |
autoscaleRange[number, number] | undefined |
The depth the shown coverage spans, fenced at fenceQuantile and widened to the coverage.encoding.y rules, so stacked sections share a scale. |
valuesInView[number, number] | undefined |
The least and greatest depth in view, unfenced. |
defaultScoreDomain[number | undefined, number | undefined] |
Depth has a floor of 0 while the axis reaches it, so an unpinned bottom stays there whatever a rule below it asks for; with coverage.encoding.y.scale.zero off it spans the depths in view. |
coverageScaleTypeScaleTypeCode |
|
coverageDomain[number, number] | undefined |
The autoscaled depth domain. Undefined until some region holds one. |
coverageDepthDomain[number, number] | undefined |
The domain the coverage band draws against: coverageDomain with a log scale's floor pulled up to one read (see coverageDepthDomain). Every consumer reads this one — the y-axis ticks and both renderers' normalizers. |
| coverageScaleState |
The band's scale and layer switches as CoverageBandState spells them, less its rect and colors. The raw symlog slot means "derive from the domain"; it resolves here, where the domain is in hand, so every backend normalizes with one number. |
scoreRulesDrawnboolean |
Overrides ScoreScaleMixin's: coverage.encoding.y.rules are depths, so they draw on the coverage band while it reserves px, never on the fixed conservation scale. |
valueScalesValueScale[] |
The scales the chrome places the axes from: coverage over its autoscaled depth, and conservation over a fixed 0-100%. |
coverageBandColorsCoverageBandColors |
The coverage band's palette slots, packed. Separate from renderState so the nine-color CSS parse memoizes against the palette. |
coverageBandStateCoverageBandState |
The coverage band as the shared marks and their hit test take it. Height 0 draws no band: the setting is off or the summary tier owns the view. |
inversionConsensusStrandConsensus |
The orientation each (row, source chromosome) is measured against for the inversion indicator (consensusStrandByRowRefName). Memoized because it walks every block and row of every loaded region while its consumer runs on every pan and zoom. Empty when the indicator is off. |
visibleEmptyLinesEmptyLineSegment[] |
Positioned bridge-line segments for e-line (empty/bridged) rows. |
visibleInversionsInversionMarker[] |
Positioned strand-flip (inversion) markers for the visible aligned rows. Empty unless the indicator is toggled on. |
zoomedToBaseLevelboolean |
At base level each reference base spans at least a pixel (UCSC's zoomedToBaseLevel). Reads the throttled coarseBpPerPx so the rendering swap does not thrash mid-zoom. False until the view is initialized. |
rowPlanRowPlan |
What the rows draw now (resolveRowPlan). The same object while its members are, since every region's encode keys on it: crossing base level with nothing to redraw re-encodes nothing. |
renderStateMafGPURenderState |
Render state passed to the GPU/Canvas2D backend each frame.canvasHeight is the whole canvas, stacked bands plus rows viewport, because the coverage band draws on the same canvas as the rows. rowsTop and rowsHeight are the rows band inside it. |
visibleLabelsVisibleLabel[] |
Positioned per-base letters, over the bases only. |
visibleDeletionsDeletionMarker[] |
Positioned deletion runs, labelled with their length where it fits. Only the bases paint the gap cells the count is colored against. |
summaryDataMapReadonlyMap<number, MafSummaryRecord[]> |
The summary records each region's rows draw as per-species presence bars, keyed by displayedRegionIndex. Drawn on the summary tier and as the stand-in for a region whose detail tier has not landed, so zooming in past the floor does not blank the track. Suppressed per region, since tiers arrive per region; coarseTierActive short-circuits it because both maps hold a region side by side. |
visibleFramesFrameMarker[] |
Positioned per-species CDS frame boxes for the frames strip. Empty unless a frames adapter is configured and the strip is on. Reuses the src-to-row mapping of the summary bars. |
codonCellsActiveboolean |
The rows area paints the codon overlay. |
codonConservationActiveboolean |
The conservation band is in per-codon (amino-acid identity) mode, with frames to define codons and per-base blocks to translate — the cheap summary path ships neither. |
refNameRanks{ ranks: Map<number, Map<string, number>>; maxRank: number; } |
Each row's source sequences ranked by aligned bp over the loaded regions, so a pan within loaded data keeps every block's color. Empty unless refNameRank fills the rows. The same object while the ranks are, so a fetch that ranks nothing new re-encodes only its own region. |
bandLabelsMafBandLabel[] |
Titles for the stacked bands, with the y they sit at; empty unless both bands reserve px, so a band's chip never hides the last band. The on-screen chips and the SVG export both read it. The conservation title names what the band draws ( codonConservationActive), not the mode asked for. |
colorScalesColorScale[] |
LegendMixin's hook: the key for the fill rowPlan paints, the codon layer's, then the CDS frame key while the strip draws, then the row color key. Each key is built by the module that paints it, so the swatches match the screen. |
hasLegendKeyboolean |
Whether this display has a color key, as opposed to whether one is drawn now: the question "Show legend" is offered on. A constant fill and the bases key nothing; a field, the bars' height, the codon layer and the frame strip key what they paint. Read off the settings rather than rowPlan or the frames on screen, so the row stays put through zoom and pan.Overrides LegendMixin's, whose scale reads decline on an uninitialized view and would drop the row while a track loads. |
rowsSourcesReadonlyMap<number, MafRowsSource> |
Each region's detail and summary tiers, paired: what its rows draw from. A pair keeps its identity while neither tier moved. |
encodedUploadReadonlyMap<number, MafUploadPayload> |
Every loaded region's upload payload, the rows band's span channels beside the coverage band's buffers, keyed by displayedRegionIndex. Held here rather than in the upload's setup thunk so a theme or color change re-encodes without an RPC roundtrip and the memo outlives a context-loss recovery. |
visibleCodonGlyphsCodonGlyph[] |
The amino-acid letters over the codon view's cells. |
gateEnabledboolean |
Enables byte-estimate gating: a MAF-aware estimate (per-species sequence x span) is checked against fetchSizeLimit inside the tier's own RPC, blocking the fetch with a force-load prompt.On for both tiers: each RPC measures the file it reads, the alignment index on detail and the summaryAdapter sub-adapter on summary (CoarseTierMixin), since the summary read is a whole-feature download over every zoom from 20kb up. |
141 inherited getters from 14 models
From ScoreScaleMixin: scaleType, scaleZero, fenceQuantile, clipFenceQuantile, symlogConstant, domainMin, domainMax, autoscaleGroup, scaleTitle, grid, showAxis, scoreRules, axisGuide
From ScoreAxisMixin: axisReachesZero, resolvedDomainMin, resolvedDomainMax, autoscaledDomain, pinsDomain, axes
From TreeSidebarMixin: showTree, showBranchLength, showRowLabels, treeAreaWidth, rowSort, rowLabels, storedRowTree, rowTreeProvenance, rowFocus, rowFilter, rowColorChannel, rowColorPins, rowAnnotationChannels, finerTreeHint, internalRowFields, baseRowColorChannel, baseRowColorSetting, rowColorIsCustom, rowColorChoice, rowColorFieldsOffered, rowArrangementIsCustom, rotatableRowTree, rowsContentHeight, hierarchy, , , awaitingDependentData, spatialIndex, clusterPartition, treelessBandCount, baseRowFilter, rowBandingNotices, rowNarrowingClears, rowNarrowingNotices, rowNotices, rowNarrowingHint, treeOnFinerRows, treeHasBranchLengths
From ColorWritesMixin: writtenColor
From ParkedColorMixin: parkedColor, parkedIdentity
From LegendMixin: showLegend, legendRight, legendTop, legendSpec, keyDrawnByHost
From CoarseTierMixin: coarseSourceConfig, hasCoarseSource, coarseTierActive, coarseTierStandsIn, byteGateAdapterPath, coarseTierIssueKey, fetchSuspended, displayPhase, svgReady
From StoredHoverMixin: hoveredFeature
From MultiRegionDisplayMixin: host, canvasWidthPx, settledSubPixelBinBp, canRender, rendersCanvas, trackVisibleRegions, viewportWithinLoadedData, viewportEmpty, layoutReady, dataSuperseded, fetchHeld, renderBlocks, fetchInputs, regionPayloads, hasRegionData, staleSettingsDrawn, dataCurrent, loadedAssembly, phaseViewportCurrent, paintInert, paintSuperseded
From FetchMixin: isLoading, isLoadingOrCanceled, fetchInert, awaitingPrerequisite, settingsFetchInputs
From RenderLifecycleMixin: painted
From RegionTooLargeMixin: byteGateAdapterConfig, densityTooLarge, adapterFetchSizeLimit, gateViewportSpanBp, gateViewport, configuredFetchSizeLimit, configForceLoad, aboveForceLoadFloor, gateExempt, estimatedFetchBytes, gateByteLimit, gateActive, gateMeasurementStale, densityGateActive, tooLargeStatus, regionTooLarge, regionTooLargeReason, zoomCanReleaseGate, gateSkipsMeasuredViewport
From TrackHeightMixin: configuredHeight, allottedHeight, resizing, scrollContentHeight, scrollableHeight
From BaseDisplay: parentTrack, selectedFeatureId, RenderingComponent, DisplayBlurb, adapterConfig, isMinimized, featureNoun, featureWidgetType, plotKeys, plot, configNotices, notices, cornerNotices, plotExamples, configDocsUrl
Methods
| Member | Description |
|---|---|
rowFoundAtSomeLoci(name: string) => boolean |
TreeSidebarMixin's hook: a copy row (mm10~2) exists only where a block aligns that species twice. |
rowParent(row: MafRow) => RowParent | undefined |
TreeSidebarMixin's hook: a copy row refines its sample, so a label written against the sample reaches its copies as Mouse copy 2, as the copy's own label reads. |
() => MenuItem[] |
Items for the right-click menu, built from the column under the click. Captured when the menu opens, since closeContextMenu runs before an item's onClick. |
rowGeometry() => MafRowGeometryParams |
Where the rows sit on screen: the row height and the rows' area. Every rows layer reads this one method. |
| rpcProps |
The fetch inputs both tiers send through rpcArgs and cache under. The focus is a row set since the worker ships only those genomes; the row order is not, since the client places the rows. No fetch-derived state belongs here (singleFetchPerRegion.test.ts). |
Where the rows [startRow, endRow) sit in their genomes across the reference bp range [startBp, endBp), the loci an "open this species here" navigation targets. A row contributes nothing with no aligned base in the range, no fetched block covering it, or a genome not loaded as an assembly (MafRow.assemblyName unset).Takes the whole row range at once, since the menu builds an entry per row on every open. |
|
| frameHoverInfo |
The CDS frame record covering absolute genomic bp (uint32) on display rowIndex, or undefined. Gated on framesInUse, so the gene name reads on hover in codon view with the strip off.bp is a base index (MafPointer.baseBp), not a floored gposFrac, matching the row hover and coverage tooltip on a reversed region. |
| coverageBandHit |
The interbase bar or indicator triangle under a canvas point in the coverage band, through the shared band's own hit test, or undefined for the depth area and everywhere else. |
| coverageTooltipBin |
The depth and SNP tooltip bin at the base under the cursor, with the percent identity at that position. Undefined when the region has no fetched data or depth is zero. |
| interbaseTooltipBin |
The insertions at a band boundary the hit test named, summarized the way the alignments band summarizes its interbase events. |
configProblemsOf(conf: AnyConfigurationModel) => string[] |
The schema's rules, then what the rows cannot paint as written: a coverage layer filter test its layer does not make, a codon color with no reading frames, and a range on a field that paints the theme's colors. |
| rowHoverInfo |
The hover on rowIndex at the cursor's genomic position: an aligned base, an insertion, a deletion or a bridged region, tagged with the sample label. bp holds both readings of the cursor (HoverBp), which differ on a reversed region. |
| identityHoverInfo |
The mean identity of the window a heatmap cell or X-Y bar paints at base bp on rowIndex, and how many bases it averages, while identity draws. |
colorScalesIn(palette: JBrowsePalette) => ColorScale[] |
colorScales in another theme: the SVG export's, whose codon and CDS-frame swatches follow it. |
() => MenuItem[] |
|
rowsEncodePropsIn(colorPalette: MafColorPalette) => MafRowsEncodeProps |
What a region's rows encode reads beyond the region, in a given palette, since the SVG export's theme need not be the session's. A mode flip lives here so it re-encodes every region as a declared input. |
rowsEncodeProps() => MafRowsEncodeProps |
rowsEncodePropsIn in the session's palette, for the on-screen encode. |
| codonHoverInfo |
The codon under the cursor on rowIndex at base bp, while the codon view draws, from the codons its cells were encoded from. |
| conservationHoverInfo |
The conservation bar painted over base bp, read from the bars the band draws, so a binned window or a codon answers as it paints. |
summaryHoverInfo(rowIndex: number, x: number) => MafSummaryRecord | undefined |
The summary record whose bar is drawn at canvas x x on display row rowIndex, or undefined: the hover on the summary tier. |
17 inherited methods from 6 models
From TreeSidebarMixin: , rowColorFor, orderDropsRowTree, rowOrderWillDropTree, unreadFilterFieldNotice, rowAnnotationNotices
From ParkedColorMixin: parkedColorOf
From LegendMixin: legendSpecIn
From MultiRegionDisplayMixin: regionHasData, isCacheValid
From RegionTooLargeMixin: gateFetchState, resolvedByteLimit
From BaseDisplay: renderingProps, exportedFeatures, liftPlot, plotProblems, plotWrites
Actions
| Member | Description |
|---|---|
setRowProportion(n: number) => void |
|
setShowAlignments(arg: boolean) => void |
|
setShowConservation(arg: boolean) => void |
|
setConservationUnit(arg: "base" | "codon") => void |
|
setYField(field: "identity" | undefined) => void |
|
setShowMismatches(arg: boolean) => void |
|
setBasesField(field: "base" | "codon" | undefined) => void |
Turn the per-position layer on with field, or off with undefined, keeping the field it last painted. |
setShowFrames(arg: boolean) => void |
|
setShowInversions(arg: boolean) => void |
|
setShowReferenceRow(arg: boolean) => void |
|
setShowCoverage(show: boolean) => void |
|
setShowCoverageAlleles(show: boolean) => void |
Turns the coverage band's allele colors on or off, coverage.alleles.show |
setCoverageMinAlleleFraction(fraction: number) => void |
|
setShowInterbase(show: boolean) => void |
|
| setColorScheme |
Paint identity along a named ramp (colorByScheme). |
| setSamples |
Receive the worker's samples and serialized Newick tree.samplesCanonical marks the set authoritative (config- or tree-derived), so it replaces the rows. A discovery set names only the genomes its region's blocks hold, so it unions into the known rows (unionSources).The deepEqual guard covers the sample set only; a tree can change while the set does not. |
setCoverageHeight(height: number) => void |
The coverage band's height, dragged as every band in a stack is (dragBandHeight) to the room the other band and the rows' floor leave. |
setConservationHeight(height: number) => void |
The conservation band's height, dragged as setCoverageHeight is while the rows show. While they are hidden the coverage takes what the conservation band leaves, so the drag stops where the coverage keeps its floor (dragRowsHiddenConservation). |
sortRowsByBaseAt(refName: string, pos: number) => boolean |
Reorder the rows by the base each species has in the reference column at (refName, pos), writing the order to rows.sort as clustering and the arrangement dialog do, so "Reset row order" undoes all three.Declines with fewer than two rows or at a column no loaded region covers; sortRowsAtColumn owns both gates and the returned "did it sort". |
openSolidColorDialog() => void |
The picker Color by's Solid color... opens, on the theme's match tone until a constant is written. |
setRefSampleId(id: string | undefined) => void |
The reference row the last detail batch named — see refSampleIdVolatile. Written beside setSamples in the batch commit, so a stale batch names nothing. |
setFramesGateBlocked(blocked: boolean) => void |
Record whether the last frames read was declined as over budget. Set both ways by every fetch pass that reaches the frames adapter, so zooming back in clears it without anything else having to. |
clearDisplaySpecificData() => void |
Clears the verdict with the data: it describes a read of the viewport just thrown away, and chromosome nav would otherwise show "too much data" for an unmeasured region. |
startRenderingBackend(backend: MafRenderingBackend) => void |
|
fetchNeeded(needed: IndexedRegion[]) => Promise<void> |
The detail fetch. The summary tier's is fetchCoarseTier below, and CoarseTierMixin suspends this one while the tier is up. |
| fetchCoarseTier |
|
renderSvg(opts: ExportSvgDisplayOptions) => Promise<ReactNode> |
Dynamic import so the export path — and everything it pulls in — stays out of the bundle until someone actually exports. |
85 inherited actions from 14 models
From ScoreScaleMixin: setScaleType, setScaleZero, setFenceQuantile, setDomainMin, setDomainMax, setMinScore, setMaxScore, setAutoscaleGroup, setGrid, setScoreRules, resetYScale
From ContextMenuMixin: ,
From TreeSidebarMixin: setShowTree, setShowBranchLength, setShowRowLabels, setTreeAreaWidth, setRunClustering, setClusterRegion, setSortRowsBy, setHoveredTreeNode, setTreeCanvasRef, setMouseoverCanvasRef, setRowOrder, setRowLabels, setRowFocus, showAllRows, applyRowEdits, resetRowArrangement, setRowColorChoice, focusLegendEntry
From ColorWritesMixin: colorByField, setColorValue, colorByIdentity, colorByScheme, pickDefaultColor, pickSolidColor
From ParkedColorMixin: parkColor
From LegendMixin: setShowLegend, dismissLegendSection
From CoarseTierMixin: setCoarseTier, clearCoarseTier, setCoarseTierLoading, cancelCoarseTier, cancelFetchByUser
From StoredHoverMixin: setHoveredFeature, clearHoveredFeature
From MultiRegionDisplayMixin: setLoadedRegion, evictRegionStore, dropLoadedRegion, clearSettingsBakedData, lapseHeldFetch, clearAllRpcData, invalidateSettings, reload, fetchRegions, afterAttach
From FetchMixin: setError, setStatusMessage, stopActiveFetch, openStatusStream, cancelFetch, beforeDestroy, beginFetch, endFetch, runFetch
From RenderLifecycleMixin: markCanvasDrawn, resetCanvasDrawn, stopRenderingBackend, renderNow, setOffScreen, setRenderError, attachRenderingBackend
From RegionTooLargeMixin: clearByteEstimate, clearGateMeasurements, setForceLoadTrack, commitFetchBytes, forceLoad
From TrackHeightMixin: setScrollTop, setHostHeight, setHeight, resizeHeight, expandToContentHeight