ViewerController
Framework-neutral viewer logic: generation, navigation, zoom, export and print. The React and Vue viewers are thin views over this controller.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ViewerController(options?): ViewerController;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
ViewerControllerOptions |
Returns
Section titled “Returns”ViewerController
Methods
Section titled “Methods”downloadExcel()
Section titled “downloadExcel()”downloadExcel(fileName?): Promise<void>;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
fileName? |
string |
Returns
Section titled “Returns”Promise<void>
downloadPdf()
Section titled “downloadPdf()”downloadPdf(fileName?): Promise<void>;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
fileName? |
string |
Returns
Section titled “Returns”Promise<void>
exportExcel()
Section titled “exportExcel()”exportExcel(options?): Promise<Uint8Array<ArrayBufferLike>>;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
ExcelExportOptions |
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
exportPdf()
Section titled “exportPdf()”exportPdf(options?): Promise<Uint8Array<ArrayBufferLike>>;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
PdfExportOptions |
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
firstPage()
Section titled “firstPage()”firstPage(): void;Returns
Section titled “Returns”void
getState()
Section titled “getState()”getState(): ViewerState;Returns
Section titled “Returns”goToPage()
Section titled “goToPage()”goToPage(index): void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
index |
number |
Returns
Section titled “Returns”void
lastPage()
Section titled “lastPage()”lastPage(): void;Returns
Section titled “Returns”void
load()
Section titled “load()”load( template, data, options?): LayoutDocument | null;Generates the report. Errors are stored in state.error, never thrown.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
template |
string | ReportTemplate |
data |
unknown |
options? |
ViewerControllerOptions |
Returns
Section titled “Returns”LayoutDocument | null
nextPage()
Section titled “nextPage()”nextPage(): void;Returns
Section titled “Returns”void
previousPage()
Section titled “previousPage()”previousPage(): void;Returns
Section titled “Returns”void
print()
Section titled “print()”print(): Promise<void>;Prints every page through a hidden iframe. Browser only.
Returns
Section titled “Returns”Promise<void>
regenerate()
Section titled “regenerate()”regenerate(): LayoutDocument | null;Regenerates from the last loaded template and data (e.g. after changing params).
Returns
Section titled “Returns”LayoutDocument | null
setContainerSize()
Section titled “setContainerSize()”setContainerSize(width, height): void;Call when the viewer’s scroll container is resized; fit modes recompute the zoom.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
width |
number |
height |
number |
Returns
Section titled “Returns”void
setOptions()
Section titled “setOptions()”setOptions(options): void;Updates generate/export options without regenerating.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
ViewerControllerOptions |
Returns
Section titled “Returns”void
setZoom()
Section titled “setZoom()”setZoom(zoom): void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
zoom |
number |
Returns
Section titled “Returns”void
setZoomMode()
Section titled “setZoomMode()”setZoomMode(mode): void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
mode |
ZoomMode |
Returns
Section titled “Returns”void
show()
Section titled “show()”show(document): void;Shows an already generated layout document.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
document |
LayoutDocument |
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(listener): () => void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
listener |
Listener |
Returns
Section titled “Returns”() => void
zoomIn()
Section titled “zoomIn()”zoomIn(): void;Returns
Section titled “Returns”void
zoomOut()
Section titled “zoomOut()”zoomOut(): void;Returns
Section titled “Returns”void