Since 3.0
A tool for displaying the content of PDF files on the screen.
Webix PDF Viewer is a useful tool for viewing PDF files. It consists of a toolbar that contains buttons for paging and zooming and the viewer itself.
Check PDF Viewer documentation for a more detailed information.
var pdfviewer = webix.ui({
view:"pdfviewer",
id:"pdf",
toolbar:"toolbar",
url:"binary->files/WebixDocs.pdf"
});
| adjust | adjusts the component to the size of the parent HTML container |
| attachEvent | attaches the handler to an inner event of the component |
| bind | binds components |
| blockEvent | temporarily blocks triggering of ALL events of the calling object |
| callEvent | calls an inner event |
| clear | clears the content of PDF Viewer |
| define | redefines a single configuration property (or a object with properties) |
| destructor | destructs the calling object |
| detachEvent | detaches a handler from an event (which was attached before by the attachEvent method) |
| disable | disables the calling view (makes it dimmed and unclickable) |
| download | downloads viewer contents as PDF file |
| enable | enables the calling view that was disabled by the 'disable' method |
| getChildViews | returns child views of the calling component |
| getFormView | returns master form for the input |
| getNode | returns the main HTML container for the calling object |
| getParentView | returns the parent view of the component |
| getPopup | returns the window for entering the file password |
| getTopParentView | returns the top parent view |
| hasEvent | checks whether the component has the specified event handler |
| hide | hides the view |
| isEnabled | checks whether the view is enabled |
| isVisible | checks whether the view is visible |
| load | loads data from an external data source |
| mapEvent | routes events from one object to another |
| nextPage | renders the page that follows the viewed one |
| parse | loads data to the component from an inline data source |
| prevPage | renders the page that precedes the viewed one |
| queryView | returns inner element/elements of a widget that correspond(s) to the defined parameters |
| renderPage | renders the specified page in the viewer |
| resize | adjusts the view to a new size |
| setScale | sets a new value for zooming scale and renders the current page with the new scale |
| show | makes the component visible |
| unbind | breaks "bind" link |
| unblockEvent | cancels events blocking that was enabled by the 'blockEvent' command |
| zoomIn | zooms the viewed page in |
| zoomOut | zooms the viewed page out |
| onAfterLoad | fires after data loading is complete |
| onBeforeLoad | fires immediately before data loading has started |
| onBindRequest | fires when the component is ready to receive data from the master component |
| onBlur | fires when focus is moved out of the view |
| onDestruct | occurs when component destroyed |
| onDocumentReady | fires after the PDF file is fully loaded and the initial page is rendered |
| onEnter | fires when the Enter key has been pressed |
| onFocus | fires when a view gets focus |
| onKeyPress | occurs when keyboard key is pressed for the control in focus |
| onLoadError | fires when an error occurs during data loading (invalid server side response) |
| onLongTouch | fires on holding finger in some position for a certain period of time |
| onPageRender | fires after a page is rendered in the viewer body |
| onScaleChange | fires after the page has been zoomed |
| onSwipeX | occurs on a horizontal swipe movement |
| onSwipeY | occurs on a vertical swipe movement |
| onTimedKeyPress | fires after typing has been finished in the field |
| onTouchEnd | occurs when the touch event is ended |
| onTouchMove | occurs during touch movement |
| onTouchStart | fires when some webix view has been touched |
| onViewResize | fires when the size of a view has been changed by resizer |
| onViewShow | fires when any hidden view is shown |
| animate | defines the type of animation, with which the view is shown, if it is a Multiview cell |
| borderless | used to hide the component borders |
| container | an HTML container (or its ID) where the component should be initialized |
| css | the name of the CSS class or the object with styles that will be applied to the view container |
| data | JavaScript array containing data for the component |
| datatype | the type of loaded data |
| disabled | indicates whether an item is enabled |
| downloadName | sets the name of the downloaded file without the .pdf extension |
| gravity | sets the view gravity |
| height | sets the height of the component |
| hidden | defines whether the view will be hidden initially |
| id | the ID of a widget |
| keyPressTimeout | a delay between the key press and the action |
| maxHeight | sets the maximum height for the view |
| maxWidth | sets the maximum width for the view |
| minHeight | sets the minimal height for the view |
| minWidth | sets the minimal width for the view |
| on | allows attaching custom handlers to inner events of the component |
| scale | the current scale value |
| toolbar | the id of the PDF toolbar related to the viewer |
| url | the URL which the component will use to load data after its initialization |
| width | sets the width of a widget |
| $customPrint | generates custom HTML to print instead of the widget HTML and invokes printing |
| $getSize | returns the current size of the component |
| $height | the current height of the view |
| $numPages | total number of pages in the document |
| $onLoad | default action on data loading |
| $pageNum | the number of a currently visible page |
| $scope | scope for resolving event and method names |
| $setNode | defines HTML element for the component |
| $setSize | sets the component size |
| $skin | the method which will be called when skin is defined |
| $view | reference to the top HTML element of the view |
| $width | the current width of the view |
| config | all options from the initial component configuration |
| name | indicates the name of the component (a read-only property) |