LinearScoreDisplay
Auto-generated from the @jbrowse/mobx-state-tree model in the source. See the developer guide for concepts. View source.
The worked-example score display: one value per feature, drawn as a box along the genome. The developer guides walk through this model.
Example usage
The display attaches to any FeatureTrack, so a track naming it in
displays gets it in place of the stock linear one:
{
type: 'FeatureTrack',
trackId: 'genes_with_scores',
name: 'Genes (scored)',
assemblyNames: ['hg38'],
adapter: {
type: 'BedTabixAdapter',
bedGzLocation: { uri: 'https://example.com/genes.bed.gz' },
index: { location: { uri: 'https://example.com/genes.bed.gz.tbi' } },
},
displays: [
{
type: 'LinearScoreDisplay',
displayId: 'genes_with_scores-LinearScoreDisplay',
encoding: { y: { field: 'score' } },
},
],
}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"LinearScoreDisplay" |
Always "LinearScoreDisplay", the name a snapshot selects this model by. |
configurationLinearScoreDisplayConfig |
The config node this model reads its settings from, through getConf. Its slots are documented on its config schema page. |
1 inherited property from one model
From BaseDisplay: id
Volatiles
22 inherited volatiles from 6 models
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 |
|---|---|
rpcDataMapReadonlyMap<number, ScoreRegionData> |
|
viewLinearGenomeView |
|
domain[number, number] |
|
renderStateScoreRenderState |
|
hoverInkHighlightRect[] |
76 inherited getters from 7 models
From StoredHoverMixin: hoveredFeature
From MultiRegionDisplayMixin: host, canvasWidthPx, settledSubPixelBinBp, canRender, rendersCanvas, trackVisibleRegions, viewportWithinLoadedData, viewportEmpty, fetchSuspended, layoutReady, dataSuperseded, fetchHeld, renderBlocks, fetchInputs, regionPayloads, hasRegionData, staleSettingsDrawn, dataCurrent, loadedAssembly, phaseViewportCurrent, svgReady, paintInert, paintSuperseded, displayPhase
From FetchMixin: isLoading, isLoadingOrCanceled, fetchInert, awaitingPrerequisite, awaitingDependentData, settingsFetchInputs
From RenderLifecycleMixin: painted
From RegionTooLargeMixin: gateEnabled, 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, featureNoun, featureWidgetType, liveNotices, plotKeys, plot, configNotices, notices, cornerNotices, plotExamples, configDocsUrl
Methods
| Member | Description |
|---|---|
rpcProps() => { scoreColumn: string; } |
11 inherited methods from 3 models
From MultiRegionDisplayMixin: regionHasData, isCacheValid
From RegionTooLargeMixin: gateFetchState, resolvedByteLimit
From BaseDisplay: renderingProps, , exportedFeatures, configProblemsOf, liftPlot, plotProblems, plotWrites
Actions
| Member | Description |
|---|---|
| fetchNeeded |
|
startRenderingBackend(backend: ScoreRenderingBackend) => void |
|
renderSvg(opts?: ExportSvgDisplayOptions) => Promise<ReactNode> |
The SVG export, lazily loaded with the mark list it paints through. Its own block: the export reads self as the slice renderSvg.tsx declares, and MST does not type a block's own members onto its self |
42 inherited actions from 7 models
From StoredHoverMixin: setHoveredFeature, clearHoveredFeature
From MultiRegionDisplayMixin: setLoadedRegion, evictRegionStore, dropLoadedRegion, clearDisplaySpecificData, clearSettingsBakedData, lapseHeldFetch, clearAllRpcData, invalidateSettings, reload, fetchRegions, afterAttach
From FetchMixin: setError, setStatusMessage, stopActiveFetch, openStatusStream, cancelFetch, cancelFetchByUser, 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