Class Annotations

constructor

• new Annotations(rendition: Rendition): Annotations

  Parameters

  • rendition: Rendition

  Returns Annotations

_annotations

_annotationsBySectionIndex

highlights

marks

rendition

underlines

add

• add(
      type: string,
      cfiRange: string,
      data?: Record<string, any>,
      cb?: EventListener,
      className?: string,
      styles?: Record<string, string>,
  ): Annotation

  Add an annotation to store

  Parameters

  • type: string

    Type of annotation to add: "highlight", "underline", "mark"

  • cfiRange: string

    EpubCFI range to attach annotation to

  • Optionaldata: Record<string, any>

    Data to assign to annotation

  • Optionalcb: EventListener

    Callback after annotation is added

  • OptionalclassName: string

    CSS class to assign to annotation

  • Optionalstyles: Record<string, string>

    CSS styles to assign to annotation

  Returns Annotation

  annotation

each

• each(fn: (annotation: Annotation, key: string) => void): void

  iterate over annotations in the store

  Parameters

  • fn: (annotation: Annotation, key: string) => void

  Returns void

hide

• hide(): void

  [Not Implemented] Hide annotations @TODO: needs implementation in View

  Returns void

highlight

• highlight(
      cfiRange: string,
      data?: Record<string, any>,
      cb?: EventListener,
      className?: string,
      styles?: Record<string, string>,
  ): Annotation

  Add a highlight to the store

  Parameters

  • cfiRange: string

    EpubCFI range to attach annotation to

  • Optionaldata: Record<string, any>

    Data to assign to annotation

  • Optionalcb: EventListener

    Callback after annotation is clicked

  • OptionalclassName: string

    CSS class to assign to annotation

  • Optionalstyles: Record<string, string>

    CSS styles to assign to annotation

  Returns Annotation

mark

• mark(
      cfiRange: string,
      data?: Record<string, any>,
      cb?: EventListener,
  ): Annotation

  Add a mark to the store

  Parameters

  • cfiRange: string

    EpubCFI range to attach annotation to

  • Optionaldata: Record<string, any>

    Data to assign to annotation

  • Optionalcb: EventListener

    Callback after annotation is clicked

  Returns Annotation

remove

• remove(cfiRange: string, type?: string): void

  Remove an annotation from store

  Parameters

  • cfiRange: string

    EpubCFI range the annotation is attached to

  • Optionaltype: string

    Type of annotation to add: "highlight", "underline", "mark"

  Returns void

show

• show(): void

  [Not Implemented] Show annotations @TODO: needs implementation in View

  Returns void

underline

• underline(
      cfiRange: string,
      data?: Record<string, any>,
      cb?: EventListener,
      className?: string,
      styles?: Record<string, string>,
  ): Annotation

  Add a underline to the store

  Parameters

  • cfiRange: string

    EpubCFI range to attach annotation to

  • Optionaldata: Record<string, any>

    Data to assign to annotation

  • Optionalcb: EventListener

    Callback after annotation is clicked

  • OptionalclassName: string

    CSS class to assign to annotation

  • Optionalstyles: Record<string, string>

    CSS styles to assign to annotation

  Returns Annotation