PlotAnnotation

class PlotAnnotation

An Annotation object that can be used to represent data that should be visualized as a plot.

Constructors

(config: PlotAnnotationConfig): PlotAnnotation

Parameters

  • config: PlotAnnotationConfig

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.

maxValue

maxValue: number

The maximum y value in the data points.

minValue

minValue: number

The minimum y value in the data points.

pointWidth

pointWidth: number

The distance between two consecutive data points.

points

points: None []

The individual data points for the plot.

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.

start

start: number

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

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.

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.