Class GigaPdfViewer

Hierarchy (View Summary)

GigaPdfViewer
- GigaPdfEditor

Index

Constructors

Properties

doc count current cssScale renderScale fitMode urls sizes root pages pageEls engine

Accessors

pageCount currentPage zoom

Constructors

constructor

new GigaPdfViewer(
    engine: GigaPdfEngine,
    container: HTMLElement,
    options?: ViewerOptions,
): GigaPdfViewer
Parameters
- engine: GigaPdfEngine
- container: HTMLElement
- options: ViewerOptions = {}
Returns GigaPdfViewer
- Defined in viewer.ts:110

Properties

`Protected`doc

doc: GigaPdfDoc | null = null

`Protected`count

count: number = 0

`Protected`current

current: number = 1

`Protected`cssScale

cssScale: number

`Protected`renderScale

renderScale: number

`Protected`fitMode

fitMode: "page" | "none" | "width" = "none"

Active auto-fit mode; re-applied on resize and page change.

`Protected`urls

urls: (string | null)[] = []

`Protected`sizes

sizes: ({ w: number; h: number } | null)[] = []

`Protected`root

root: HTMLElement

`Protected`pages

pages: HTMLElement

`Protected`pageEls

pageEls: (HTMLElement | null)[] = []

`Protected`engine

engine: GigaPdfEngine

Accessors

pageCount

get pageCount(): number
Number of pages currently open.

Returns number
- Defined in viewer.ts:127

currentPage

get currentPage(): number
The page currently in view (1-based).

Returns number
- Defined in viewer.ts:131

zoom

get zoom(): number
Current CSS zoom multiplier (1 = 100%).

Returns number
- Defined in viewer.ts:300

Methods

orientation

orientation(page: number): Orientation
Orientation of page (after open).
Parameters
- page: number
Returns Orientation
- Defined in viewer.ts:135

save

save(): Uint8Array
The current document as PDF bytes (including any applied edits).

Returns Uint8Array
- Defined in viewer.ts:141

open

open(src: ViewerSource): Promise<number>
Open a document; Office/HTML are converted to PDF in-engine. Returns the page count.
Parameters
- src: ViewerSource
Returns Promise<number>
- Defined in viewer.ts:147

`Protected`renderPageRaster

renderPageRaster(page: number): { url: string; w: number; h: number }
Parameters
- page: number
Returns { url: string; w: number; h: number }
- Defined in viewer.ts:186

`Protected`pageWidthPt

pageWidthPt(page: number): number
The page's width / height in PDF points (raster pixels ÷ render scale).
Parameters
- page: number
Returns number
- Defined in viewer.ts:203

`Protected`pageHeightPt

pageHeightPt(page: number): number
Parameters
- page: number
Returns number
- Defined in viewer.ts:207

`Protected`reRenderPage

reRenderPage(page: number): void
Re-raster a page after its content changed (drops the cached image).
Parameters
- page: number
Returns void
- Defined in viewer.ts:213

`Protected`afterRender

afterRender(): void
Hook for subclasses (the editor) to attach per-page overlays.

Returns void
- Defined in viewer.ts:227

goTo

goTo(page: number): void
Scroll/jump to page (clamped to range).
Parameters
- page: number
Returns void
- Defined in viewer.ts:275

next

next(): void
Returns void
- Defined in viewer.ts:291

prev

prev(): void
Returns void
- Defined in viewer.ts:294

setZoom

setZoom(scale: number): void
Set an explicit zoom multiplier (cancels any auto-fit mode).
Parameters
- scale: number
Returns void
- Defined in viewer.ts:317

setZoomPercent

setZoomPercent(pct: number): void
Set zoom as a percentage (e.g. 125).
Parameters
- pct: number
Returns void
- Defined in viewer.ts:322

actualSize

actualSize(): void
Reset to 100 % (actual size).

Returns void
- Defined in viewer.ts:326

zoomIn

zoomIn(): void
Returns void
- Defined in viewer.ts:329

zoomOut

zoomOut(): void
Returns void
- Defined in viewer.ts:332

fitWidth

fitWidth(): void
Fit the current page's width to the viewport (sticks across resizes).

Returns void
- Defined in viewer.ts:336

fitPage

fitPage(): void
Fit the whole current page (width and height) to the viewport.

Returns void
- Defined in viewer.ts:341

`Protected`applyFitMode

applyFitMode(): void
Recompute the zoom for the active fit mode against the current page.

Returns void
- Defined in viewer.ts:346

`Protected`onZoomChange

onZoomChange(): void
Hook for subclasses (the editor) to react to zoom changes.

Returns void
- Defined in viewer.ts:362

present

present(): void
Enter fullscreen single-page presentation mode.

Returns void
- Defined in viewer.ts:376

exitPresent

exitPresent(): void
Leave presentation mode.

Returns void
- Defined in viewer.ts:383

close

close(): void
Close the current document and free its rendered pages.

Returns void
- Defined in viewer.ts:558

destroy

destroy(): void
Destroy the viewer: close the document and detach listeners.

Returns void
- Defined in viewer.ts:571