# Annotations Handles managing adding & removing Annotations **Kind**: global class * [Annotations](#Annotations) * [new Annotations(rendition)](#new_Annotations_new) * [.append(type, cfiRange, [options])](#Annotations+append) ⇒ Annotation * [.remove(type, cfiRange)](#Annotations+remove) * [.show()](#Annotations+show) * [.hide()](#Annotations+hide) ## new Annotations(rendition) Constructor | Param | Type | | --- | --- | | rendition | Rendition | ## annotations.append(type, cfiRange, [options]) ⇒ Annotation Append an annotation to store **Kind**: instance method of [Annotations](#Annotations) **Returns**: Annotation - Annotation that was append | Param | Type | Description | | --- | --- | --- | | type | string | Type of annotation to append: `"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 added | | [options.className] | string | CSS class to assign to annotation | | [options.styles] | object | CSS styles to assign to annotation | ## annotations.remove(type, cfiRange) Remove an annotation from store **Kind**: instance method of [Annotations](#Annotations) | Param | Type | Description | | --- | --- | --- | | type | string | Type of annotation to remove: `"highlight"` OR `"underline"` | | cfiRange | string | EpubCFI range to attach annotation to | ## annotations.show() [Not Implemented] Show annotations **Kind**: instance method of [Annotations](#Annotations) **Todo:**: needs implementation in View ## annotations.hide() [Not Implemented] Hide annotations **Kind**: instance method of [Annotations](#Annotations) **Todo:**: needs implementation in View