AnnotationGroup

class AnnotationGroup<A extends Annotation>

An Annotation class that contains a group of Annotations.

Type parameters

  • A: Annotation

Constructors

(config: AnnotationGroupConfig <A>): AnnotationGroup

Type parameters

  • A: Annotation

Parameters

  • config: AnnotationGroupConfig

Properties

end

end: number

group

group: A []

The group of Annotations that live in this object.

id

id: string

row

row: number

start

start: number

suppressWarnings

suppressWarnings: boolean

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

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. It also sets the row property on every member of the group property.

Methods

add

add(ann: A | A []): void

Add an Annotation or list of Annotations to the group.

Parameters

  • ann: A | A []

Returns: void

addAnnotation

addAnnotation(ann: A): void

Add an Annotation to the group.

Parameters

  • ann: A

Returns: void