PdfViewerComponent

ejs-pdfviewer represents the VueJS PdfViewer Component.

<ejs-pdfviewer></ejs-pdfviewer>

Properties

DropdownFieldSettings

DropdownFieldSettingsModel

Get or set the dropdown field settings.

ajaxRequestSettings

AjaxRequestSettingsModel

Defines the ajax Request settings of the PDF Viewer.

annotation

Annotation

Gets the annotation object of the pdf viewer.

annotationCollection

any[]

Get the Loaded document annotation Collections in the PdfViewer control.

annotationSelectorSettings

AnnotationSelectorSettingsModel

Defines the settings of annotation selector.

annotationSettings

AnnotationSettingsModel

Defines the settings of the annotations.

areaSettings

AreaSettingsModel

Defines the settings of area annotation.

arrowSettings

ArrowSettingsModel

Defines the settings of arrow annotation.

bookmark

BookmarkView

Gets the bookmark view object of the pdf viewer.

checkBoxFieldSettings

CheckBoxFieldSettingsModel

Get or set the check box field settings.

circleSettings

CircleSettingsModel

Defines the settings of circle annotation.

contextMenuOption

string

Specifies the state of the ContextMenu in the PDF document.

Defaults to RightClick

contextMenuSettings

ContextMenuSettingsModel

Defines the context menu settings.

currentPageNumber

number

Returns the current page number of the document displayed in the PdfViewer control.

Defaults to 0

customStamp

CustomStampModel[]

Defines the stamp items of the PDF Viewer.

customStampSettings

CustomStampSettingsModel

Defines the settings of customStamp annotation.

dateTimeFormat

string

Customize desired date and time format

designerMode

boolean

Enable or disable the interaction of form fields in the PDF Viewer.

Defaults to false

disableContextMenuItems

ContextMenuItem[]

enable or disable context menu Items

Defaults to []

distanceSettings

DistanceSettingsModel

Defines the settings of distance annotation.

documentPath

string

Sets the PDF document path for initial loading.

downloadFileName

string

Gets or sets the download file name in the PdfViewer control.

enableAnnotation

boolean

Enable or disable the annotation in the PDF Viewer.

Defaults to true

enableAnnotationToolbar

boolean

Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.

Defaults to true

enableAutoComplete

boolean

Enable or disables the auto complete option in form documents.

Defaults to true

enableBookmark

boolean

Enables or disables the bookmark view in the PDF viewer

Defaults to true

enableBookmarkStyles

boolean

Enables or disables the bookmark styles in the PDF viewer

Defaults to false

enableCommentPanel

boolean

Enable or disables the Comment Panel of PdfViewer.

Defaults to true

enableDesktopMode

boolean

Gets or sets a boolean value to show or hide desktop toolbar in mobile devices.

Defaults to false

enableDownload

boolean

Enable or disables the download option of PdfViewer.

Defaults to true

enableFormDesigner

boolean

Show or hide the form designer tool in the main toolbar of the PDF Viewer.

Defaults to true

enableFormDesignerToolbar

boolean

Opens the form designer toolbar when the PDF document is loaded in the PDF Viewer control initially.

Defaults to true

enableFormFields

boolean

Enable or disable the form fields in the PDF Viewer.

Defaults to true

enableFormFieldsValidation

boolean

Enable or disable the form fields validation.

Defaults to false

enableFreeText

boolean

Enable or disable the free text annotation in the PDF Viewer.

Defaults to true

enableHandwrittenSignature

boolean

Enables or disables the handwritten signature in PDF document.

Defaults to true

enableHyperlink

boolean

Enables or disables the hyperlinks in PDF document.

Defaults to true

enableImportAnnotationMeasurement

boolean

Enable or disable the customization of measure values in PDF Viewer.

Defaults to true

enableInkAnnotation

boolean

If it is set as false, then the ink annotation support in the PDF Viewer will be disabled. By default it is true.

Defaults to true

