AnnotationConfigWithGroup

interface AnnotationConfigWithGroup<A extends Annotation>

An interface that extends AnnotationConfig for initializing AnnotationGroups.

Type parameters

  • A: Annotation

Properties

end

end: undefined | number

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

group

group: A []

A list of Annotations to initially fill an AnnotationGroup with.

id

id: undefined | string

A unique identifier for an Annotation object.

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).

suppressWarnings

suppressWarnings: undefined | boolean

This flag suppresses Annotation initialization warnings. Unless you really know what you’re doing, you’ll probably want to leave this alone.

width

width: undefined | number

The width of the annotation in semantic coordinates.