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

annotations

annotations: A []

The group of Annotations that live in this object.

end

end: number

The end coordinate of the Annotation.

id

id: string

A unique identifier for the Annotation.

start

start: number

The start coordinate of the Annotation.

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