---
schema_version: "1"
id: 696496dcd4465cdd3da5fdb91135dae8776fb41d85d928097a6176f8809b3ca7
title: Annotation | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/Annotation.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Annotation.html
source_site: help.tableau.com
content_type: documentation
content_hash: 097da54edd76602feccb2b1ab00e2cce08ac4633a61341bbfd8e674608856e60
description: Documentation for Tableau Embedding API
---
- Annotation

# Interface Annotation

Represents an annotation in a worksheet.

interface Annotation {  
    [annotationHTML](#annotationhtml): string;  
    [annotationId](#annotationid): number;  
    [annotationText](#annotationtext): string;  
    [annotationType](#annotationtype): [AnnotationType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/AnnotationType.html);  
    [tupleId](#tupleid): number;  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:6

##### Index

### Properties

[annotationHTML](#annotationhtml) [annotationId](#annotationid) [annotationText](#annotationtext) [annotationType](#annotationtype) [tupleId](#tupleid)

## Properties

### annotationHTML[](#annotationhtml)

annotationHTML: string

#### Returns[](#returns)

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

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:10

### annotationId[](#annotationid)

annotationId: number

#### Returns[](#returns-1)

Unique id representing the annotation.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:15

### annotationText[](#annotationtext)

annotationText: string

#### Returns[](#returns-2)

The plain text of the annotation.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:20

### annotationType[](#annotationtype)

annotationType: [AnnotationType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/AnnotationType.html)

#### Returns[](#returns-3)

The annotation type.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:25

### tupleId[](#tupleid)

tupleId: number

#### Returns[](#returns-4)

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

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:30

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[annotationHTML](#annotationhtml)[annotationId](#annotationid)[annotationText](#annotationtext)[annotationType](#annotationtype)[tupleId](#tupleid)