Interface IChapterApi

Interface for the available Chapter API functionality

interface IChapterApi {
    getChapter: ((chapterGuid: string) => Promise<undefined | ILeafletChapter>);
    getChapters: (() => Promise<ILeafletChapter[]>);
    getChapterElement: ((chapterGuid: string) => Promise<undefined | null | HTMLElement>);
    inView: (() => Promise<string[]>);
    onEnterViewport: ((callback: ((chapterGuid: string) => unknown)) => Subscriber);
    onLeaveViewport: ((callback: ((chapterGuid: string) => unknown)) => Subscriber);
}

Properties

getChapter getChapters getChapterElement inView onEnterViewport onLeaveViewport

Properties

getChapter

getChapter: ((chapterGuid: string) => Promise<undefined | ILeafletChapter>)

Get a chapter by GUID

getChapters

getChapters: (() => Promise<ILeafletChapter[]>)

Get all chapters in leaflet

getChapterElement

getChapterElement: ((chapterGuid: string) => Promise<undefined | null | HTMLElement>)

Get a chapter element by GUID

inView

inView: (() => Promise<string[]>)

Get all chapters in view

onEnterViewport

onEnterViewport: ((callback: ((chapterGuid: string) => unknown)) => Subscriber)

Subscribe to chapters entering the viewport

onLeaveViewport

onLeaveViewport: ((callback: ((chapterGuid: string) => unknown)) => Subscriber)

Subscribe to chapters leaving the viewport

Settings

Member Visibility

On This Page

Properties