Bed9Annotation
class Bed9Annotation
An annotation object to represent BED annotations explicitly constrained in the BED9 format.
Constructors
(config: Bed9AnnotationConfig): Bed9Annotation
Parameters
config: Bed9AnnotationConfig
Properties
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. If an ID is not provided, one will be automatically generated by SODA when the Annotation is instantiated.
itemRgb
itemRgb: 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: 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: 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: Orientation
A BED6 field that describes the orientation/strand of the record.
tag
tag: undefined | string
An optional tag for the annotation. This can be thought of as a something of a secondary ID.
thickEnd
thickEnd: number
A BED9 field that describes at which coordinate the feature should stop being drawn “thickly.”
thickStart
thickStart: 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.