Constructor
new BookViewer(options)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
options |
BookViewerOptions | Viewer options. |
Classes
Methods
adjustZoom(direction) → {void}
- Description:
Adjusts content zoom. Positive values zoom in; negative values zoom out.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
direction |
number | Zoom direction. |
Returns:
- Type
- void
getSpreadGeometry() → {SpreadGeometry|null}
- Description:
Returns the latest geometry emitted by the renderer.
- Source:
Returns:
Latest spread geometry.
- Type
- SpreadGeometry | null
navigateTo(spreadIndex, preferredPageIndexopt) → {void}
- Description:
Navigates to a spread. Long jumps are queued as multiple page turns.
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
spreadIndex |
number | Target spread index. |
||
preferredPageIndex |
number | null |
<optional> |
null
|
Page index to prefer when updating selection/readouts. |
Returns:
- Type
- void
off(event, fn) → {void}
- Description:
Removes a viewer event listener.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
event |
string | Event name. |
fn |
function | Listener callback. |
Returns:
- Type
- void
on(event, fn) → {function}
- Description:
Subscribes to a viewer event.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
event |
string | Event name. |
fn |
function | Listener callback. |
Returns:
Unsubscribe function.
- Type
- function
resetZoom() → {void}
- Description:
Resets content zoom to 1.
- Source:
Returns:
- Type
- void
setDisplay(display) → {void}
- Description:
Merges display fields and redraws.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
display |
Partial.<Display> | Display fields to update. |
Returns:
- Type
- void
setLayout(layout) → {void}
- Description:
Merges layout fields and redraws.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
layout |
Partial.<Layout> | Layout fields to update. |
Returns:
- Type
- void
setShowPageBorder(show) → {void}
- Description:
Toggles page edge rendering.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
boolean | Whether the page edge treatment should render. |
Returns:
- Type
- void
setSource(source) → {void}
- Description:
Replaces the page source, resets navigation to spread 0, warms previews, redraws, and emits
sourcechange.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
source |
PageSource | New page source. |
Returns:
- Type
- void
setViewport(viewport) → {void}
- Description:
Sets the element used for zoom measurement and scroll preservation.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewport |
HTMLElement | null | Viewport element. |
Returns:
- Type
- void