BedAnnotation
class BedAnnotation
An Annotation definition for any BED records. Any fields up through BED12 are supported by this class, but nothing beyond the BED3 fields are guaranteed to be defined. For more information on BED records, see https://genome.ucsc.edu/FAQ/FAQformat.html#format1.
Constructors
(config: BedAnnotationConfig): BedAnnotation
Parameters
config: BedAnnotationConfig
Properties
blockCount
blockCount: undefined | number
A BED12 field for records that should be drawn as discontiguous/fragmented glyphs. This describes the number of fragments.
blockSizes
blockSizes: undefined | number []
A BED12 field for records that should be drawn as discontiguous/fragmented glyphs. This describes the size of each fragment.
blockStarts
blockStarts: undefined | number []
A BED12 field for records that should be drawn as discontiguous/fragmented glyphs. This describes the offset of each fragment.
chrom
chrom: string
A BED3 field that describes the chromosome of the record.
end
end: number
The end position of the annotation in semantic coordinates (generally a position on a chromosome in base pairs).
id
id: string
A unique identifier for an Annotation object.
itemRgb
itemRgb: undefined | string
A BED9 field BED field that defines the color of the feature. It is an RGB string, e.g. (0, 1, 256).
name
name: undefined | string
A BED6 field that describes the name of the record.
row
row: number
This describes which horizontal row the Annotation will be rendered in a Chart, assuming that the y-positioning is not overwritten during a call to the glyph rendering API.
score
score: undefined | number
A BED6 field that describes the “score” of the record.
start
start: number
The start position of the annotation in semantic coordinates (generally a position on a chromosome in base pairs).
strand
strand: undefined | Forward | Reverse | Unknown | Unoriented
A BED6 field that describes the orientation/strand of the record.
suppressWarnings
suppressWarnings: boolean
This flag suppresses Annotation initialization warnings. Unless you really know what you’re doing, you’ll probably want to leave this alone.
thickEnd
thickEnd: undefined | number
A BED9 field that describes at which coordinate the feature should stop being drawn “thickly.”
thickStart
thickStart: undefined | number
A BED9 field that describes at which coordinate the feature should start being drawn “thickly.”
width
width: number
The width of the annotation in semantic coordinates.
Accessors
w
get w(): number
A convenience getter that returns the width property.
set w(w: number): void
A convenience setter that sets the width property.
x
get x(): number
A convenience getter that returns the start property.
set x(x: number): void
A convenience setter that sets the start property.
x2
get x2(): number
A convenience getter that returns the end property.
set x2(x: number): void
A convenience setter that sets the end property.
y
get y(): number
A convenience getter that returns the row property.
set y(y: number): void
A convenience setter that sets the row property.