Skip to main content

MatrixRampMixin

Auto-generated from the @jbrowse/mobx-state-tree model in the source. See the developer guide for concepts. Built into JBrowse core. View source.

A matrix display's encoding.color as it paints: the painted field through its preset's ramp (colorEncoding), that ramp's scheme, direction and 256-entry table (colorScheme, colorReverse, colorRamp), the domain and middle stop it spans over the display's colorExtent (colorDomain, colorMidNorm), all four as the painters read them (matrixColor), the legend's ramp (rampColorScales), and the scheme pick (setColorScheme) through the ColorWritesMixin it composes. Under a threshold scale the intervals (colorBins) paint through a table of one band each, the display handing the painters each value at its interval's centre (binnedColorValues), and the key lists the intervals. A display that may paint a field other than the written one, because the file could not serve it, answers paintedColorField; one whose values follow the data, rather than a statistic's fixed range, answers colorExtent

Each section ends with the members a composed model contributes, linked to the page that documents them.

Properties

1 inherited property from one model

From ParkedColorMixin: parkedColors

Getters

Member Description
paintedColorField
F		 Overridable hook: the field the loaded cells are, the written one unless the display overrides it with what the file served.
colorExtent
readonly [number, number]		 Overridable hook: what an unset end of the domain follows, the unit interval unless the display overrides it with its loaded values.
paintedColorSetting
ColorSetting		 encoding.color's painted members as written.
colorEncoding
MatrixColorEncoding<F>		 The color channel under the painted field's preset, with an unset scale.reverse turning round a scheme dark at its low end, since an unpainted cell is the page behind the matrix. The preset's scheme, and its direction with it, fill whichever continuous scale is written: withPreset drops a preset whose scale differs, which would leave the Log toggle painting no field's scheme, or observed/expected's enrichment blue.
colorScaleType
"linear" | "log" | "symlog"
colorScheme
"blues" | "cividis" | "fall" | "inferno" | "juicebox" | "magma" | "purpleorange" | "redblue" | "redgreyblue" | "reds" | "redyellowblue" | "viridis"
colorReverse
boolean		 scale.reverse, or where unset whether the scheme runs dark at its low end.
schemeRamp
Uint8Array<ArrayBufferLike>		 The scheme's 256 entries, read off colorScheme and colorReverse rather than the encoding, so a domain edit re-uploads no texture.
colorBins
MatrixColorBins | undefined		 Under a threshold scale, its intervals: the domain cuts and a range color each, an interval range leaves unnamed sampling the scheme evenly from its low end.
colorRamp
Uint8Array<ArrayBufferLike>		 The 256 entries the GPU's texture, the Canvas2D fill and the legend read: the scheme's ramp, or under a threshold one band per interval.
colorScale
{ domain: [number, number]; lut: Uint8Array<ArrayBufferLike>; midNorm: number; colorOf: (value: number) => number; }
 colorEncoding over colorExtent: each pinned end holds and an open one follows the extent, as the mark display's ramps do.
colorDomain
[number, number]
colorMidNorm
number		 Where domainMid sits on the normalized ramp, 0.5 unset, so a diverging scheme centres on it and equal distances from it take equal colors.
matrixColor
MatrixColorState
colorFieldTitle
string		 The painted field's own key title, from its preset.
3 inherited getters from 2 models

From ColorWritesMixin: writtenColor

From ParkedColorMixin: parkedColor, parkedIdentity

Methods

Member Description
rampColorScales
({ id, title, extent: { min, max }, }: { id: string; title: string; extent: { min?: number | undefined; max: number; }; }) => ColorScale[]
 The legend's ramp, once there is a domain to span: its bottom where the scale paints it, a log scale's floor included, titled by encoding.color.legend.title where written, else title; under a threshold, its intervals, highest first under legend.descending. An end of the domain the loaded values run past reads ≤ or ≥; an unset min is the key's own bottom.
1 inherited method from one model

From ParkedColorMixin: parkedColorOf

Actions

Member Description
setColorScheme
(scheme: "blues" | "cividis" | "fall" | "inferno" | "juicebox" | "magma" | "purpleorange" | "redblue" | "redgreyblue" | "reds" | "redyellowblue" | "viridis") => void
 The scheme (colorByScheme), the painted field's preset naming the scheme that follows the field.
7 inherited actions from 2 models

From ColorWritesMixin: colorByField, setColorValue, colorByIdentity, colorByScheme, pickDefaultColor, pickSolidColor

From ParkedColorMixin: parkColor