# Annotation Annotation class **Kind**: global class * [Annotation](#Annotation) * [new Annotation(type, cfiRange, [options])](#new_Annotation_new) * _instance_ * [.update(data)](#Annotation+update) * [.attach(view)](#Annotation+attach) ⇒ object \| null * [.detach(view)](#Annotation+detach) ⇒ boolean * [.text()](#Annotation+text) * _static_ * [.type](#Annotation.type) : string * [.sectionIndex](#Annotation.sectionIndex) : number * [.mark](#Annotation.mark) : Mark * ["attach" (result)](#Annotation.event_attach) * ["detach" (result)](#Annotation.event_detach) ## new Annotation(type, cfiRange, [options]) Constructor | Param | Type | Description | | --- | --- | --- | | type | string | Type of annotation to add: `"highlight"` OR `"underline"` | | cfiRange | string | EpubCFI range to attach annotation to | | [options] | object | | | [options.data] | object | Data to assign to annotation | | [options.cb] | function | Callback after annotation is clicked | | [options.className] | string | CSS class to assign to annotation | | [options.styles] | object | CSS styles to assign to annotation | ## annotation.update(data) Update stored data **Kind**: instance method of [Annotation](#Annotation) | Param | Type | | --- | --- | | data | object | ## annotation.attach(view) ⇒ object \| null Add to a view **Kind**: instance method of [Annotation](#Annotation) | Param | Type | | --- | --- | | view | View | ## annotation.detach(view) ⇒ boolean Remove from a view **Kind**: instance method of [Annotation](#Annotation) | Param | Type | | --- | --- | | view | View | ## annotation.text() [Not Implemented] Get text of an annotation **Kind**: instance method of [Annotation](#Annotation) **Todo:**: needs implementation in contents ## Annotation.type : string **Kind**: static property of [Annotation](#Annotation) **Read only**: true ## Annotation.sectionIndex : number **Kind**: static property of [Annotation](#Annotation) **Read only**: true ## Annotation.mark : Mark **Kind**: static property of [Annotation](#Annotation) **Read only**: true ## "attach" (result) **Kind**: event emitted by [Annotation](#Annotation) | Param | Type | | --- | --- | | result | Mark | ## "detach" (result) **Kind**: event emitted by [Annotation](#Annotation) | Param | Type | | --- | --- | | result | boolean |