Options
All
  • Public
  • Public/Protected
  • All
Menu

Class D2Reader

R2D2BC Reader

Hierarchy

  • D2Reader

Index

Accessors

  • get annotations(): any
  • get atEnd(): boolean
  • get atStart(): boolean
  • get bookmarks(): any
  • Navigation

    todo

    : These should return promises that complete when they are done.

    Returns Locator

  • get currentResource(): undefined | number
  • get currentSettings(): { appearance: string; columnCount: string; fontFamily: string; fontSize: number; letterSpacing: number; lineHeight: number; pageMargins: number; textAlignment: string; verticalScroll: boolean; wordSpacing: number }
  • Settings

    Returns { appearance: string; columnCount: string; fontFamily: string; fontSize: number; letterSpacing: number; lineHeight: number; pageMargins: number; textAlignment: string; verticalScroll: boolean; wordSpacing: number }

    • appearance: string
    • columnCount: string
    • fontFamily: string
    • fontSize: number
    • letterSpacing: number
    • lineHeight: number
    • pageMargins: number
    • textAlignment: string
    • verticalScroll: boolean
    • wordSpacing: number
  • get hasMediaOverlays(): boolean
  • get mostRecentNavigatedTocItem(): string
  • get positions(): any
  • get publicationLanguage(): string[]
  • get readingOrder(): any
  • get tableOfContents(): any
  • get totalResources(): number

Methods

  • activateMarker(id: string, position: string): void
  • Activate Marker
    Activated Marker will be used for active annotation creation

    Parameters

    • id: string
    • position: string

    Returns void

  • addAnnotation(highlight: Annotation): Promise<any>
  • Add annotation

    Parameters

    • highlight: Annotation

    Returns Promise<any>

  • addDefinition(definition: any): Promise<void>
  • Add newt definition

    Parameters

    • definition: any

    Returns Promise<void>

  • addEventListener(): void
  • applyAttributes(value: IFrameAttributes): void
  • You have attributes in the reader when you initialize it. You can set margin, navigationHeight etc... This is in case you change the attributes after initializing the reader.

    Parameters

    • value: IFrameAttributes

    Returns void

  • applyLineFocusSettings(userSettings: any): Promise<void>
  • applyMediaOverlaySettings(settings: Partial<IMediaOverlayUserSettings>): Promise<void>
  • Parameters

    • settings: Partial<IMediaOverlayUserSettings>

    Returns Promise<void>

  • applyPreferredVoice(value: string): Promise<void>
  • applyTTSSettings(ttsSettings: Partial<ITTSUserSettings>): Promise<void>
  • Parameters

    • ttsSettings: Partial<ITTSUserSettings>

    Returns Promise<void>

  • applyUserSettings(userSettings: Partial<UserSettings>): Promise<void>
  • Parameters

    • userSettings: Partial<UserSettings>

    Returns Promise<void>

  • clearDefinitions(): Promise<void>
  • clearSearch(): Promise<void>
  • deactivateMarker(): void
  • decrease(incremental: UserSettingsIncrementable | TTSIncrementable | MediaOverlayIncrementable): Promise<void>
  • Used to decrease anything that can be decreased, such as pitch, rate, volume, fontSize

    Parameters

    • incremental: UserSettingsIncrementable | TTSIncrementable | MediaOverlayIncrementable

    Returns Promise<void>

  • deleteAnnotation(highlight: Annotation): Promise<any>
  • Delete annotation

    Parameters

    • highlight: Annotation

    Returns Promise<any>

  • deleteBookmark(bookmark: Bookmark): Promise<any>
  • Delete bookmark

    Parameters

    • bookmark: Bookmark

    Returns Promise<any>

  • disableLineFocus(): void
  • enableLineFocus(): Promise<void>
  • goTo(locator: Locator): Promise<void>
  • goToPosition(value: number): Promise<void>
  • goToSearchID(href: string, index: number, current: boolean): Promise<void>
  • Parameters

    • href: string
    • index: number
    • current: boolean

    Returns Promise<void>

  • goToSearchIndex(href: string, index: number, current: boolean): Promise<void>
  • Parameters

    • href: string
    • index: number
    • current: boolean

    Returns Promise<void>

  • hideAnnotationLayer(): undefined | void
  • hideLayer(layer: any): void
  • increase(incremental: UserSettingsIncrementable | TTSIncrementable | MediaOverlayIncrementable): Promise<void>
  • Used to increase anything that can be increased, such as pitch, rate, volume, fontSize

    Parameters

    • incremental: UserSettingsIncrementable | TTSIncrementable | MediaOverlayIncrementable

    Returns Promise<void>

  • lineDown(): void
  • lineFocus(active: boolean): Promise<void>
  • lineUp(): void
  • nextPage(): Promise<void>
  • nextResource(): void
  • pauseReadAlong(): void
  • pauseReadAloud(): void
  • previousPage(): Promise<void>
  • previousResource(): void
  • resetMediaOverlaySettings(): Promise<void>
  • resetTTSSettings(): void
  • resetUserSettings(): Promise<void>
  • resumeReadAlong(): void
  • resumeReadAloud(): void
  • saveBookmark(): Promise<any>
  • saveBookmarkPlus(): Promise<any>
  • scroll(value: boolean): Promise<void>
  • search(term: string, current: boolean): Promise<any>
  • Search by term and current resource or entire book
    current = true, will search only current resource
    current = false, will search entire publication

    Parameters

    • term: string
    • current: boolean

    Returns Promise<any>

  • showAnnotationLayer(): undefined | void
  • showLayer(layer: any): void
  • snapToSelector(selector: any): Promise<void>
  • startReadAlong(): void
  • startReadAloud(): void
  • stop(): void
  • Destructor: Only used in react applications because when they re-visit the page it tried to create a new reader, which interfered with the first one.

    Returns void

  • stopReadAlong(): void
  • stopReadAloud(): void
  • load(initialConfig: ReaderConfig): Promise<D2Reader>

Generated using TypeDoc