AnnotationConfig

interface AnnotationConfig

An interface that defines the initialization parameters for an Annotation object. For everything to work as expected, you should supply the start property and one of either end or width.

Properties

end

end: undefined | number

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

id

id: undefined | 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: undefined | 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.

start

start: undefined | 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: undefined | number

The width of the annotation in semantic coordinates.