enableMagnification

boolean

Enable or disable the Magnification module of PDF Viewer.

Defaults to true

enableMeasureAnnotation

boolean

Enable or disable the calibrate annotation in the PDF Viewer.

Defaults to true

enableMultiLineOverlap

boolean

Enable or disable the multi line text markup annotations in overlapping collections.

Defaults to false

enableMultiPageAnnotation

boolean

Enables or disables the multi-page text markup annotation selection in UI.

Defaults to false

enableNavigation

boolean

Enable or disable the Navigation module of PDF Viewer.

Defaults to true

enableNavigationToolbar

boolean

Enable or disables the Navigation toolbar of PdfViewer.

Defaults to true

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enablePinchZoom

boolean

Enable or disable the pinch zoom option in the PDF Viewer.

Defaults to true

enablePrint

boolean

Enable or disables the print option of PdfViewer.

Defaults to true

enablePrintRotation

boolean

If it is set as FALSE, will suppress the page rotation of Landscape document on print action. By default it is TRUE.

Defaults to true

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableShapeAnnotation

boolean

Enable or disable the shape annotation in the PDF Viewer.

Defaults to true

enableShapeLabel

boolean

Enable or disable the Label for shapeAnnotations of PDF Viewer.

Defaults to false

enableStampAnnotations

boolean

Enables and disable the stamp annotations when the PDF viewer control is loaded initially.

Defaults to true

enableStickyNotesAnnotation

boolean

Enables and disable the stickyNotes annotations when the PDF viewer control is loaded initially.

Defaults to true

enableTextMarkupAnnotation

boolean

Enable or disable the text markup annotation in the PDF Viewer.

Defaults to true

enableTextMarkupResizer

boolean

Enable or disable the text markup resizer to modify the bounds in UI.

Defaults to false

enableTextSearch

boolean

Enable or disable the text search in the PDF Viewer.

Defaults to true

enableTextSelection

boolean

Enable or disable the text selection in the PDF Viewer.

Defaults to true

enableThumbnail

boolean

Enables or disables the thumbnail view in the PDF viewer

Defaults to true

enableToolbar

boolean

Enable or disables the toolbar of PdfViewer.

Defaults to true

enableZoomOptimization

boolean

Enable or disable the zoom optimization mode in PDF Viewer.

Defaults to true

exportAnnotationFileName

string

Gets or sets the export annotations JSON file name in the PdfViewer control.

fileName

string

Gets or sets the document name loaded in the PdfViewer control.

formDesigner

FormDesigner

Gets the FormDesigner object of the pdf viewer.

formFieldCollections

FormFieldModel[]

Gets the form fields present in the loaded PDF document. It used to get the form fields id, name, type and it’s values.

freeTextSettings

FreeTextSettingsModel

Defines the settings of free text annotation.

handWrittenSignatureSettings

HandWrittenSignatureSettingsModel

Defines the settings of handWrittenSignature.

height

string | number

Defines the scrollable height of the PdfViewer control.

Defaults to ‘auto’

hideSaveSignature

boolean

Gets or sets a boolean value to show or hide the save signature check box option in the signature dialog. FALSE by default

Defaults to false

highlightSettings

HighlightSettingsModel

Defines the settings of highlight annotation.

hyperlinkOpenState

string

Specifies the open state of the hyperlink in the PDF document.

Defaults to CurrentTab

initialDialogSettings

SignatureDialogSettingsModel

Get or set the signature dialog settings for initial field.

initialFieldSettings

InitialFieldSettingsModel

Get or set the initial field settings.

inkAnnotationSettings

InkAnnotationSettingsModel

Defines the ink annotation settings for PDF Viewer.It used to customize the strokeColor, thickness, opacity of the ink annotation.

interactionMode

string

Sets the interaction mode of the PDF Viewer.

Defaults to TextSelection

isAnnotationToolbarOpen

boolean

Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.

Defaults to false

