BaseChordDisplay
Auto-generated from the @jbrowse/mobx-state-tree model in the source. See the developer guide for concepts. Provided by the circular-view plugin. View source.
What the circular view's chord and ribbon displays share: the features, the
slice index a feature end is looked up in, the lifecycle getters
ChordDisplayFrame publishes, and the linear displays' region-too-large
gate, which a display opts into with gateEnabled. A track
draws on the arcs of the assemblies it names, so a one-genome variant track
on a two-genome circle fetches and places only that genome's chords.
Each section ends with the members a composed model contributes, linked to the page that documents them.
Properties
2 inherited properties from one model
From BaseDisplay: id, type
Volatiles
| Member | Description |
|---|---|
featuresFeature[] | undefined |
|
reloadCounternumber |
the fetch's pure "go again" signal |
6 inherited volatiles from 2 models
From RegionTooLargeMixin: forceLoadTrack, byteEstimate, gateMeasuredViewportKey
From BaseDisplay: error, statusMessage, statusProgress
Getters
| Member | Description |
|---|---|
viewCircularView |
|
trackAssemblyNamesstring[] |
the track's assemblies that are on the circle, canonical and in the order the circle lays them out |
trackRegionsRegion[] |
the displayed regions on the track's assemblies |
fetchInertboolean |
nothing of this track's is on the circle, so the fetch never runs; the SVG export's wait and the retry contract check both read it |
loadedboolean |
|
readyboolean |
|
displayErrorunknown |
what the error ring shows |
settingsFetchInputs{} |
a chord fetch takes no settings, so the gate's measurement is about the regions alone |
svgReadyboolean |
the off-screen export gate, on the shared computeSvgReady policy. A radial display has no box to draw an error in, so the export fails rather than exporting a message |
displayPhaseDisplayStatusPhase |
|
radiusPxnumber |
|
curveDepthnumber |
mark.depth, how deeply a chord curves toward the center, 0 to 1 |
bezierRadiusnumber |
the radius of a chord's Bezier control point when its ends are opposite each other |
hoveredFeatureIdstring | undefined |
the feature under the pointer, which the view hit-tests for every chord display at once |
figureStageChordStage |
the polar stage on the unrotated figure, which the view's SVG turns: what the export, the highlight paths and the hit tests are placed on |
drawnLanes{ count: number; features: readonly Feature[]; } |
Overridable hook: the drawn records, one per lane, in paint order |
laneIndexByIdReadonlyMap<string, number> |
each drawn record's lane, by id |
drawnCountnumber |
how many lanes the canvas draws, a chord under a pixel included |
shapesShape[] |
every drawn shape, as the export draws it |
38 inherited getters from 2 models
From RegionTooLargeMixin: gateEnabled, byteGateAdapterConfig, densityTooLarge, byteGateAdapterPath, adapterFetchSizeLimit, gateViewportSpanBp, gateViewport, configuredFetchSizeLimit, configForceLoad, aboveForceLoadFloor, gateExempt, estimatedFetchBytes, gateByteLimit, gateActive, gateMeasurementStale, densityGateActive, tooLargeStatus, regionTooLarge, regionTooLargeReason, zoomCanReleaseGate, gateSkipsMeasuredViewport
From BaseDisplay: parentTrack, selectedFeatureId, RenderingComponent, DisplayBlurb, adapterConfig, isMinimized, hoveredFeature, featureNoun, featureWidgetType, liveNotices, plotKeys, plot, configNotices, notices, cornerNotices, plotExamples, configDocsUrl
Methods
| Member | Description |
|---|---|
shapeAt(_i: number) => Shape | undefined |
Overridable hook: lane i as the SVG side draws it, on the unrotated figure; undefined where it draws nothing |
laneAt(_x: number, _y: number) => number | undefined |
Overridable hook: the topmost lane under a point on the unrotated figure |
shapeFor(featureId: string) => Shape | undefined |
the shape a drawn record's id names, undefined where none draws |
shapePathFor(feature: Feature) => string | undefined |
a drawn feature's outline as an SVG path on the unrotated figure, for anything that has to find a shape on screen without a DOM node |
hitAt(dx: number, dy: number) => Feature | undefined |
the record drawn under a point CSS px from the circle's centre in the screen frame |
assemblyOf(assemblyName: string | undefined) => string | undefined |
the assembly on the circle a feature names, in whatever spelling the adapter wrote. A feature that names none, as a VCF record does not, is on the track's first assembly. |
canonicalRefName(assemblyName: string, refName: string) => string |
a refName as the adapter wrote it, in the assembly's canonical spelling |
placeEnd(assemblyName: string | undefined, refName: string) => PlacedEnd |
one end of a feature, as the adapter wrote it, on the circle: the assembly it names (assemblyOf) and its refName in that assembly's spelling, the assembly undefined where it names none on the circle |
axisSlice({ assemblyName, refName }: PlacedEnd) => AxisSlice | undefined |
the slice of the unrolled axis a placed end falls in |
9 inherited methods from 2 models
From RegionTooLargeMixin: gateFetchState, resolvedByteLimit
From BaseDisplay: renderingProps, , exportedFeatures, configProblemsOf, liftPlot, plotProblems, plotWrites
Actions
| Member | Description |
|---|---|
openErrorDialog() => void |
|
clickFeature(feature: Feature) => void |
what a click on the canvas reaches: the record's details |
setFeatures(features: Feature[] | undefined) => void |
|
reload() => void |
10 inherited actions from 2 models
From RegionTooLargeMixin: clearByteEstimate, clearGateMeasurements, setForceLoadTrack, commitFetchBytes, forceLoad
From BaseDisplay: setStatusMessage, setError, clearHoveredFeature, applyDisplaySettings, applyPlot