Class ReaderControl
Extends
BaseReaderControl.
Represents the full-featured ReaderControl reusable UI component that extends DocumentViewer.
Constructor Attributes | Constructor Name and Description |
---|---|
ReaderControl(options)
Creates a new instance of ReaderControl
|
- Methods borrowed from class WebViewerInterface:
- fitHeight, fitPage, fitWidth, fitZoom, getCurrentPageNumber, getFitMode, getLayoutMode, getPageCount, getShowSideWindow, getToolMode, getZoomLevel, goToFirstPage, goToLastPage, goToNextPage, goToPrevPage, loadDocument, rotateClockwise, rotateCounterClockwise, searchText, setCurrentPageNumber, setFitMode, setLayoutMode, setShowSideWindow, setToolMode, setZoomLevel
Event Attributes | Event Name and Description |
---|---|
A global DOM event that is triggered when a document has been loaded.
|
|
fitModeChanged(e, toolMode)
A global DOM event that is triggered when the fit mode has changed
|
|
layoutModeChanged(e, toolMode)
A global DOM event that is triggered when the display mode has changed
|
|
pageChanged(e, pageNumber)
A global DOM event that is triggered when the current page number has changed.
|
|
pageCompleted(e, pageNumber)
A global DOM event that is triggered when a page had finished rendering.
|
|
viewerLoaded(e)
A global DOM event that is triggered when the viewer has been loaded and ReaderControl is constructed.
|
|
zoomChanged(e, zoom)
A global DOM event that is triggered when the document view's zoom level has changed.
|
Class Detail
ReaderControl(options)
Creates a new instance of ReaderControl
- Parameters:
- {object} options
- Options for the reader control
- See:
- ReaderControl.html ReaderControl.js ReaderControl.css
Event Detail
documentLoaded(e)
A global DOM event that is triggered when a document has been loaded.
- Parameters:
- e
- a JavaScript event object
fitModeChanged(e, toolMode)
A global DOM event that is triggered when the fit mode has changed
- Parameters:
- e
- a JavaScript event object
- {object} toolMode
- the new fit mode
layoutModeChanged(e, toolMode)
A global DOM event that is triggered when the display mode has changed
- Parameters:
- e
- a JavaScript event object
- {object} toolMode
- the new display mode
pageChanged(e, pageNumber)
A global DOM event that is triggered when the current page number has changed.
- Parameters:
- e
- a JavaScript event object
- {integer} pageNumber
- the new 1-based page number
pageCompleted(e, pageNumber)
A global DOM event that is triggered when a page had finished rendering.
- Parameters:
- e
- a JavaScript event object
- {integer} pageNumber
- the 1-based page number that finished rendering
viewerLoaded(e)
A global DOM event that is triggered when the viewer has been loaded and ReaderControl is constructed.
- Parameters:
- e
- a JavaScript event object
zoomChanged(e, zoom)
A global DOM event that is triggered when the document view's zoom level has changed.
- Parameters:
- e
- a JavaScript event object
- {number} zoom
- the new zoom level value