@jbrowse/plugin-wiggle
Auto-generated from exported functions tagged #api in the source. See
imports and re-exports for how to
import these from a plugin.
wiggleTables
A region, or several, of a quantitative track as the wiggle display
fetches, scales and colors it, as tables: bins, each source's scores as
the worker ships them at this zoom (the bin's score, and its min and max
where the file summarizes); summaryField, which of them the display plots
(score, minScore or maxScore); marks, the layers the display's
encoder builds from them in paint order (the plotted summary, and under a
min-max extent the tinted max and min bands, or a line's min-to-max
band), each mark in the color it paints and reaching down to low, the
band's min or the origin bars grow from; scoreScale, the score axis the
display autoscales to under encoding.y, its domain, type and
symlogConstant; rules, the reference lines it draws; ramps, the color
bar its key shows where one ramp paints every row (rampKeyOf); and
warnings, the samples file's. For a host that draws them itself, such as
R through V8. The adapters must be registered on pluginManager
(registerWiggleAdapters).
// type signature
(pluginManager: PluginManager, { adapterConfig, regions, display, bpPerPx, trackType, }: WiggleTablesArgs) => Promise<{ bins: {…}; marks: {…}; sources: {…}; rules: {…}; ramps: {…}[]; scoreScale: { domain: [number, number]; type: string; symlogConstant: number; }; summaryField: "maxScore" | "minScore" | "score"; mark: "bar" | "line" | "point" | "rect"; interpolate: "linear" | "step"; origin: number; rowLayout: boolean; height: number; config: Record<string, unknown>; warnings: string[]; }>