LinearHicDisplay
Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the hic plugin. View source.
Example usage
A minimal HicTrack config. See the
Hi-C track guide for all options:
{
type: 'HicTrack',
trackId: 'hic',
name: 'Hi-C',
assemblyNames: ['hg38'],
adapter: { type: 'HicAdapter', uri: 'https://example.com/contacts.hic' },
}
With log scale and a coarser resolution (resolutionBias nudges the
auto-picked binsize; negative = finer, positive = coarser). The
displayDefaults object shorthand applies settings to whichever display uses
them — equivalent to a full displays: [{ type, displayId, ... }] array. See
configuring displays:
{
type: 'HicTrack',
trackId: 'hic',
name: 'Hi-C',
assemblyNames: ['hg38'],
adapter: { type: 'HicAdapter', uri: 'https://example.com/contacts.hic' },
displayDefaults: { useLogScale: true, resolutionBias: 1 },
}
See the Config slots section below for all available configuration fields.
Related links
- Adapter: HicAdapter
- State model: runtime API
- Base config: BaseLinearDisplay
- Guide: Custom track and display types
- Guide: Defaults for all tracks
- Config guide: Hi-C track
- User guide: Hi-C track
- Guide: Structural variants from Hi-C
- Guide: Tracks
Config slots
These slots go on a display entry: "displays": [{ "type": "LinearHicDisplay", ... }], or in the track's displayDefaults when this is its default display. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.
| Slot | Description |
|---|---|
heightnumber = 300 | default height for the Hi-C track |
colorSchemestringEnum (juicebox, fall, viridis) = 'juicebox' | color ramp used to render contact intensity |
showLegendmaybeBoolean = false promotable | show the color scale legend. Unset (the default) follows the session-wide default for this display type, falling back to off; an explicit true/false customizes the track |
resolutionBiasnumber = 0 | Signed integer offset from the zoom-derived auto-picked binsize. 0 means pure auto; -1 is one step finer, +1 one step coarser. Tracking the offset (not an absolute binsize) keeps the intent valid across zoom. |
useLogScaleboolean = false | map contact counts to color on a log2 scale |
useColorPercentileboolean = true | false → maxScore/20 (linear) or maxScore (log); true → 95th percentile of counts, so off-diagonal contacts read more strongly. |
showResolutionControlsboolean = false | show the on-figure resolution dropdown in the overlay |
selectedNormalizationstring = 'KR' | The user's chosen matrix normalization scheme (e.g. KR, SCALE, VC, NONE). Resolved at runtime against what the .hic file actually provides — see the model's activeNormalization getter. |
squashToHeightboolean = false | squash the triangle vertically to fit the display height instead of drawing square bins |
| Inherited from BaseLinearDisplay | 7 slots |
maxFeatureScreenDensitynumber = 1 | maximum features per pixel before showing a "too many features" message advanced |
mouseoverstring = | text to display when the cursor hovers over a feature callback args: feature |
jexlFiltersstringArray = [] | config jexlFilters are deferred evaluated so they are prepended with jexl at runtime rather than being stored with jexl in the config |
fetchSizeLimitnumber = 1_000_000 | maximum data to attempt to download for a given track, used if adapter doesn't specify one advanced |
forceLoadboolean = false | Declarative equivalent of the "Force load" button on the "too much data" banner: when true the display always renders, however large the region or dense the features. Off by default (the gate guards against huge downloads). Set it on a view no one can interact with — an embedded / notebook view, or a screenshot — where the region is known and you want it drawn without a click. advanced |
densityTierstringEnum (auto, features, density) = 'auto' | when to draw the features-per-bin density band in place of features: "auto" swaps to it where the region is too large to fetch, "features" never does and keeps the banner, "density" always does. Needs a density source on the adapter (its densityAdapter slot) advanced |
densityTierBpPerPxnumber = 0 | in "auto" mode, also draw the density band from this many bp per pixel outward, before the region is too large to fetch; 0 leaves the swap to the fetch-size gate alone advanced |