Viewer Instance Reference

Jump by category

Lifecycle

• destroy
• getPreviewActive
• load
• mount
• setPreviewActive
• setStatus
• unload

Navigation and Zoom

• getZoom
• goToPage
• jumpToRect
• nextPage
• prevPage
• setZoom
• zoomIn
• zoomOut

View and Search State

• createRedactionsBySearch
• getSearchQuery
• getSearchResultCount
• getSearchResultIndex
• nextSearchResult
• prevSearchResult
• search
• setSearchQuery
• setSearchState
• setUI
• setViewState
• startUISearch

Annotations and Selection

• applyRedactions
• calculateFittingTextAnnotationBoundingBox
• createHighlightFromSelection
• createLinkFromSelection
• createNoteFromSelection
• createSquigglyFromSelection
• createStrikeoutFromSelection
• createUnderlineFromSelection
• deleteAnnotationsGroup
• getAnnotationCreatorName
• getAnnotationMode
• getAnnotations
• getAnnotationsGroups
• getAnnotationToolbarItems
• getCurrentAnnotationPreset
• getInkSignatures
• getInlineTextSelectionToolbarItems
• getMarkupAnnotationText
• getOverlappingAnnotations
• getSelectedAnnotations
• getSelection
• getSignaturesInfo
• getStoredSignatures
• getTextSelection
• groupAnnotations
• setAnnotationCreatorName
• setAnnotationMode
• setAnnotationPresets
• setAnnotationToolbarItems
• setCurrentAnnotationPreset
• setEditableAnnotationTypes
• setEditingAnnotation
• setInkSignatures
• setInlineTextSelectionToolbarItems
• setIsEditableAnnotation
• setOnAnnotationResizeStart
• setOnWidgetAnnotationCreationStart
• setSelectedAnnotations
• setSignaturesLTV
• setStampAnnotationTemplates
• setStoredSignatures

Export and Document Operations

• createAttachment
• download
• exportInstantJSON
• exportOffice
• exportPDF
• exportPDFWithOperations
• exportXFDF
• getAttachment
• getBookmarks
• getDocumentEditorFooterItems
• getDocumentEditorToolbarItems
• getDocumentOutline
• getDocumentPermissions
• getFormFields
• getFormFieldValues
• getLayersVisibilityState
• print
• save
• setDocumentEditorFooterItems
• setDocumentEditorToolbarItems
• setDocumentOutline
• setFormFieldValues
• setLayersVisibilityState
• signDocument

Geometry and Text

• getTextFromRects
• pageInfoForIndex
• renderPageAsArrayBuffer
• renderPageAsImageURL
• transformClientToPageSpace
• transformContentClientToPageSpace
• transformContentPageToClientSpace
• transformPageToClientSpace
• transformPageToRawSpace
• transformRawToPageSpace

Event APIs

• addEventListener
• off
• on
• removeEventListener

Miscellaneous

• abortPrint
• applyOperations
• beginContentEditingSession
• create
• delete
• ensureChangesSaved
• getComments
• getEmbeddedFiles
• getPageTabOrder
• hasUnsavedChanges
• importInstantJSON
• removeCustomOverlayItem
• renderThumbnails
• resetGroup
• setCustomOverlayItem
• setCustomRenderers
• setCustomUIConfiguration
• setGroup
• setIsEditableComment
• setLocale
• setMaxMentionSuggestions
• setMeasurementPrecision
• setMeasurementScale
• setMeasurementSnapping
• setMeasurementValueConfiguration
• setMentionableUsers
• setOnCommentCreationStart
• setPageTabOrder
• setToolbarItems
• textLinesForPageIndex
• toggleClipboardActions
• update

Lifecycle

destroy

Signature

