Interface Annotation

Represents an annotation in a worksheet.

interface Annotation {
    annotationHTML: string;
    annotationId: number;
    annotationText: string;
    annotationType: AnnotationType;
    tupleId: number;
}

Properties

annotationHTML: string

The formatted annotation as a HTML string. HTML is currently not accepted when adding an annotation.

annotationId: number

Unique id representing the annotation.

annotationText: string

The plain text of the annotation.

annotationType: AnnotationType

The annotation type.

tupleId: number

Unique tuple representing the mark that is being annotated. The tupleId will be 0 for Area or Point annotations.