Interface CourseReaderPage

Handle returned by createCourseReaderPage.

interface CourseReaderPage {
    content: HTMLElement;
    element: HTMLDivElement;
    settings: ScanSettings;
    destroy(): void;
    update(overrides: DeepPartial<ScanSettings>): void;
}

Index

Properties

content element settings

Methods

Properties

`Readonly`content

content: HTMLElement

Original source element, now inside the wrapper.

`Readonly`element

element: HTMLDivElement

Wrapper element inserted into the document.

`Readonly`settings

settings: ScanSettings

Resolved settings currently applied to the page.

Methods

destroy

destroy(): void
Removes the wrapper and restores the original element.

Returns void
- Defined in types.ts:309

update

update(overrides: DeepPartial<ScanSettings>): void
Merges overrides into the current settings and re-renders.
Parameters
- overrides: DeepPartial<ScanSettings>
Returns void
- Defined in types.ts:304