LDTrackDisplay
Auto-generated from the @jbrowse/mobx-state-tree model in the source. See the developer guide for concepts. Provided by the variants plugin. View source.
A linkage disequilibrium matrix read from a pre-computed file, drawn as a triangle over the view.
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"LDTrackDisplay" |
Always "LDTrackDisplay", the name a snapshot selects this model by. |
configurationLDTrackDisplayConfig |
The config node this model reads its settings from, through getConf. Its slots are documented on its config schema page. |
Volatiles
| Member | Description |
|---|---|
indexSnpLocusstring | undefined |
Key (refName:start:id) of the SNP whose row and column are emphasized. A key rather than an index, so it survives a refetch. |
23 inherited volatiles from 7 models
From TriangleMatrixMixin: rpcData
From LegendMixin: dismissedLegendSections
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
From TrackHeightMixin: scrollTop, hostHeight
Getters
| Member | Description |
|---|---|
viewLinearGenomeView |
|
prefersOffsetboolean |
The connector band, else the matrix, starts at the top-left. |
colorFieldLDMetric |
encoding.color.field, the statistic the fetch asks the file for. |
showNamesboolean |
|
inRingboolean |
Whether a circular view's ring hosts the display (hostHeight). |
variantLayout"columns" | "genomic" |
The variantLayout slot, but genomic on a ring: columns spread over the whole circumference would sit at no SNP's angle. The slot keeps its value for the same track in a linear view. |
snpsLDSnp[] |
The loaded SNPs in screen order along the column axis. |
cellWidthnumber |
The column width the payload was laid out at. |
viewSignaturestring | undefined |
The dynamic blocks: the SNP set is the viewport's, so a pan refetches while the stale triangle draws under the live transform. |
atGenomicPositionsboolean |
Whether the loaded matrix is at genomic positions, read off the payload so a stale one keeps its own layout until the refetch lands. |
r2Availableboolean |
|
dprimeAvailableboolean |
|
indexSnpColumnnumber |
Index of the index SNP in snps, or -1. |
paintedColorFieldLDMetric |
The loaded metric, so a stale triangle during a metric switch keeps its hue. |
colorExtentreadonly [number, number] |
What an open end of the color domain follows: the statistic's own 0 to 1, not the loaded values, so one r² paints one color on every track. |
colorScalesColorScale[] |
The ramp the cells paint through, titled by the loaded metric. An end pinned inside the statistic's 0 to 1 reads ≤ or ≥. |
renderStateLDRenderState |
|
connectorsBandBand |
The connectors band above the matrix: the connector lines in columns, the labels at genomic positions when they are on, else nothing; taken from the display's height so the triangle keeps its floor. |
connectorsStackBandStack<"connectors"> |
|
connectorsHeightnumber |
|
drawsLabelsboolean |
Whether the SNP labels draw: on, in a connectors band that reserves room for them, so they never paint over the triangle. |
matrixTopnumber |
Where the triangle begins, under the connectors band. |
depthFractionnumber |
A file listing only nearby pairs draws a strip of the triangle's depth, so fit mode stretches that strip over the display. |
gateEnabledboolean |
Opt into RegionTooLargeMixin's byte gate: a tabix LD file's index says how much a region reads before any of it is downloaded. |
connectorLineCoordsConnectorCoord[] |
Each column tied to its SNP's genomic x, for the connector lines. |
paintedCellsReadonlyMap<number, LDDataResult> |
The payload as the painters read it: under a threshold scale each value at its interval's centre (binnedColorValues), while the hit test and the tooltip read the file's own. |
97 inherited getters from 12 models
From TriangleMatrixMixin: heightMode, canvasWidth, viewTransform, matrixRegions, matrixHeight, matrixBlocks, yScalar, triangleTransform, triangleFrame
From MatrixRampMixin: paintedColorSetting, colorEncoding, colorScaleType, colorScheme, colorReverse, schemeRamp, colorBins, colorRamp, colorScale, colorDomain, colorMidNorm, matrixColor, colorFieldTitle
From ColorWritesMixin: writtenColor
From ParkedColorMixin: parkedColor, parkedIdentity
From LegendMixin: showLegend, legendRight, legendTop, legendSpec, hasLegendKey, keyDrawnByHost
From GlobalFetchMixin: host, canvasWidthPx, staticBlockSignature, dynamicBlockSignature, viewportEmpty, canRender, rendersCanvas, paintInert, svgReady, displayPhase
From KeyedFetchMixin: dataSuperseded, currentFetchKey, dataCurrent
From FetchMixin: isLoading, isLoadingOrCanceled, fetchInert, awaitingPrerequisite, awaitingDependentData, fetchHeld, settingsFetchInputs
From RenderLifecycleMixin: paintSuperseded, painted
From RegionTooLargeMixin: byteGateAdapterConfig, densityTooLarge, byteGateAdapterPath, adapterFetchSizeLimit, gateViewportSpanBp, gateViewport, configuredFetchSizeLimit, configForceLoad, aboveForceLoadFloor, gateExempt, estimatedFetchBytes, gateByteLimit, gateActive, gateMeasurementStale, densityGateActive, tooLargeStatus, regionTooLarge, regionTooLargeReason, zoomCanReleaseGate, gateSkipsMeasuredViewport
From TrackHeightMixin: configuredHeight, allottedHeight, height, resizing, scrollContentHeight, scrollViewportHeight, scrollableHeight
From BaseDisplay: parentTrack, selectedFeatureId, RenderingComponent, DisplayBlurb, adapterConfig, isMinimized, hoveredFeature, featureNoun, featureWidgetType, liveNotices, plotKeys, plot, configNotices, notices, cornerNotices, plotExamples, configDocsUrl
Methods
| Member | Description |
|---|---|
rpcProps() => LDRpcProps |
|
columnX(column: number) => number |
Viewport x of a fractional column index: i + 0.5 is column i's apex. Uses the payload's own column width, so it follows the live transform through a zoom's refetch. |
locusViewportX(refName: string, coord: number) => number | undefined |
Viewport x of a locus, or undefined when it has none. |
viewRefName(refName: string) => string |
A file's refName as the view names it: PLINK writes 1 where the assembly says chr1. |
hitTest(mouseX: number, mouseY: number) => LDCellHit | undefined |
The computed cell under a display-px point: a pair outside the band, or one no estimator filled, is not drawn and not hit. |
configProblemsOf(conf: AnyConfigurationModel) => string[] |
The schema's rules, then names asked for with no band to draw in. |
() => MenuItem[] |
|
renderSvg(opts: ExportSvgDisplayOptions) => Promise<ReactNode> |
13 inherited methods from 6 models
From TriangleMatrixMixin: cellToScreen, screenToCell
From MatrixRampMixin: rampColorScales
From ParkedColorMixin: parkedColorOf
From LegendMixin: colorScalesIn, legendSpecIn
From RegionTooLargeMixin: gateFetchState, resolvedByteLimit
From BaseDisplay: renderingProps, exportedFeatures, liftPlot, plotProblems, plotWrites
Actions
| Member | Description |
|---|---|
setIndexSnp(snp: LDSnp | undefined) => void |
|
setShowNames(show: boolean) => void |
|
setVariantLayout(value: "columns" | "genomic") => void |
|
setConnectorsHeight(n: number) => void |
|
startRenderingBackend(backend: LDRenderingBackend) => void |
47 inherited actions from 12 models
From TriangleMatrixMixin: setRpcData, clearDisplaySpecificData, setHeightMode
From MatrixRampMixin: setColorScheme
From ColorWritesMixin: colorByField, setColorValue, colorByIdentity, colorByScheme, pickDefaultColor, pickSolidColor
From ParkedColorMixin: parkColor
From LegendMixin: setShowLegend, dismissLegendSection
From GlobalFetchMixin: clearForDisplayedRegions
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
From TrackHeightMixin: setScrollTop, setHostHeight, setHeight, resizeHeight, expandToContentHeight
From BaseDisplay: clearHoveredFeature, applyDisplaySettings, applyPlot