Accusoft PDF Viewer Documentation

v3.11.158639

Class PdfViewerControl

Instance of the PDF Viewer

Hierarchy

PdfViewerControl

Index

Methods

Pro getAnnotations

getAnnotations(): Promise<{ annotations: Annotation[] }>

Gets the current state of the annotations loaded in the viewer. Intended to give you a way to export annotations from one viewer so that you can reload them later in a different viewer via loadAnnotations.

Note that the array of objects returned by getAnnotations are merely a copy of the annotations in the viewer. Any changes you make to these objects WILL NOT affect the actual annotations in the viewer, and any changes made by the user to the annotations in the viewer WILL NOT affect the state of the objects returned from this method. Use getAnnotations to simply get a copy of the current state of the annotations in the viewer.

rejects

with an error with a name property of "FeatureNotLicensed" if your license key does not enable annotation functionality.

Returns Promise<{ annotations: Annotation[] }>
- Promise which resolves to { annotations: Array }

Pro loadAnnotations

loadAnnotations(options: { annotations: Annotation[] }): Promise<Object>

Loads annotations into the viewer. Intended for reloading annotations previously exported by a call to getAnnotations.

Will not remove any annotations which already exist in the viewer. Can be called repeatedly to load more annotations.

rejects

with an error with a name property of "NonUniqueAnnotationIdError" if any of the items in the annotations array use an id value which is used by another annotation in either the given annotations array or by an annotation already loaded in the viewer.

rejects

with an error with a name property of "FeatureNotLicensed" if your license key does not enable annotation functionality.

Parameters
- options: { annotations: Annotation[] }
  - annotations: Annotation[]
    Every item in this array must include a unique id (which is not already in use by an annotation already loaded in the viewer) and be one of:
    
    Ellipse
    
    FreehandDrawing
    
    FreehandSignature
    
    Line
    
    Rectangle
    
    TextHighlight
    
    Every TextHighlight annotation must include a renderingMetadata array formerly exported from PdfViewerControl.getAnnotations
Returns Promise<Object>

Promise which resolves to an empty Object

off

off(eventName: EventName, listener: (data: EventData) => void): PdfViewerControl

Removes an event handler for the event named eventName.

throws

"InvalidInputError" if the event name is not one of the allowed values EventName

throws

"InvalidInputError" if the listener is not a Function.

throws

"FeatureNotLicensed" if your license key does not enable the event name.

Parameters
- eventName: EventName
  
  Name of the event. EventName
- listener: (data: EventData) => void
  
  Event handler function to be removed.
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
Returns PdfViewerControl

Control instance PdfViewerControl

on

on(eventName: EventName, listener: (data: EventData) => void): PdfViewerControl

Attaches an event handler for the event named eventName.

throws

"InvalidInputError" if the event name is not one of the allowed values EventName

throws

"InvalidInputError" if the listener is not a Function.

throws

"FeatureNotLicensed" if your license key does not enable the event name.

Parameters
- eventName: EventName
  
  Name of the event. EventName
- listener: (data: EventData) => void
  
  Function to be executed when the event is emitted.
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
Returns PdfViewerControl

Control instance PdfViewerControl

once

once(eventName: EventName, listener: (data: EventData) => void): PdfViewerControl

Attaches an event handler for the event named eventName. The event handler is removed after the first event is emitted.

throws

"InvalidInputError" if the event name is not one of the allowed values EventName

throws

"InvalidInputError" if the listener is not a Function.

throws

"FeatureNotLicensed" if your license key does not enable the event name.

Parameters
- eventName: EventName
  
  Name of the event. EventName
- listener: (data: EventData) => void
  
  Function to be executed when the event is emitted.
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
Returns PdfViewerControl

Control instance PdfViewerControl

prependListener

prependListener(eventName: EventName, listener: (data: EventData) => void): PdfViewerControl

Attaches an event handler for the event named eventName to the head of the list of handlers.

throws

