LinearScoreDisplay

Auto-generated from the @jbrowse/mobx-state-tree model in the source — see the developer guide for concepts. View source.

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',
      scoreColumn: 'score',
    },
  ],
}

The worked-example score display: one value per feature, drawn as a box along the genome. The developer guides walk through this model.

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 `type: types.literal('LinearScoreDisplay')`
configuration `configuration: ConfigurationReference(configSchema)`

1 inherited property from one model

From BaseDisplay: id

Volatiles

23 inherited volatiles from 7 models

From BaseDisplay: error, statusMessage, statusProgress

From TrackHeightMixin: scrollTop, hostHeight

From MultiRegionDisplayMixin: loadedRegions

From RegionTooLargeMixin: forceLoadTrack, byteEstimate, gateMeasuredViewportKey

From RenderLifecycleMixin: canvasDrawn, paintCount, currentRenderingBackend, renderTick, autorunsInstalled, renderError, offScreen

From FetchMixin: activeSignal, fetchGeneration, reloadCounter, statusWindow, fetchCanceled, fetchRotation

From StoredHoverMixin: storedHoveredFeature

Getters

Member	Description
rpcDataMap `ReadonlyMap<number, ScoreRegionData>`
view ModelInstanceTypeProps<…> & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & { rubberbandClickMenuItems(clickOffset: BpOffset): MenuItem[]; highlightMenuItems(_highlight: HighlightType): MenuItem[]; } & { flyTo: (centerBp: number, windowWidthBp: number) => void; flyToCenter(coord: number, refName: string, displayedRegionIndex?: number \| undefined): void; flyToFit(centerBp: number, fitWidthBp: number): void; } & { afterCreate(): void; afterAttach(): void; } & IStateTreeNode<…>
domain `[number, number]`
renderState `ScoreRenderState`
hoverInk `HighlightRect[]`

70 inherited getters from 6 models

From BaseDisplay: parentTrack, RenderingComponent, DisplayBlurb, adapterConfig, isMinimized, hoveredFeature, featureNoun, featureWidgetType, plotKeys, plot, plotExamples, configDocsUrl

From TrackHeightMixin: configuredHeight, allottedHeight, height, resizing, scrollContentHeight, scrollViewportHeight, scrollableHeight

From MultiRegionDisplayMixin: host, canvasWidthPx, settledSubPixelBinBp, canRender, rendersCanvas, trackVisibleRegions, viewportWithinLoadedData, viewportEmpty, fetchSuspended, layoutReady, dataSuperseded, renderBlocks, fetchInputs, regionPayloads, hasRegionData, staleSettingsDrawn, dataCurrent, loadedAssembly, phaseViewportCurrent, svgReady, paintInert, paintSuperseded, displayPhase

From RegionTooLargeMixin: gateEnabled, byteGateAdapterConfig, configuredFetchSizeLimit, densityTooLarge, byteGateAdapterPath, adapterFetchSizeLimit, configForceLoad, gateViewportSpanBp, gateViewport, aboveForceLoadFloor, gateExempt, estimatedFetchBytes, gateMeasurementStale, gateByteLimit, gateActive, densityGateActive, tooLargeStatus, regionTooLarge, regionTooLargeReason, zoomCanReleaseGate, gateSkipsMeasuredViewport

From RenderLifecycleMixin: painted

From FetchMixin: isLoading, isLoadingOrCanceled, fetchInert, awaitingPrerequisite, awaitingDependentData, settingsFetchInputs

Methods

Member	Description
rpcProps `() => { scoreColumn: string; }`

9 inherited methods from 3 models

From BaseDisplay: renderingProps, trackMenuItems, liftPlot, plotProblems, plotWrites

From MultiRegionDisplayMixin: regionHasData, isCacheValid

From RegionTooLargeMixin: resolvedByteLimit, gateFetchState

Actions

Member	Description
fetchNeeded `(needed: { region: Region; displayedRegionIndex: number; }[]) => Promise<void>`
startRenderingBackend `(backend: ScoreRenderingBackend) => void`
renderSvg `(opts?: ExportSvgDisplayOptions \| undefined) => Promise<ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| AwaitedReactNode>`	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`