ui.pdfviewer

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.

Constructor

var pdfviewer = webix.ui({
    view:"pdfviewer", 
    id:"pdf", 
    toolbar:"toolbar", 
    url:"binary->files/WebixDocs.pdf"
}).

Where to start

Methods
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component (allows behavior customizations)
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 hash of 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
getTopParentView returns top parent view
hasEvent checks whether the component has the specified event
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 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 a zooming scale and renders current page with the new scale
show makes the component visible
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
zoomIn zooms the viewed page in
zoomOut zooms the viewed page out
Events
onAfterLoad fires after data loading is complete
onAfterScroll occurs when some webix view has been scrolled
onBeforeLoad occurs immediately before data loading has been 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
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 when some webix view has been touched
onViewResize view size was changed by resizer
Properties
animate defines or disables view change animation.
borderless used to hide the component borders
container an HTML container (or its id) where the component should be initialized
css the name of a css class that will be applied to the view container
data JavaScript array containing data for the component
dataFeed the URL that the component will use to reload data during binding
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 (1 by default)
height sets the height of the component
hidden defines whether the view will be hidden initially
id the component ID
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 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 the component
Other
$getSize returns the current size of the component
$height 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
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to top html element of the view
$width current width of the view
config all options from initial component configuration
name indicates the name of the component (a read-only property)
Back to top
If you have not checked yet, be sure to visit site of our main product Webix ui library and page of pdf viewer library product.