isAnnotationToolbarVisible

boolean

Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially and get the annotation Toolbar Visible status.

Defaults to false

isBookmarkPanelOpen

boolean

Gets or sets a boolean value to show or hide the bookmark panel while loading a document.

Defaults to false

isCommandPanelOpen

boolean

If it set as true, then the command panel show at initial document loading in the PDF viewer

Defaults to false

isDocumentEdited

boolean

Checks whether the PDF document is edited.

isExtractText

boolean

Enable or disable the get the document text collections.

Defaults to false

isFormDesignerToolbarVisible

boolean

Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially and get the annotation Toolbar Visible status.

Defaults to false

isFormFieldDocument

boolean

Enable if the PDF document contains form fields.

Defaults to false

isMaintainSelection

boolean

Maintain the selection of text markup annotation.

Defaults to false

isSignatureEditable

boolean

Enables or disable saving Hand Written signature as editable in the PDF.

Defaults to false

isThumbnailViewOpen

boolean

If it set as true, then the thumbnail view show at initial document loading in the PDF viewer

Defaults to false

isValidFreeText

boolean

Checks if the freeText value is valid or not. FALSE by default

Defaults to false

lineSettings

LineSettingsModel

Defines the settings of line annotation.

listBoxFieldSettings

ListBoxFieldSettingsModel

Get or set the listbox field settings.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ”

magnification

Magnification

Gets the magnification object of the pdf viewer.

measurementSettings

MeasurementSettingsModel

Defines the settings of measurement annotation.

navigation

Navigation

Gets the navigation object of the pdf viewer.

pageCount

number

gets the page count of the document loaded in the PdfViewer control.

Defaults to 0

passwordFieldSettings

PasswordFieldSettingsModel

Get or set the password field settings.

perimeterSettings

PerimeterSettingsModel

Defines the settings of perimeter annotation.

polygonSettings

PolygonSettingsModel

Defines the settings of polygon annotation.

print

Print

Gets the print object of the pdf viewer.

printMode

string

Specifies the print mode in the PDF Viewer.

Defaults to Default

radioButtonFieldSettings

RadioButtonFieldSettingsModel

Get or set the radio button field settings.

radiusSettings

RadiusSettingsModel

Defines the settings of radius annotation.

rectangleSettings

RectangleSettingsModel

Defines the settings of rectangle annotation.

restrictZoomRequest

boolean

restrict zoom request.

Defaults to false

retryCount

number

Specifies the retry count for the failed requests.

Defaults to 1

retryStatusCodes

number[]

Specifies the response status codes for retrying a failed request with a “3xx”, “4xx”, or “5xx” response status code. The value can have multiple values, such as [500, 401, 400], and the default value is 500.

Defaults to [500]

scrollSettings

ScrollSettingsModel

Defines the scroll settings.

selectedItems

SelectorModel

Defines the collection of selected items, size and position of the selector

Defaults to {}

serverActionSettings

ServerActionSettingsModel

Defines the settings of the PDF Viewer service.

serviceUrl

string

Defines the service url of the PdfViewer control.

shapeLabelSettings

ShapeLabelSettingsModel

Defines the settings of shape label.

showDigitalSignatureAppearance

boolean

Show or hide the digital signature appearance in the document.

Defaults to true

showNotificationDialog

boolean

If it is set as false then error message box is not displayed in PDF viewer control.

Defaults to true

signatureCollection

any[]

Get the Loaded document signature Collections in the PdfViewer control.

signatureDialogSettings

SignatureDialogSettingsModel

Get or set the signature dialog settings for signature field.

signatureFieldSettings

SignatureFieldSettingsModel

Get or set the signature field settings.

signatureFitMode

string

Specifies the signature mode in the PDF Viewer.

Defaults to Default

stampSettings

StampSettingsModel

Defines the settings of stamp annotation.

stickyNotesSettings

StickyNotesSettingsModel

Defines the settings of stickyNotes annotation.

