@jbrowse/plugin-dotplot-view
Auto-generated from exported functions tagged #api in the source. See
imports and re-exports for how to
import these from a plugin.
dotplotTables
A dotplot as the display fetches, lays out and colors it, as tables:
alignments, each block with the span of it each axis shows (length
stays the whole block's query span), its strand, name and
measurements, in the color the view's encoding.color paints it; segments, the
lines the plot draws in paint order, one per block, or one per CIGAR step
where a block is wide enough on screen for its CIGAR to show, each from
(xStart, yStart) to (xEnd, yEnd) in genomic coordinates on the
axis's region named by xRegion and yRegion; legend, the key, and
legendAlpha, the alpha the view composites its chips at, alpha floored
for legibility; and config, the view's settings with their defaults
filled, encoding.color and encoding.opacity as config objects.
skipped is the blocks the plot cannot place: count of the total
fetched, each with no mate or on a contig an axis does not show, and those
contigs, xChroms the x axis's and yChroms the y axis's. For a host
that draws them itself, such as R through V8.
import { dotplotTables } from '@jbrowse/plugin-dotplot-view/tables'
function dotplotTables(
pluginManager: PluginManager,
opts: DotplotTablesArgs,
): Promise<{
config: {
encoding: {
color: Record<string, unknown>
opacity: Record<string, unknown>
}
filter: FieldPredicate[]
indels: Record<string, unknown>
lineWidth: number
}
alpha: number
assemblyNames: string[]
skipped: {
count: number
total: number
xChroms: string[]
yChroms: string[]
}
legend: { label: string[]; color: string[] }
legendTitle: string
legendAlpha: number
ramps: {
offset: number[]
color: string[]
opacity: number[]
minLabel: string
maxLabel: string
id: string
title: string
}[]
alignments: {
color: string[]
alpha: number[]
name: string[]
xChrom: string[]
xStart: number[]
xEnd: number[]
yChrom: string[]
yStart: number[]
yEnd: number[]
strand: number[]
length: number[]
}
segments: {
alignment: number[]
op: string[]
xRegion: number[]
xChrom: string[]
xStart: number[]
xEnd: number[]
yRegion: number[]
yChrom: string[]
yStart: number[]
yEnd: number[]
color: string[]
alpha: number[]
}
}>