SequenceAnnotation

class SequenceAnnotation

An Annotation class that holds position specific sequence data. For instance, this can be used to render each character in the query of a sequence alignment at the chromosome position that it was aligned to. This is pretty expensive performance-wise.

Constructors

(conf: SequenceAnnotationConfig): SequenceAnnotation

Parameters

  • conf: SequenceAnnotationConfig

Properties

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.

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.

sequence

sequence: string

The sequence string to be rendered in the visualization.

start

start: number

The start position of the annotation in semantic coordinates (generally a position on a chromosome in base pairs).

tag

tag: undefined | string

An optional tag for the annotation. This can be thought of as a something of a secondary ID.

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.