"InvalidInputError" if the event name is not one of the allowed values EventName

throws

"InvalidInputError" if the listener is not a Function.

throws

"FeatureNotLicensed" if your license key does not enable the event name.

Parameters
- eventName: EventName
  
  Name of the event. EventName
- listener: (data: EventData) => void
  
  Function to be executed when the event is emitted.
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
Returns PdfViewerControl

Control instance PdfViewerControl

prependOnceListener

prependOnceListener(eventName: EventName, listener: (data: EventData) => void): PdfViewerControl

Attaches an event handler for the event named eventName to the head of the list of handlers. The event handler is removed after the first event is emitted.

throws

"InvalidInputError" if the event name is not one of the allowed values EventName

throws

"InvalidInputError" if the listener is not a Function.

throws

"FeatureNotLicensed" if your license key does not enable the event name.

Parameters
- eventName: EventName
  
  Name of the event. EventName
- listener: (data: EventData) => void
  
  Function to be executed when the event is emitted.
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
Returns PdfViewerControl

Control instance PdfViewerControl

removeAllListeners

removeAllListeners(eventName?: EventName): PdfViewerControl

Removes all event handlers for the event named eventName. If no eventName is provided, all event handlers are removed.

throws

"FeatureNotLicensed" if an event name is specified and your license key does not enable the event name.

Parameters
- Optional eventName: EventName
  
  Name of the event. EventName
Returns PdfViewerControl

Control instance PdfViewerControl

Static create

create(options: object; container: Element; licenseKey?: string; sourceDocument: string | Uint8Array | ViewingSession }): Promise<PdfViewerControl>

Creates a new PDF viewer within a page.

rejects

with an error with a name property of "ExpiredLicenseKeyError" if your license key has expired.

rejects

with an error with a name property of "InvalidLicenseKeyError" if your license key is invalid or incompatible for any reason.

Parameters
- options: object; container: Element; licenseKey?: string; sourceDocument: string | Uint8Array | ViewingSession }
  - Pro Optional allowedControls?: object
    
    Configuration for display of tools and controls in the user interface. Some controls may be hidden/shown/moved due to space or touch gesture considerations depending on the device and viewport. If undefined, uses default interface controls defined below.
    - Optional annotationList?: boolean
      
      Whether controls to view and navigate by annotations are available to the user.
      
      defaultvalue
      
      false
    - Optional ellipseTool?: boolean
      
      Whether the ellipse tool is available to the user in the toolbar, allowing them to create new ellipse annotations.
      
      defaultvalue
      
      false
    - Optional freehandDrawingTool?: boolean
      
      Whether the freehand drawing tool is available to the user in the toolbar, allowing them to create freehand drawing annotations.
      
      defaultvalue
      
      false
    - Optional freehandSignatureTool?: boolean
      
      Whether the freehand signature tool is available to the user in the toolbar, allowing them to draw their signature and place it as an annotation on the document.
      
      defaultvalue
      
      false
    - Optional fullScreenToggle?: boolean
      
      Whether the full screen toggle button is available to the user.
      
      Note that, even when true, the full screen toggle may still be hidden if the viewer is too small.
      
      defaultvalue
      
      true
    - Optional lineTool?: boolean
      
      Whether the line tool is available to the user in the toolbar, allowing them to create new line annotations.
      
      defaultvalue
      
      false
    - Optional nextAndPreviousPageButtons?: boolean
      
      Whether next and previous page navigation buttons are available to the user.
      
      defaultvalue
      
      true
    - Optional outline?: boolean
      
      Whether controls to view and navigate by document outline are available to the user.
      
      defaultvalue
      
      false
    - Optional pageNumberAndCount?: boolean
      
      Whether the current page number and total page count are displayed to the user. When displayed, the user can also tap/click on the displayed current page number to input a specific page number to change to.
      
      defaultvalue
      
      true
    - Optional printing?: boolean
      
      Whether printing controls are available to the user.
      
      Note that, even when true, printing controls are hidden when a mobile-friendly interface is shown since mobile printing is not currently supported.
      
      defaultvalue
      
      true
    - Optional rectangleTool?: boolean
      
      Whether the rectangle tool is available to the user in the toolbar, allowing them to create new rectangle annotations.
      
      defaultvalue
      
      false
    - Optional search?: boolean
      
      Whether search controls are available to the user.
      
      defaultvalue
      
      true
    - Optional textHighlightTool?: boolean
      
      Whether the text highlight tool is available to the user in the toolbar, allowing them to create text highlight annotations.
      
      defaultvalue
      
      false
    - Optional thumbnails?: boolean
      
      Whether controls to view and navigate by page thumbnails are available to the user.
      
      defaultvalue
      
      true
    - Optional zoomInAndOutButtons?: boolean
      
      Whether zoom in and zoom out buttons are available to the user.
      
      Note that, even when true, these buttons may still be hidden if the viewer is too small.
      
      Zooming is always possible via touchscreen gestures and via keyboard and mousewheel actions.
      
      defaultvalue
      
      true
  - container: Element
    
    DOM element where the viewer should be created.
  - Optional licenseKey?: string
    
    Optional. PDF Viewer license key.
    
    When not provided, the viewer will be limited to free features and will include "Powered by Accusoft" branding.
    
    When the value "eval" is provided, the viewer will be created in Evaluation Mode, which will allow paid features to be evaluated, and will apply additional branding, such as a full page watermark.
    
    defaultvalue
    
    undefined
  - sourceDocument: string | Uint8Array | ViewingSession
    PDF document to open.
    
    Must be one of the following types:
    - string URL to a PDF. Both standard and data URLs are supported.
    - Uint8Array A byte array of the contents of the PDF document.
    - ViewingSession A Prizmdoc ViewingSession object.