strikethroughSettings

StrikethroughSettingsModel

Defines the settings of strikethrough annotation.

textFieldSettings

TextFieldSettingsModel

Get or set the text field settings.

textSearch

TextSearch

Gets the text search object of the pdf viewer.

textSearchColorSettings

TextSearchColorSettingsModel

Sets the settings for the color of the text search highlight.

textSelection

TextSelection

Gets the TextSelection object of the pdf viewer.

thumbnailView

ThumbnailView

Gets the thumbnail-view object of the pdf viewer.

tileRenderingSettings

TileRenderingSettingsModel

Defines the tile rendering settings.

toolbar

Toolbar

Gets the toolbar object of the pdf viewer.

toolbarSettings

ToolbarSettingsModel

Defines the settings of the PDF Viewer toolbar.

underlineSettings

UnderlineSettingsModel

Defines the settings of underline annotation.

volumeSettings

VolumeSettingsModel

Defines the settings of volume annotation.

width

string | number

Defines the scrollable width of the PdfViewer control.

Defaults to ‘auto’

zoomMode

string

Specifies the rendering mode in the PDF Viewer.

Defaults to Default

zoomPercentage

number

Returns the current zoom percentage of the PdfViewer control.

zoomValue

number

Sets the initial loading zoom value from 10 to 400 in the PDF Viewer Control.

Defaults to 0

Methods

addAnnotation

Perform to add annotations in the PDF Viewer

Returns void

clearFormFields

Clears data from the form fields. Parameter - Specifies the form field object.

Returns void

convertClientPointToPagePoint

Convert user coordinates to the PDF page coordinates.

Returns Point

convertPagePointToClientPoint

Convert page coordinates to the user coordinates.

Returns Point

convertPagePointToScrollingPoint

Convert page coordinates to the scrolling coordinates.

Returns Point

deleteAnnotations

To delete the annotation Collections in the PDF Document.

Returns void

destroy

Destroys all managed resources used by this object.

Returns void

download

Downloads the PDF document being loaded in the ejPdfViewer control.

Returns void

exportAnnotation

Perform export annotations action in the PDF Viewer

Returns void

exportAnnotationsAsBase64String

Export annotations and returns a base64 string for both Json and XFDF formats

Returns Promise

exportAnnotationsAsObject

Perform export annotations action in the PDF Viewer

Returns Promise

exportFormFields

Exports the form field data in the specified data format.

Returns void

exportFormFieldsAsObject

Returns an object which represents the form field data in the specified data format.

Returns Promise

focusFormField

Focus a form field in a document by its field name or the field object.

Returns void

getPageNumberFromClientPoint

Get page number from the user coordinates x and y.

Returns number

importAnnotation

Perform imports annotations action in the PDF Viewer

Returns void

importFormFields

Imports the form fields data into the current PDF document.

Returns void

load

Loads the given PDF document in the PDF viewer control

Returns void

redo

Perform redo action for the edited annotations

Returns void

resetFormFields

reset all form fields data

Returns void

retrieveFormFields

To retrieve the form fields in the PDF Document.

Returns FormFieldModel[]

saveAsBlob

Saves the PDF document being loaded in the PDF Viewer control as blob.

Returns Promise

setJsonData

To modify the Json Data in ajax request.

Returns void

showNotificationPopup

Specifies the message to be displayed in the popup.

Returns void

undo

Perform undo action for the edited annotations

Returns void

unload

Unloads the PDF document being displayed in the PDF viewer.

Returns void

updateFormFields

To update the form fields in the PDF Document.

Returns void

updateFormFieldsValue

Update the form field values from externally.

Returns void

updateViewerContainer

updates the PDF Viewer container width and height from externally.

Returns void

zoomToRect

Brings the given rectangular region to view and zooms in the document to fit the region in client area (view port).

Returns void

Events

addSignature

EmitType<AddSignatureEventArgs>

