ejs-pdfviewer represents the VueJS PdfViewer Component.
<ejs-pdfviewer></ejs-pdfviewer> DropdownFieldSettingsModel
Get or set the dropdown field settings.
AjaxRequestSettingsModel
Defines the ajax Request settings of the PDF Viewer.
Annotation
Gets the annotation object of the pdf viewer.
any[]
Get the Loaded document annotation Collections in the PdfViewer control.
AnnotationSelectorSettingsModel
Defines the settings of annotation selector.
AnnotationSettingsModel
Defines the settings of the annotations.
AreaSettingsModel
Defines the settings of area annotation.
ArrowSettingsModel
Defines the settings of arrow annotation.
BookmarkView
Gets the bookmark view object of the pdf viewer.
CheckBoxFieldSettingsModel
Get or set the check box field settings.
CircleSettingsModel
Defines the settings of circle annotation.
ContextMenuAction
Specifies the state of the ContextMenu in the PDF document.
Defaults to RightClick
ContextMenuSettingsModel
Defines the context menu settings.
number
Returns the current page number of the document displayed in the PdfViewer control.
Defaults to 0
CustomStampModel[]
Defines the stamp items of the PDF Viewer.
CustomStampSettingsModel
Defines the settings of customStamp annotation.
string
Customize desired date and time format
boolean
Enable or disable the interaction of form fields in the PDF Viewer.
Defaults to false
ContextMenuItem[]
Disables the menu items in the context menu.
Defaults to []
DistanceSettingsModel
Defines the settings of distance annotation.
string
Sets the PDF document path for initial loading.
string
Gets or sets the download file name in the PdfViewer control.
boolean
Enable or disable the annotation in the PDF Viewer.
Defaults to true
boolean
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.
Defaults to true
boolean
Enable or disables the auto complete option in form documents.
Defaults to true
boolean
Enables or disables the bookmark view in the PDF viewer
Defaults to true
boolean
Enables or disables the bookmark styles in the PDF viewer
Defaults to false
boolean
Enable or disables the Comment Panel of PdfViewer.
Defaults to true
boolean
Gets or sets a boolean value to show or hide desktop toolbar in mobile devices.
Defaults to false
boolean
Enable or disables the download option of PdfViewer.
Defaults to true
boolean
Show or hide the form designer tool in the main toolbar of the PDF Viewer.
Defaults to true
boolean
Opens the form designer toolbar when the PDF document is loaded in the PDF Viewer control initially.
Defaults to true
boolean
Enable or disable the form fields in the PDF Viewer.
Defaults to true
boolean
Enable or disable the form fields validation.
Defaults to false
boolean
Enable or disable the free text annotation in the PDF Viewer.
Defaults to true
boolean
Enables or disables the handwritten signature in PDF document.
Defaults to true
boolean
Enables or disables the hyperlinks in PDF document.
Defaults to true
boolean
Enable or disable the customization of measure values in PDF Viewer.
Defaults to true
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
boolean
Enable or disable the Magnification module of PDF Viewer.
Defaults to true
boolean
Enable or disable the calibrate annotation in the PDF Viewer.
Defaults to true
boolean
Enable or disable the multi line text markup annotations in overlapping collections.
Defaults to false
boolean
Enables or disables the multi-page text markup annotation selection in UI.
Defaults to false
boolean
Enable or disable the Navigation module of PDF Viewer.
Defaults to true
boolean
Enable or disables the Navigation toolbar of PdfViewer.
Defaults to true
boolean
Enable or disable persisting component’s state between page reloads.
Defaults to false
boolean
Enable or disable the pinch zoom option in the PDF Viewer.
Defaults to true
boolean
Enable or disables the print option of PdfViewer.
Defaults to true
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
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
boolean
Enable or disable the shape annotation in the PDF Viewer.
Defaults to true
boolean
Enable or disable the Label for shapeAnnotations of PDF Viewer.
Defaults to false
boolean
Enables and disable the stamp annotations when the PDF viewer control is loaded initially.
Defaults to true
boolean
Enables and disable the stickyNotes annotations when the PDF viewer control is loaded initially.
Defaults to true
boolean
Enable or disable the text markup annotation in the PDF Viewer.
Defaults to true
boolean
Enable or disable the text markup resizer to modify the bounds in UI.
Defaults to false
boolean
Enable or disable the text search in the PDF Viewer.
Defaults to true
boolean
Enable or disable the text selection in the PDF Viewer.
Defaults to true
boolean
Enables or disables the thumbnail view in the PDF viewer
Defaults to true
boolean
Enable or disables the toolbar of PdfViewer.
Defaults to true
boolean
Enable or disable the zoom optimization mode in PDF Viewer.
Defaults to true
string
Gets or sets the export annotations JSON file name in the PdfViewer control.
string
Gets or sets the document name loaded in the PdfViewer control.
FormDesigner
Gets the FormDesigner object of the pdf viewer.
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.
FreeTextSettingsModel
Defines the settings of free text annotation.
HandWrittenSignatureSettingsModel
Defines the settings of handWrittenSignature.
string | number
Defines the scrollable height of the PdfViewer control.
Defaults to ‘auto’
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
HighlightSettingsModel
Defines the settings of highlight annotation.
LinkTarget
Specifies the open state of the hyperlink in the PDF document.
Defaults to CurrentTab
SignatureDialogSettingsModel
Get or set the signature dialog settings for initial field.
InitialFieldSettingsModel
Get or set the initial field settings.
InkAnnotationSettingsModel
Defines the ink annotation settings for PDF Viewer.It used to customize the strokeColor, thickness, opacity of the ink annotation.
InteractionMode
Sets the interaction mode of the PDF Viewer.
Defaults to TextSelection
boolean
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.
Defaults to false
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
boolean
Gets or sets a boolean value to show or hide the bookmark panel while loading a document.
Defaults to false
boolean
If it set as true, then the command panel show at initial document loading in the PDF viewer
Defaults to false
boolean
Checks whether the PDF document is edited.
boolean
Enable or disable the get the document text collections.
Defaults to false
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
boolean
Enable if the PDF document contains form fields.
Defaults to false
boolean
Maintain the selection of text markup annotation.
Defaults to false
boolean
Enables or disable saving Hand Written signature as editable in the PDF.
Defaults to false
boolean
If it set as true, then the thumbnail view show at initial document loading in the PDF viewer
Defaults to false
boolean
Checks if the freeText value is valid or not.
Defaults to false
LineSettingsModel
Defines the settings of line annotation.
ListBoxFieldSettingsModel
Get or set the listbox field settings.
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Defaults to ”
Magnification
Gets the magnification object of the pdf viewer.
MeasurementSettingsModel
Defines the settings of measurement annotation.
Navigation
Gets the navigation object of the pdf viewer.
number
gets the page count of the document loaded in the PdfViewer control.
Defaults to 0
PasswordFieldSettingsModel
Get or set the password field settings.
PerimeterSettingsModel
Defines the settings of perimeter annotation.
PolygonSettingsModel
Defines the settings of polygon annotation.
Print
Gets the print object of the pdf viewer.
PrintMode
Specifies the print mode in the PDF Viewer.
Defaults to Default
RadioButtonFieldSettingsModel
Get or set the radio button field settings.
RadiusSettingsModel
Defines the settings of radius annotation.
RectangleSettingsModel
Defines the settings of rectangle annotation.
boolean
restrict zoom request.
Defaults to false
number
Specifies the retry count for the failed requests.
Defaults to 1
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]
ScrollSettingsModel
Defines the scroll settings.
SelectorModel
Defines the collection of selected items, size and position of the selector
Defaults to {}
ServerActionSettingsModel
Defines the settings of the PDF Viewer service.
string
Defines the service url of the PdfViewer control.
ShapeLabelSettingsModel
Defines the settings of shape label.
boolean
Show or hide the digital signature appearance in the document.
Defaults to true
boolean
If it is set as false then error message box is not displayed in PDF viewer control.
Defaults to true
any[]
Get the Loaded document signature Collections in the PdfViewer control.
SignatureDialogSettingsModel
Get or set the signature dialog settings for signature field.
SignatureFieldSettingsModel
Get or set the signature field settings.
SignatureFitMode
Specifies the signature mode in the PDF Viewer.
Defaults to Default
StampSettingsModel
Defines the settings of stamp annotation.
StickyNotesSettingsModel
Defines the settings of stickyNotes annotation.
StrikethroughSettingsModel
Defines the settings of strikethrough annotation.
TextFieldSettingsModel
Get or set the text field settings.
TextSearch
Gets the text search object of the pdf viewer.
TextSearchColorSettingsModel
Sets the settings for the color of the text search highlight.
TextSelection
Gets the TextSelection object of the pdf viewer.
ThumbnailView
Gets the thumbnail-view object of the pdf viewer.
TileRenderingSettingsModel
Defines the tile rendering settings.
Toolbar
Gets the toolbar object of the pdf viewer.
ToolbarSettingsModel
Defines the settings of the PDF Viewer toolbar.
UnderlineSettingsModel
Defines the settings of underline annotation.
VolumeSettingsModel
Defines the settings of volume annotation.
string | number
Defines the scrollable width of the PdfViewer control.
Defaults to ‘auto’
ZoomMode
Specifies the rendering mode in the PDF Viewer.
Defaults to Default
number
Returns the current zoom percentage of the PdfViewer control.
number
Sets the initial loading zoom value from 10 to 400 in the PDF Viewer Control.
Defaults to 0
Perform to add annotations in the PDF Viewer
Returns void
Clears data from the form fields. Parameter - Specifies the form field object.
Returns void
Convert user coordinates to the PDF page coordinates.
| Parameter | Type | Description |
|---|---|---|
| clientPoint | Point |
The user should provide a x, y coordinates. |
| pageNumber | number |
We need to pass pageNumber. |
Returns Point
Convert page coordinates to the user coordinates.
| Parameter | Type | Description |
|---|---|---|
| pagePoint | Point |
The user should provide a page x, y coordinates. |
| pageNumber | number |
We need to pass pageNumber. |
Returns Point
Convert page coordinates to the scrolling coordinates.
| Parameter | Type | Description |
|---|---|---|
| pagePoint | Point |
The user should provide a page x, y coordinates. |
| pageNumber | number |
We need to pass pageNumber. |
Returns Point
To delete the annotation Collections in the PDF Document.
Returns void
Destroys all managed resources used by this object.
Returns void
Downloads the PDF document being loaded in the ejPdfViewer control.
Returns void
Perform export annotations action in the PDF Viewer
Returns void
Export annotations and returns a base64 string for both Json and XFDF formats
Returns Promise
Perform export annotations action in the PDF Viewer
Returns Promise
Exports the form field data in the specified data format.
Returns void
Returns an object which represents the form field data in the specified data format.
Returns Promise
Focus a form field in a document by its field name or the field object.
Returns void
Get page number from the user coordinates x and y.
| Parameter | Type | Description |
|---|---|---|
| clientPoint | Point |
The user will provide a x, y coordinates. |
Returns number
Perform imports annotations action in the PDF Viewer
Returns void
Imports the form fields data into the current PDF document.
Returns void
Loads the given PDF document in the PDF viewer control
| Parameter | Type | Description |
|---|---|---|
| document | string |
Specifies the document name for load |
| password | string |
Specifies the Given document password |
Returns void
Perform redo action for the edited annotations
Returns void
reset all form fields data
Returns void
To retrieve the form fields in the PDF Document.
Returns FormFieldModel[]
Saves the PDF document being loaded in the PDF Viewer control as blob.
Returns Promise
To modify the Json Data in ajax request.
Returns void
Specifies the message to be displayed in the popup.
Returns void
Perform undo action for the edited annotations
Returns void
Unloads the PDF document being displayed in the PDF viewer.
Returns void
To update the form fields in the PDF Document.
Returns void
Update the form field values from externally.
Returns void
updates the PDF Viewer container width and height from externally.
Returns void
Brings the given rectangular region to view and zooms in the document to fit the region in client area (view port).
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rect |
Specifies the region in client coordinates that is to be brought to view. |
Returns void
EmitType<AddSignatureEventArgs>
Triggers when a signature is added to a page of a PDF document.
EmitType<AjaxRequestFailureEventArgs>
Triggers when the AJAX request is failed.
EmitType<AjaxRequestInitiateEventArgs>
Triggers before the data is sent to the server.
EmitType<AjaxRequestSuccessEventArgs>
Triggers on successful AJAX request.
EmitType<AnnotationAddEventArgs>
Triggers when an annotation is added to a PDF document’s page.
EmitType<AnnotationDoubleClickEventArgs>
Triggers when the annotation is double clicked.
EmitType<AnnotationMouseLeaveEventArgs>
Triggers when the user mouse moves away from the annotation object.
EmitType<AnnotationMouseoverEventArgs>
Triggers when the mouse is moved over the annotation object.
EmitType<AnnotationMoveEventArgs>
Triggers when an annotation is moved over the page of the PDF document.
EmitType<AnnotationMovingEventArgs>
Triggers while moving an annotation.
EmitType<AnnotationPropertiesChangeEventArgs>
Triggers when the annotation’s property is modified on a PDF document page.
EmitType<AnnotationRemoveEventArgs>
Triggers when an annotation is removed from a PDF document’s page.
EmitType<AnnotationResizeEventArgs>
Triggers when an annotation is resized over the page of a PDF document.
EmitType<AnnotationSelectEventArgs>
Triggers when an annotation is selected over the page of the PDF document.
EmitType<AnnotationUnSelectEventArgs>
Triggers when an annotation is unselected over the page of the PDF document.
EmitType<BeforeAddFreeTextEventArgs>
Triggers before adding a text in the freeText annotation.
EmitType<BookmarkClickEventArgs>
Triggers when the bookmark is clicked in the PDF Viewer’s bookmark panel.
EmitType<ButtonFieldClickEventArgs>
Triggers when the button is clicked.
EmitType<CommentEventArgs>
Triggers when a comment for the annotation is added to the comment panel.
EmitType<CommentEventArgs>
Triggers when the comment for the annotation in the comment panel is deleted.
EmitType<CommentEventArgs>
Triggers when the comment for the annotation in the comment panel is edited.
EmitType<CommentEventArgs>
Triggers when the comment for the annotation in the comment panel is selected.
EmitType<CommentEventArgs>
Triggers when the annotation’s comment for status is changed in the comment panel.
EmitType<void>
Triggers during the creation of the PDF viewer component.
EmitType<LoadEventArgs>
Triggers while loading document into PDF viewer.
EmitType<LoadFailedEventArgs>
Triggers while document loading failed in PdfViewer.
EmitType<UnloadEventArgs>
Triggers while closing the document.
EmitType<DownloadEndEventArgs>
Triggers when the download actions are completed.
EmitType<DownloadStartEventArgs>
Triggers when the download action is initiated.
EmitType<ExportFailureEventArgs>
Triggers when the annotations export in a PDF document fails.
EmitType<ExportStartEventArgs>
Triggers when an exported annotation started in the PDF Viewer.
EmitType<ExportSuccessEventArgs>
Triggers when the annotations in a PDF document are successfully exported.
EmitType<ExtractTextCompletedEventArgs>
Triggers when an text extraction is completed in the PDF Viewer.
EmitType<FormFieldAddArgs>
Triggers when a form field is added.
EmitType<FormFieldClickArgs>
Triggers when the form field is selected.
EmitType<FormFieldDoubleClickArgs>
Triggers when the form field is double-clicked.
EmitType<FormFieldFocusOutEventArgs>
Triggers when focus out from the form fields.
EmitType<FormFieldMouseLeaveArgs>
Triggers when the mouse cursor leaves the form field.
EmitType<FormFieldMouseoverArgs>
Triggers when the mouse cursor is over a form field.
EmitType<FormFieldMoveArgs>
Triggers when a form field is moved.
EmitType<FormFieldPropertiesChangeArgs>
Triggers when a property of form field is changed.
EmitType<FormFieldRemoveArgs>
Triggers when a form field is removed.
EmitType<FormFieldResizeArgs>
Triggers when a form field is resized.
EmitType<FormFieldSelectArgs>
Triggers when a form field is selected.
EmitType<FormFieldUnselectArgs>
Triggers when a form field is unselected.
EmitType<HyperlinkClickEventArgs>
Triggers when a hyperlink in a PDF document is clicked.
EmitType<HyperlinkMouseOverArgs>
Triggers when hyperlink in a PDF document is hovered.
EmitType<ImportFailureEventArgs>
Triggers when the annotations imports in a PDF document fails.
EmitType<ImportStartEventArgs>
Triggers when an imported annotation started to appear in the PDF document.
EmitType<ImportSuccessEventArgs>
Triggers when the annotations in a PDF document are successfully imported.
EmitType<MoveSignatureEventArgs>
Triggers when a signature is moved across the page of a PDF document.
EmitType<PageChangeEventArgs>
Triggers when there is change in current page number.
EmitType<PageClickEventArgs>
Triggers when the mouse click is performed over the page of the PDF document.
EmitType<PageMouseoverEventArgs>
Triggers when moving the mouse over the page.
EmitType<PrintEndEventArgs>
Triggers when the print actions are completed.
EmitType<PrintStartEventArgs>
Triggers when the print action is initiated.
EmitType<RemoveSignatureEventArgs>
Triggers when the signature is removed from the page of a PDF document.
EmitType<ResizeSignatureEventArgs>
Triggers when the signature is resized and placed on a page of a PDF document.
EmitType<SignaturePropertiesChangeEventArgs>
Triggers when the property of the signature is changed in the page of the PDF document.
EmitType<SignatureSelectEventArgs>
Triggers when signature is selected over the page of the PDF document.
EmitType<TextSearchCompleteEventArgs>
Triggers when the text search is completed.
EmitType<TextSearchHighlightEventArgs>
Triggers when the text search text is highlighted.
EmitType<TextSearchStartEventArgs>
Triggers when the text search is initiated.
EmitType<TextSelectionEndEventArgs>
Triggers when the text selection is complete.
EmitType<TextSelectionStartEventArgs>
Triggers when the text selection is initiated.
EmitType<ThumbnailClickEventArgs>
Triggers when the thumbnail in the PDF Viewer’s thumbnail panel is clicked.
EmitType<ValidateFormFieldsArgs>
Triggers when validation is failed.
EmitType<ZoomChangeEventArgs>
Triggers When the magnification value changes.