Returns Promise<PdfViewerControl>

Accusoft PDF Viewer Documentation

v3.11.158639

Hierarchy

Index

Methods

Methods

Pro getAnnotations

Returns Promise<{ annotations: Annotation[] }>

Pro loadAnnotations

Parameters

options: { annotations: Annotation[] }

annotations: Annotation[]

Returns Promise<Object>

off

Parameters

eventName: EventName

listener: (data: EventData) => void

Parameters

data: EventData

Returns void

Returns PdfViewerControl

on

Parameters

eventName: EventName

listener: (data: EventData) => void

Parameters

data: EventData

Returns void

Returns PdfViewerControl

once

Parameters

eventName: EventName

listener: (data: EventData) => void

Parameters

data: EventData

Returns void

Returns PdfViewerControl

prependListener

Parameters

eventName: EventName

listener: (data: EventData) => void

Parameters

data: EventData

Returns void

Returns PdfViewerControl

prependOnceListener

Parameters

eventName: EventName

listener: (data: EventData) => void

Parameters

data: EventData

Returns void

Returns PdfViewerControl

removeAllListeners

Parameters

Optional eventName: EventName

Returns PdfViewerControl

Static create

Parameters

options: object; container: Element; licenseKey?: string; sourceDocument: string | Uint8Array | ViewingSession }

Pro Optional allowedControls?: object

Optional annotationList?: boolean

Optional ellipseTool?: boolean

Optional freehandDrawingTool?: boolean

Optional freehandSignatureTool?: boolean

Optional fullScreenToggle?: boolean

Optional lineTool?: boolean

Optional nextAndPreviousPageButtons?: boolean

Optional outline?: boolean

Optional pageNumberAndCount?: boolean

Optional printing?: boolean

Optional rectangleTool?: boolean

Optional search?: boolean

Optional textHighlightTool?: boolean

Optional thumbnails?: boolean

Optional zoomInAndOutButtons?: boolean

container: Element

Optional licenseKey?: string

sourceDocument: string | Uint8Array | ViewingSession

Returns Promise<PdfViewerControl>