destroy(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

getPreviewActive

Signature

getPreviewActive(): boolean

Parameters

Param	Type	Required
None	-	-

Returns

• boolean

load

Signature

load(source: ViewerDocumentSource): Promise<void>

Parameters

Param	Type	Required
source	ViewerDocumentSource	Yes

Returns

• Promise<void>

mount

Signature

mount(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

setPreviewActive

Signature

setPreviewActive(active: boolean): void

Parameters

Param	Type	Required
active	boolean	Yes

Returns

• void

setStatus

Signature

setStatus(status: string): void

Parameters

Param	Type	Required
status	string	Yes

Returns

• void

unload

Signature

unload(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

Navigation and Zoom

getZoom

Signature

getZoom(): number

Parameters

Param	Type	Required
None	-	-

Returns

• number

goToPage

Signature

goToPage(pageNumber: number): void

Parameters

Param	Type	Required
pageNumber	number	Yes

Returns

• void

jumpToRect

Signature

jumpToRect(pageIndex: number, rect: | Rect | { left: number; top: number; width: number; height: number }): void

Parameters

Param	Type	Required
pageIndex	number	Yes
rect	| Rect | { left: number; top: number; width: number; height: number }	Yes

Returns

• void

nextPage

Signature

nextPage(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

prevPage

Signature

prevPage(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

setZoom

Signature

setZoom(zoom: number): void

Parameters

Param	Type	Required
zoom	number	Yes

Returns

• void

zoomIn

Signature

zoomIn(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

zoomOut

Signature

zoomOut(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

View and Search State

createRedactionsBySearch

Signature

createRedactionsBySearch(term: string, options?: { annotationPreset?: RedactionAnnotationPreset; caseSensitive?: boolean; pageRange?: number; searchInAnnotations?: boolean; searchType?: 'text' | 'preset' | 'regex'; startPageIndex?: number; }): Promise<ImmutableList<string>>

Parameters

Param	Type	Required
term	string	Yes
options	{ annotationPreset?: RedactionAnnotationPreset; caseSensitive?: boolean; pageRange?: number; searchInAnnotations?: boolean; searchType?: 'text' | 'preset' | 'regex'; startPageIndex?: number; }	No

Returns

• Promise<ImmutableList<string>>

getSearchQuery

Signature

getSearchQuery(): string

Parameters

Param	Type	Required
None	-	-

Returns

• string

getSearchResultCount

Signature

getSearchResultCount(): number

Parameters

Param	Type	Required
None	-	-

Returns

• number

getSearchResultIndex

Signature

getSearchResultIndex(): number | null

Parameters

Param	Type	Required
None	-	-

Returns

• number | null

nextSearchResult

Signature

nextSearchResult(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

prevSearchResult

Signature

prevSearchResult(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

search

Signature

search(term: string, options?: SearchOptions): Promise<ImmutableList<SearchResult>>

Parameters

Param	Type	Required
term	string	Yes
options	SearchOptions	No

Returns

• Promise<ImmutableList<SearchResult>>

setSearchQuery

Signature

setSearchQuery(query: string): void

Parameters

Param	Type	Required
query	string	Yes

Returns

• void

setSearchState

Signature

setSearchState(updater: SearchStateUpdate): void

Parameters

Param	Type	Required
updater	SearchStateUpdate	Yes

Returns

• void

setUI

Signature

setUI(ui: Partial<ViewStateData>): void

Parameters

Param	Type	Required
ui	Partial<ViewStateData>	Yes

Returns

• void

setViewState

Signature

setViewState(updater: ViewStateUpdate): void

Parameters

Param	Type	Required
updater	ViewStateUpdate	Yes

Returns

• void

startUISearch

Signature

startUISearch(term?: string): void

Parameters

Param	Type	Required
term	string	No

Returns

• void

Annotations and Selection

applyRedactions

Signature

applyRedactions(): Promise<void>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<void>

calculateFittingTextAnnotationBoundingBox

Signature

calculateFittingTextAnnotationBoundingBox(text: string, options?: { fontSize?: number; minWidth?: number; maxWidth?: number }): { left: number; top: number; width: number; height: number }

Parameters

Param	Type	Required
text	string	Yes
options	{ fontSize?: number; minWidth?: number; maxWidth?: number }	No

Returns

• { left: number; top: number; width: number; height: number }

createHighlightFromSelection

Signature

createHighlightFromSelection(): PdfAnnotation | null

Parameters

Param	Type	Required
None	-	-

Returns

• PdfAnnotation | null

createLinkFromSelection

Signature

createLinkFromSelection(url: string): PdfAnnotation | null

Parameters

Param	Type	Required
url	string	Yes

Returns

• PdfAnnotation | null

createNoteFromSelection

Signature

createNoteFromSelection(contents?: string): PdfAnnotation | null

Parameters

Param	Type	Required
contents	string	No

Returns

• PdfAnnotation | null

createSquigglyFromSelection

Signature

createSquigglyFromSelection(): PdfAnnotation | null

Parameters

Param	Type	Required
None	-	-

Returns

• PdfAnnotation | null

createStrikeoutFromSelection

Signature

createStrikeoutFromSelection(): PdfAnnotation | null

Parameters

Param	Type	Required
None	-	-

Returns

• PdfAnnotation | null

createUnderlineFromSelection

Signature

createUnderlineFromSelection(): PdfAnnotation | null

Parameters

Param	Type	Required
None	-	-

Returns

• PdfAnnotation | null

deleteAnnotationsGroup

Signature

deleteAnnotationsGroup(group: string): Promise<void>

Parameters

Param	Type	Required
group	string	Yes

Returns

• Promise<void>

getAnnotationCreatorName

Signature

getAnnotationCreatorName(): string | null

Parameters

Param	Type	Required
None	-	-

Returns

• string | null

getAnnotationMode

Signature

getAnnotationMode(): PdfAnnotationMode

Parameters

Param	Type	Required
None	-	-

Returns

• PdfAnnotationMode

getAnnotations

Signature

getAnnotations(pageIndex?: number): Promise<ImmutableList<Annotation>>

Parameters

Param	Type	Required
pageIndex	number	No

Returns

• Promise<ImmutableList<Annotation>>

getAnnotationsGroups

Signature

getAnnotationsGroups(): Promise<Record<string, string[]>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<Record<string, string[]>>

getAnnotationToolbarItems

Signature

getAnnotationToolbarItems(): ToolbarItem[]

Parameters

Param	Type	Required
None	-	-

Returns

• ToolbarItem[]

getCurrentAnnotationPreset

Signature

getCurrentAnnotationPreset(): AnnotationPreset | null

Parameters

Param	Type	Required
None	-	-

Returns

• AnnotationPreset | null

getInkSignatures

Signature

getInkSignatures(): Promise<ImmutableList<StoredSignature>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ImmutableList<StoredSignature>>

getInlineTextSelectionToolbarItems

Signature

getInlineTextSelectionToolbarItems(): ToolbarItem[]

Parameters

Param	Type	Required
None	-	-

Returns

• ToolbarItem[]

getMarkupAnnotationText

Signature

getMarkupAnnotationText(annotation: string | Annotation): Promise<string>

Parameters

Param	Type	Required
annotation	string | Annotation	Yes

Returns

• Promise<string>

getOverlappingAnnotations

Signature

getOverlappingAnnotations(annotation: string | Annotation): Promise<ImmutableList<Annotation>>

Parameters

Param	Type	Required
annotation	string | Annotation	Yes

Returns

• Promise<ImmutableList<Annotation>>

getSelectedAnnotations

Signature

getSelectedAnnotations(): ImmutableList<Annotation>

Parameters

Param	Type	Required
None	-	-

Returns

• ImmutableList<Annotation>

getSelection

Signature

getSelection(): PdfSelection | null

Parameters

Param	Type	Required
None	-	-

Returns

• PdfSelection | null

getSignaturesInfo

Signature

getSignaturesInfo(): Promise<Array<Record<string, unknown>>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<Array<Record<string, unknown>>>

getStoredSignatures

Signature

getStoredSignatures(): Promise<ImmutableList<StoredSignature>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ImmutableList<StoredSignature>>

getTextSelection

Signature

getTextSelection(): TextSelection | null

Parameters

Param	Type	Required
None	-	-

Returns

• TextSelection | null

groupAnnotations

Signature

groupAnnotations(annotations: string[] | ImmutableList<Annotation> | Annotation[]): Promise<string | null>

Parameters

Param	Type	Required
annotations	string[] | ImmutableList<Annotation> | Annotation[]	Yes

Returns

• Promise<string | null>

setAnnotationCreatorName

Signature

setAnnotationCreatorName(name: string | null): void

Parameters

Param	Type	Required
name	string | null	Yes

Returns

• void

setAnnotationMode

Signature

setAnnotationMode(mode: PdfAnnotationMode): void

Parameters

Param	Type	Required
mode	PdfAnnotationMode	Yes

Returns

• void

setAnnotationPresets

Signature

setAnnotationPresets(update: AnnotationPresetUpdate): void

Parameters

Param	Type	Required
update	AnnotationPresetUpdate	Yes

Returns

• void

setAnnotationToolbarItems

Signature

setAnnotationToolbarItems(items: ToolbarItem[]): void

Parameters

Param	Type	Required
items	ToolbarItem[]	Yes

Returns

• void

setCurrentAnnotationPreset

Signature

setCurrentAnnotationPreset(preset: AnnotationPreset | null): void

Parameters

Param	Type	Required
preset	AnnotationPreset | null	Yes

Returns

• void

setEditableAnnotationTypes

Signature

setEditableAnnotationTypes(types: string[] | null): void

Parameters

Param	Type	Required
types	string[] | null	Yes

Returns

• void

setEditingAnnotation

Signature

setEditingAnnotation(annotation: string | Annotation | null): void

Parameters

Param	Type	Required
annotation	string | Annotation | null	Yes

Returns

• void

setInkSignatures

Signature

setInkSignatures(state: | ImmutableList<StoredSignature> | ((current: ImmutableList<StoredSignature>) => ImmutableList<StoredSignature>)): Promise<void>

Parameters

Param	Type	Required
state	| ImmutableList<StoredSignature> | ((current: ImmutableList<StoredSignature>) => ImmutableList<StoredSignature>)	Yes

Returns

• Promise<void>

setInlineTextSelectionToolbarItems

Signature

setInlineTextSelectionToolbarItems(items: ToolbarItem[]): void

Parameters

Param	Type	Required
items	ToolbarItem[]	Yes

Returns

• void

setIsEditableAnnotation

Signature

setIsEditableAnnotation(predicate: ((annotation: Annotation) => boolean) | null): void

Parameters

Param	Type	Required
predicate	((annotation: Annotation) => boolean) | null	Yes

Returns

• void

setOnAnnotationResizeStart

Signature

setOnAnnotationResizeStart(handler: ((payload: unknown) => void) | null): void

Parameters

Param	Type	Required
handler	((payload: unknown) => void) | null	Yes

Returns

• void

setOnWidgetAnnotationCreationStart

Signature

setOnWidgetAnnotationCreationStart(handler: ((payload: unknown) => void) | null): void

Parameters

Param	Type	Required
handler	((payload: unknown) => void) | null	Yes

Returns

• void

setSelectedAnnotations

Signature

setSelectedAnnotations(annotations?: | string | string[] | Annotation | ImmutableList<Annotation | string> | Annotation[] | null): Promise<void>

Parameters

Param	Type	Required
annotations	| string | string[] | Annotation | ImmutableList<Annotation | string> | Annotation[] | null	No

Returns

• Promise<void>

setSignaturesLTV

Signature

setSignaturesLTV(options: Record<string, unknown>): Promise<void>

Parameters

Param	Type	Required
options	Record<string, unknown>	Yes

Returns

• Promise<void>

setStampAnnotationTemplates

Signature

setStampAnnotationTemplates(templates: unknown[]): void

Parameters

Param	Type	Required
templates	unknown[]	Yes

Returns

• void

setStoredSignatures

Signature

setStoredSignatures(state: | ImmutableList<StoredSignature> | ((current: ImmutableList<StoredSignature>) => ImmutableList<StoredSignature>)): Promise<void>

Parameters

Param	Type	Required
state	| ImmutableList<StoredSignature> | ((current: ImmutableList<StoredSignature>) => ImmutableList<StoredSignature>)	Yes

Returns

• Promise<void>

Export and Document Operations

createAttachment

Signature

createAttachment(blob: Blob, options?: ViewerAttachmentCreateOptions): Promise<ViewerAttachment>

Parameters

Param	Type	Required
blob	Blob	Yes
options	ViewerAttachmentCreateOptions	No

Returns

• Promise<ViewerAttachment>

download

Signature

download(): Promise<void>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<void>

exportInstantJSON

Signature

exportInstantJSON(version?: number): Promise<InstantJSON>

Parameters

Param	Type	Required
version	number	No

Returns

• Promise<InstantJSON>

exportOffice

Signature

exportOffice(): Promise<ArrayBuffer>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ArrayBuffer>

exportPDF

Signature

exportPDF(flags?: ExportPDFFlags): Promise<ArrayBuffer>

Parameters

Param	Type	Required
flags	ExportPDFFlags	No

Returns

• Promise<ArrayBuffer>

exportPDFWithOperations

Signature

exportPDFWithOperations(operations: DocumentOperationsUnion[]): Promise<ArrayBuffer>

Parameters

Param	Type	Required
operations	DocumentOperationsUnion[]	Yes

Returns

• Promise<ArrayBuffer>

exportXFDF

Signature

exportXFDF(ignorePageRotation?: boolean): Promise<string>

Parameters

Param	Type	Required
ignorePageRotation	boolean	No

Returns

• Promise<string>

getAttachment

Signature

getAttachment(id: string): Promise<ViewerAttachment | null>

Parameters

Param	Type	Required
id	string	Yes

Returns

• Promise<ViewerAttachment | null>

getBookmarks

Signature

getBookmarks(): Promise<ImmutableList<Bookmark>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ImmutableList<Bookmark>>

getDocumentEditorFooterItems

Signature

getDocumentEditorFooterItems(): ToolbarItem[]

Parameters

Param	Type	Required
None	-	-

Returns

• ToolbarItem[]

getDocumentEditorToolbarItems

Signature

getDocumentEditorToolbarItems(): ToolbarItem[]

Parameters

Param	Type	Required
None	-	-

Returns

• ToolbarItem[]

getDocumentOutline

Signature

getDocumentOutline(): Promise<ImmutableList<OutlineElement>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ImmutableList<OutlineElement>>

getDocumentPermissions

Signature

getDocumentPermissions(): Promise<Record<string, boolean>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<Record<string, boolean>>

getFormFields

Signature

getFormFields(): Promise<ImmutableList<FormField>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ImmutableList<FormField>>

getFormFieldValues

Signature

getFormFieldValues(): FormFieldValueMap

Parameters

Param	Type	Required
None	-	-

Returns

• FormFieldValueMap

getLayersVisibilityState

Signature

getLayersVisibilityState(): Promise<LayerVisibilityState>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<LayerVisibilityState>

print

Signature

print(options?: { title?: string }): Promise<void>

Parameters

Param	Type	Required
options	{ title?: string }	No

Returns

• Promise<void>

save

Signature

save(flags?: ExportPDFFlags): Promise<ArrayBuffer>

Parameters

Param	Type	Required
flags	ExportPDFFlags	No

Returns

• Promise<ArrayBuffer>

setDocumentEditorFooterItems

Signature

setDocumentEditorFooterItems(items: ToolbarItem[]): void

Parameters

Param	Type	Required
items	ToolbarItem[]	Yes

Returns

• void

setDocumentEditorToolbarItems

Signature

setDocumentEditorToolbarItems(items: ToolbarItem[]): void

Parameters

Param	Type	Required
items	ToolbarItem[]	Yes

Returns

• void

setDocumentOutline

Signature

setDocumentOutline(outline: ImmutableList<OutlineElement> | OutlineElement[]): Promise<void>

Parameters

Param	Type	Required
outline	ImmutableList<OutlineElement> | OutlineElement[]	Yes

Returns

• Promise<void>

setFormFieldValues

Signature

setFormFieldValues(formFieldValues: FormFieldValueMap): Promise<void>

Parameters

Param	Type	Required
formFieldValues	FormFieldValueMap	Yes

Returns

• Promise<void>

setLayersVisibilityState

Signature

setLayersVisibilityState(state: LayerVisibilityState): Promise<void>

Parameters

Param	Type	Required
state	LayerVisibilityState	Yes

Returns

• Promise<void>

signDocument

Signature

signDocument(options?: Record<string, unknown>): Promise<{ signed: boolean; method: string }>

Parameters

Param	Type	Required
options	Record<string, unknown>	No

Returns

• Promise<{ signed: boolean; method: string }>

Geometry and Text

getTextFromRects

Signature

getTextFromRects(pageIndex: number, rects: | ImmutableList<Rect> | Array< | Rect | { left: number; top: number; width: number; height: number } > | ArrayLike< | Rect | { left: number; top: number; width: number; height: number } >): Promise<string>

Parameters

Param	Type	Required
pageIndex	number	Yes
rects	| ImmutableList<Rect> | Array< | Rect | { left: number; top: number; width: number; height: number } > | ArrayLike< | Rect | { left: number; top: number; width: number; height: number } >	Yes

Returns

• Promise<string>

pageInfoForIndex

Signature

pageInfoForIndex(pageIndex: number): PageInfo | null

Parameters

Param	Type	Required
pageIndex	number	Yes

Returns

• PageInfo | null

renderPageAsArrayBuffer

Signature

renderPageAsArrayBuffer(pageIndex: number): Promise<ArrayBuffer>

Parameters

Param	Type	Required
pageIndex	number	Yes

Returns

• Promise<ArrayBuffer>

renderPageAsImageURL

Signature

renderPageAsImageURL(pageIndex: number): Promise<string>

Parameters

Param	Type	Required
pageIndex	number	Yes

Returns

• Promise<string>

transformClientToPageSpace

Signature

transformClientToPageSpace(pageIndex: number, point: ViewerPoint): ViewerPoint | null

Parameters

Param	Type	Required
pageIndex	number	Yes
point	ViewerPoint	Yes

Returns

• ViewerPoint | null

transformContentClientToPageSpace

Signature

transformContentClientToPageSpace(pageIndex: number, point: ViewerPoint): ViewerPoint | null

Parameters

Param	Type	Required
pageIndex	number	Yes
point	ViewerPoint	Yes

Returns

• ViewerPoint | null

transformContentPageToClientSpace

Signature

transformContentPageToClientSpace(pageIndex: number, point: ViewerPoint): ViewerPoint | null

Parameters

Param	Type	Required
pageIndex	number	Yes
point	ViewerPoint	Yes

Returns

• ViewerPoint | null

transformPageToClientSpace

Signature

transformPageToClientSpace(pageIndex: number, point: ViewerPoint): ViewerPoint | null

Parameters

Param	Type	Required
pageIndex	number	Yes
point	ViewerPoint	Yes

Returns

• ViewerPoint | null

transformPageToRawSpace

Signature

transformPageToRawSpace(pageIndex: number, point: ViewerPoint): ViewerPoint

Parameters

Param	Type	Required
pageIndex	number	Yes
point	ViewerPoint	Yes

Returns

• ViewerPoint

transformRawToPageSpace

Signature

transformRawToPageSpace(pageIndex: number, point: ViewerPoint): ViewerPoint

Parameters

Param	Type	Required
pageIndex	number	Yes
point	ViewerPoint	Yes

Returns

• ViewerPoint

Event APIs

addEventListener

Signature

addEventListener(event: EventName, handler: (...payload: ViewerEventMap[EventName]) => void): void

Parameters

Param	Type	Required
event	EventName	Yes
handler	(...payload: ViewerEventMap[EventName]) => void	Yes

Returns

• void

off

Signature

off(event: EventName, handler: (payload: PapyriumEventMap[EventName]) => void): void

Parameters

Param	Type	Required
event	EventName	Yes
handler	(payload: PapyriumEventMap[EventName]) => void	Yes

Returns

• void

on

Signature

on(event: EventName, handler: (payload: PapyriumEventMap[EventName]) => void): void

Parameters

Param	Type	Required
event	EventName	Yes
handler	(payload: PapyriumEventMap[EventName]) => void	Yes

Returns

• void

removeEventListener

Signature

removeEventListener(event: EventName, handler: (...payload: ViewerEventMap[EventName]) => void): void

Parameters

Param	Type	Required
event	EventName	Yes
handler	(...payload: ViewerEventMap[EventName]) => void	Yes

Returns

• void

Miscellaneous

abortPrint

Signature

abortPrint(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

applyOperations

Signature

applyOperations(operations: DocumentOperationsUnion[]): Promise<unknown[]>

Parameters

Param	Type	Required
operations	DocumentOperationsUnion[]	Yes

Returns

• Promise<unknown[]>

beginContentEditingSession

Signature

beginContentEditingSession(): Promise<ContentEditingSession>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ContentEditingSession>

create

Signature

create(annotations: Annotation | Annotation[] | ImmutableList<Annotation>): Promise<ImmutableList<Annotation> | ViewerError[]>

Parameters

Param	Type	Required
annotations	Annotation | Annotation[] | ImmutableList<Annotation>	Yes

Returns

• Promise<ImmutableList<Annotation> | ViewerError[]>

delete

Signature

delete(annotations: string | string[] | Annotation | Annotation[] | ImmutableList<Annotation>): Promise<string[] | ViewerError[]>

Parameters

Param	Type	Required
annotations	string | string[] | Annotation | Annotation[] | ImmutableList<Annotation>	Yes

Returns

• Promise<string[] | ViewerError[]>

ensureChangesSaved

Signature

ensureChangesSaved(): Promise<void>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<void>

getComments

Signature

getComments(): Promise<ImmutableList<Annotation>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ImmutableList<Annotation>>

getEmbeddedFiles

Signature

getEmbeddedFiles(): Promise<ImmutableList<ViewerAttachment>>

Parameters

Param	Type	Required
None	-	-

Returns

• Promise<ImmutableList<ViewerAttachment>>

getPageTabOrder

Signature

getPageTabOrder(pageIndex: number): Promise<string[]>

Parameters

Param	Type	Required
pageIndex	number	Yes

Returns

• Promise<string[]>

hasUnsavedChanges

Signature

hasUnsavedChanges(): boolean

Parameters

Param	Type	Required
None	-	-

Returns

• boolean

importInstantJSON

Signature

importInstantJSON(payload: InstantJSON): Promise<void>

Parameters

Param	Type	Required
payload	InstantJSON	Yes

Returns

• Promise<void>

removeCustomOverlayItem

Signature

removeCustomOverlayItem(id: string): void

Parameters

Param	Type	Required
id	string	Yes

Returns

• void

renderThumbnails

Signature

renderThumbnails(options: PdfThumbnailOptions): Promise<Record<number, string>>

Parameters

Param	Type	Required
options	PdfThumbnailOptions	Yes

Returns

• Promise<Record<number, string>>

resetGroup

Signature

resetGroup(group: string): Promise<void>

Parameters

Param	Type	Required
group	string	Yes

Returns

• Promise<void>

setCustomOverlayItem

Signature

setCustomOverlayItem(id: string, item: unknown): void

Parameters

Param	Type	Required
id	string	Yes
item	unknown	Yes

Returns

• void

setCustomRenderers

Signature

setCustomRenderers(renderers: Record<string, unknown>): void

Parameters

Param	Type	Required
renderers	Record<string, unknown>	Yes

Returns

• void

setCustomUIConfiguration

Signature

setCustomUIConfiguration(configuration: Record<string, unknown>): void

Parameters

Param	Type	Required
configuration	Record<string, unknown>	Yes

Returns

• void

setGroup

Signature

setGroup(annotations: string[] | ImmutableList<Annotation> | Annotation[], group: string | null): Promise<void>

Parameters

Param	Type	Required
annotations	string[] | ImmutableList<Annotation> | Annotation[]	Yes
group	string | null	Yes

Returns

• Promise<void>

setIsEditableComment

Signature

setIsEditableComment(predicate: ((comment: unknown) => boolean) | null): void

Parameters

Param	Type	Required
predicate	((comment: unknown) => boolean) | null	Yes

Returns

• void

setLocale

Signature

setLocale(locale: string): Promise<void> | void

Parameters

Param	Type	Required
locale	string	Yes

Returns

• Promise<void> | void

setMaxMentionSuggestions

Signature

setMaxMentionSuggestions(count: number): void

Parameters

Param	Type	Required
count	number	Yes

Returns

• void

setMeasurementPrecision

Signature

setMeasurementPrecision(value: unknown): void

Parameters

Param	Type	Required
value	unknown	Yes

Returns

• void

setMeasurementScale

Signature

setMeasurementScale(value: unknown): void

Parameters

Param	Type	Required
value	unknown	Yes

Returns

• void

setMeasurementSnapping

Signature

setMeasurementSnapping(value: unknown): void

Parameters

Param	Type	Required
value	unknown	Yes

Returns

• void

setMeasurementValueConfiguration

Signature

setMeasurementValueConfiguration(value: unknown): void

Parameters

Param	Type	Required
value	unknown	Yes

Returns

• void

setMentionableUsers

Signature

setMentionableUsers(users: unknown[]): void

Parameters

Param	Type	Required
users	unknown[]	Yes

Returns

• void

setOnCommentCreationStart

Signature

setOnCommentCreationStart(handler: ((payload: unknown) => void) | null): void

Parameters

Param	Type	Required
handler	((payload: unknown) => void) | null	Yes

Returns

• void

setPageTabOrder

Signature

setPageTabOrder(pageIndex: number, tabOrder: string[]): Promise<void>

Parameters

Param	Type	Required
pageIndex	number	Yes
tabOrder	string[]	Yes

Returns

• Promise<void>

setToolbarItems

Signature

setToolbarItems(items: ToolbarItem[]): void

Parameters

Param	Type	Required
items	ToolbarItem[]	Yes

Returns

• void

textLinesForPageIndex

Signature

textLinesForPageIndex(pageIndex: number): Promise<ImmutableList<TextLine>>

Parameters

Param	Type	Required
pageIndex	number	Yes

Returns

• Promise<ImmutableList<TextLine>>

toggleClipboardActions

Signature

toggleClipboardActions(): void

Parameters

Param	Type	Required
None	-	-

Returns

• void

update

Signature

update(annotations: Annotation | Annotation[] | ImmutableList<Annotation>): Promise<ImmutableList<Annotation> | ViewerError[]>

Parameters

Param	Type	Required
annotations	Annotation | Annotation[] | ImmutableList<Annotation>	Yes

Returns

• Promise<ImmutableList<Annotation> | ViewerError[]>