Triggers when signature is added over the page of the PDF document.

ajaxRequestFailed

EmitType<AjaxRequestFailureEventArgs>

Triggers when the AJAX request is failed.

ajaxRequestInitiate

EmitType<AjaxRequestInitiateEventArgs>

Triggers before the data send in to the server.

ajaxRequestSuccess

EmitType<AjaxRequestSuccessEventArgs>

Event triggers on successful AJAX request

annotationAdd

EmitType<AnnotationAddEventArgs>

Triggers when an annotation is added over the page of the PDF document.

annotationDoubleClick

EmitType<AnnotationDoubleClickEventArgs>

Triggers an event when the annotation is double click.

annotationMouseLeave

EmitType<AnnotationMouseLeaveEventArgs>

Triggers when mouse over the annotation object.

annotationMouseover

EmitType<AnnotationMouseoverEventArgs>

Triggers when mouse over the annotation object.

annotationMove

EmitType<AnnotationMoveEventArgs>

Triggers when an annotation is moved over the page of the PDF document.

annotationMoving

EmitType<AnnotationMovingEventArgs>

Triggers while moving an annotation.

annotationPropertiesChange

EmitType<AnnotationPropertiesChangeEventArgs>

Triggers when the property of the annotation is changed in the page of the PDF document.

annotationRemove

EmitType<AnnotationRemoveEventArgs>

Triggers when an annotation is removed from the page of the PDF document.

annotationResize

EmitType<AnnotationResizeEventArgs>

Triggers when an annotation is resized over the page of the PDF document.

annotationSelect

EmitType<AnnotationSelectEventArgs>

Triggers when an annotation is selected over the page of the PDF document.

annotationUnSelect

EmitType<AnnotationUnSelectEventArgs>

Triggers when an annotation is unselected over the page of the PDF document.

beforeAddFreeText

EmitType<BeforeAddFreeTextEventArgs>

Triggers the event before adding a text in the freeText annotation.

bookmarkClick

EmitType<BookmarkClickEventArgs>

Triggers an event when the bookmark is clicked in the bookmark panel of PDF Viewer.

buttonFieldClick

EmitType<ButtonFieldClickEventArgs>

Triggers an event when the button is clicked.

commentAdd

EmitType<CommentEventArgs>

Triggers when the comment is added for the annotation in the comment panel.

commentDelete

EmitType<CommentEventArgs>

Triggers when the comment is deleted for the annotation in the comment panel.

commentEdit

EmitType<CommentEventArgs>

Triggers when the comment is edited for the annotation in the comment panel.

commentSelect

EmitType<CommentEventArgs>

Triggers when the comment is selected for the annotation in the comment panel.

commentStatusChanged

EmitType<CommentEventArgs>

Triggers when the comment for status is changed for the annotation in the comment panel.

created

EmitType<void>

Triggers while created the PdfViewer component.

documentLoad

EmitType<LoadEventArgs>

Triggers while loading document into PdfViewer.

documentLoadFailed

EmitType<LoadFailedEventArgs>

Triggers while loading document got failed in PdfViewer.

documentUnload

EmitType<UnloadEventArgs>

Triggers while close the document

downloadEnd

EmitType<DownloadEndEventArgs>

Triggers an event when the download actions is finished.

downloadStart

EmitType<DownloadStartEventArgs>

Triggers an event when the download action is started.

exportFailed

EmitType<ExportFailureEventArgs>

Triggers when an export annotations failed in the PDF Viewer.

exportStart

EmitType<ExportStartEventArgs>

Triggers when an exported annotations started in the PDF Viewer.

exportSuccess

EmitType<ExportSuccessEventArgs>

Triggers when an export annotations succeed in the PDF Viewer.

extractTextCompleted

EmitType<ExtractTextCompletedEventArgs>

Triggers when an text extraction is completed in the PDF Viewer.

formFieldAdd

EmitType<FormFieldAddArgs>

The event is triggered when a form field is added.

