ui.pdfviewer

Since 3.0

компонент для просмотра PDF файлов.

Webix PDF Viewer - это удобный компонент для просмотра PDF файлов. Над окном с документом отображается панель с кнопками для навигации по страницам документа и управления просмотром.

Подробнее читайте в описательной документации.

Инициализация

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

С чего начать

Methods
adjust подстраивает размеры компонента под размеры HTML-контейнера
attachEvent задает обработчик внутреннего события компонента
bind связывает данные компонентов
blockEvent временно блокирует вызов ВСЕХ событий вызывающего объекта
callEvent вызывает внутреннее событие компонента
clear закрывает документ и удаляет его из PdfViewer
define переопределяет одну или несколько настроек компонента
destructor разрушает компонент
detachEvent удаляет обработчик события (который был задан ранее методом attachEvent)
disable блокирует компонент (он становится серым, клики по нему не срабатывают)
download начинает скачивание открытого в PDFViewer файла (открывает диалоговое окно)
enable делает активным ранее заблокированный компонент
getChildViews возвращает внутренние компоненты
getFormView возвращает объект формы, которой принадлежит компонент
getNode возвращает HTML-элемент компонента
getParentView возвращает родительский компонент
getPopup возвращает окно для ввода пароля для доступа к файлу
getTopParentView возвращает самого верхнего родителя
hasEvent проверяет, есть ли у компонента обработчики указанного события
hide скрывает компонент
isEnabled проверяет, активен или заблокирован компонент
isVisible проверяет, виден ли компонент
load загружает данные из внешнего источника данных
mapEvent направляет события от одного компонента к другому
nextPage открывает следующую страницу документа
parse загружает данные, доступные на клиенте
prevPage открывает предыдущую страницу
queryView возвращает внутренние компоненты, которые удовлетворяют указанному условию
renderPage открывает страницу по указанному в параметре номеру
resize перерисовывает компонент после изменения размеров
setScale задает новое значение масштаба и отображает текущую страницу с новым масштабом
show делает компонент видимым
unbind отменяет связывание компонентов
unblockEvent отменяет блокировку событий, которая была вызвана командой 'blockEvent'
zoomIn увеличивает масштаб
zoomOut уменьшает масштаб
Events
onAfterLoad срабатывает после завершения загрузки данных
onAfterScroll срабатывает после прокрутки содержимого компонента webix
onBeforeLoad запускается непосредственно перед началом загрузки данных
onBindRequest срабатывает, когда компонент готов получить данные из главного компонента
onBlur срабатывает при смещении фокуса за пределы компонента
onDestruct происходит, когда компонент был разрушен деструктором
onDocumentReady срабатывает после загрузки файла PDF и отображения первой страницы
onEnter срабатывает после нажатия клавиши Enter
onFocus срабатывает после смещения фокуса на компонент
onKeyPress срабатывает после того, как пользователь нажал клавишу (для компонента, на котором сейчас фокус)
onLoadError срабатывает при возникновении ошибки во время загрузки данных (невалидный ответ с сервера)
onLongTouch срабатывает после того, как пользователь на достаточно долгое время задержит палец на экране (для устройств с сенсорным экраном)
onPageRender срабатывает после отображения страницы документа
onScaleChange срабатывает после увеличения масштаба при просмотре документа
onSwipeX срабатывает по горизонтальному свайпу
onSwipeY срабатывает по вертикальному свайпу
onTimedKeyPress срабатывает через некоторое время после нажатия клавиши в текстовом поле
onTouchEnd срабатывает после завершения события touch
onTouchMove срабатывает по время движения пальца по сенсорному экрану
onTouchStart срабатывает после touch-события в компоненте webix
onViewResize срабатывает после того, как пользователь изменил размер компонента с помощью компонента resizer
onViewShow срабатывает, когда компонент появляется (вызов метода show())
Properties
animate определяет анимацию для показа компонента в Multiview
borderless скрывает или показывает границы компонента
container HTML-контейнер (или его ID), внутри которого компонент должен быть инициализирован
css имя CSS-класса, который будет присвоен HTML-элементу компонента, или объект со стилями
data данные для компонента (массив, типизированный массив, XML или CSV)
datatype тип загружаемых данных
disabled блокирует или разблокирует компонент
downloadName задает имя, которое будет присвоено файлу после скачивания (без расширения .pdf)
gravity задает удельный (относительный) размер компонента
height задает высоту компонента
hidden скрывает компонент после его инициализации
id ID компонента
keyPressTimeout задержка между нажатием клавиши и обработчиком
maxHeight задает максимальную высоту компонента
maxWidth задает максимальную ширину компонента
minHeight задает минимальную высоту компонента
minWidth задает минимальную ширину компонента
on позволяет присоединять обработчики к внутренним событиям компонента
scale текущий масштаб
toolbar id панели инструментов для PDFViewer
url путь к данным, которые загрузятся в компонент сразу после инициализации
width задает ширину компонента
Other
$getSize возвращает текущий размер компонентов
$height текущая высота компонента
$numPages общее количество страниц в документе
$onLoad действие по умолчанию при загрузке данных
$pageNum номер открытой в данный момент страницы
$scope область имен для событий и методов
$setNode определяет HTML-элемент компонента
$setSize задает размеры компонента
$skin вызывается после применения скина
$view возвращает HTML-элемент компонента
$width текущая ширина компонента
config все настройки, заданные при инициализации компонента
name возвращает имя компонента (свойство только для чтения)
Наверх
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.