---
schema_version: "1"
id: 07d1222bc31d8834065142a95b91cce81dfce7597f4b06ce9f618cf717b24a18
title: Annotation | Tableau Embedding API
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/Annotation.md
canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Annotation.html
source_site: help.tableau.com
content_type: documentation
content_hash: b14d7ef25fb24787fe0b5d072352b3e6b650a0471f37b81434b312a53e8d2fc5
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/v0.0/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/v0.0/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)