formFieldClick

EmitType<FormFieldClickArgs>

Triggers an event when the form field is clicked.

formFieldDoubleClick

EmitType<FormFieldDoubleClickArgs>

Triggers an event when the form field is double-clicked.

formFieldFocusOut

EmitType<FormFieldFocusOutEventArgs>

Triggers when focus out from the form fields.

formFieldMouseLeave

EmitType<FormFieldMouseLeaveArgs>

The event is triggered when a mouse cursor leaves form field.

formFieldMouseover

EmitType<FormFieldMouseoverArgs>

The event is triggered when a mouse cursor is over a form field.

formFieldMove

EmitType<FormFieldMoveArgs>

The event is triggered when a form field is moved.

formFieldPropertiesChange

EmitType<FormFieldPropertiesChangeArgs>

The event is triggered when a property of form field is changed.

formFieldRemove

EmitType<FormFieldRemoveArgs>

The event is triggered when a form field is removed.

formFieldResize

EmitType<FormFieldResizeArgs>

The event is triggered when a form field is resized.

formFieldSelect

EmitType<FormFieldSelectArgs>

The event is triggered when a form field is selected.

formFieldUnselect

EmitType<FormFieldUnselectArgs>

The event is triggered when a form field is unselected.

hyperlinkClick

EmitType<HyperlinkClickEventArgs>

Triggers when hyperlink in the PDF Document is clicked

hyperlinkMouseOver

EmitType<HyperlinkMouseOverArgs>

Triggers when hyperlink in the PDF Document is hovered

importFailed

EmitType<ImportFailureEventArgs>

Triggers when an imports annotations failed in the PDF document.

importStart

EmitType<ImportStartEventArgs>

Triggers when an imported annotations started in the PDF document.

importSuccess

EmitType<ImportSuccessEventArgs>

Triggers when an imports annotations succeed in the PDF document.

moveSignature

EmitType<MoveSignatureEventArgs>

Triggers when an signature is moved over the page of the PDF document.

pageChange

EmitType<PageChangeEventArgs>

Triggers when there is change in current page number.

pageClick

EmitType<PageClickEventArgs>

Triggers when the mouse click is performed over the page of the PDF document.

pageMouseover

EmitType<PageMouseoverEventArgs>

Triggers when mouse over the page.

printEnd

EmitType<PrintEndEventArgs>

Triggers an event when the print actions is finished.

printStart

EmitType<PrintStartEventArgs>

Triggers an event when the print action is started.

removeSignature

EmitType<RemoveSignatureEventArgs>

Triggers when signature is removed over the page of the PDF document.

resizeSignature

EmitType<ResizeSignatureEventArgs>

Triggers when signature is resized over the page of the PDF document.

signaturePropertiesChange

EmitType<SignaturePropertiesChangeEventArgs>

Triggers when the property of the signature is changed in the page of the PDF document.

signatureSelect

EmitType<SignatureSelectEventArgs>

Triggers when signature is selected over the page of the PDF document.

textSearchComplete

EmitType<TextSearchCompleteEventArgs>

Triggers an event when the text search is completed.

textSearchHighlight

EmitType<TextSearchHighlightEventArgs>

Triggers an event when the text search text is highlighted.

textSearchStart

EmitType<TextSearchStartEventArgs>

Triggers an event when the text search is started.

textSelectionEnd

EmitType<TextSelectionEndEventArgs>

Triggers an event when the text selection is finished.

textSelectionStart

EmitType<TextSelectionStartEventArgs>

Triggers an event when the text selection is started.

thumbnailClick

EmitType<ThumbnailClickEventArgs>

Triggers an event when the thumbnail is clicked in the thumbnail panel of PDF Viewer.

validateFormFields

EmitType<ValidateFormFieldsArgs>

Triggers when validation is failed.

zoomChange

EmitType<ZoomChangeEventArgs>

Triggers when there is change in the magnification value.