ViewerConfig
Параметри віджета переглядача клієнта
ViewerConfig (namespace Doconut) описує вигляд та поведінку переглядача в браузері. Це не впливає на якість рендерингу документа; для цього використовуйте конфігурацію формату. Клас C# та давно існуючий JavaScript віджет мають різні значення за замовчуванням, тому явно зіставляйте значення.
Дві зміни на боці клієнта в цьому випуску не повідомляються про помилки.
Функції-обробники передаються як параметри — віджет більше не отримує свої зворотні виклики подій з ідентифікатора контейнера — іResPathмає вказувати на префікс ресурсів, а не на корінь застосунку.
Обидва залишають сервер працювати бездоганно і не повідомляють нічого в консолі браузера.
Якщо ви переносите сторінку з попередньої бібліотеки, прочитайте Зворотні виклики та Перевірка шляхів перед усім іншим.
Властивості C#
| Тип | Властивість | За замовчуванням | Опис |
|---|---|---|---|
bool | ShowThumbs | true | Показати панель мініатюр. |
bool | AutoLoad | false | Автоматично завантажувати після ініціалізації. Звичайний потік токенів явно викликає View(token). |
bool | AutoFocus | true | Перемістити фокус/прокрутку браузера до переглядача під час ініціалізації. |
bool | AutoPageFocus | true | Зберігати поточну мініатюру видимою під час зміни сторінок. |
int | PageZoom | 100 | Початковий відсоток масштабування. |
int | ZoomStep | 10 | Відсоток, який додається або віднімається командами масштабування. |
int | MaxZoom | 300 | Максимальний відсоток масштабування. |
bool | ShowToolTip | true | Показувати підказку позиції сторінки під час прокрутки. |
string | ToolTipPageText | "Page " | Префікс, що використовується у підказці сторінки. |
bool | CacheEnabled | false | Зберігати рухоме вікно зображень сторінок у пам'яті браузера. Не використовує localStorage. |
bool | LargeDoc | false | Додавати елементи сторінок пакетами у часі для великих документів. |
bool | ShowHyperlinks | false | Відображати накладки гіперпосилань, коли серверна конфігурація їх витягнула. |
bool | FixedZoom | true | Використовувати фіксований відсоток масштабування замість адаптивного перерахунку. |
int | FixedZoomPercent | 100 | Фіксоване масштабування для десктопу. |
int | FixedZoomPercentMobile | 75 | Фіксоване масштабування для мобільних. |
string | BasePath | "/" | Куди переглядач надсилає запити сторінок. "/" є DocImage.axd у корені сайту; інакше гілка, де хост відображає UseDoconut(), без початкового / ("doconut" означає /doconut/DocImage.axd). |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" before) | Тека, з якої віджет завантажує власні зображення: тека images під ResourcesPath, без початкового /. |
string | FitType | "width" | "width", "height" або порожнє значення для відсутності автоматичного підгонювання. "page" не приймається поточним віджетом. |
bool | RetryOn409 | false | Увімкнути опитування, коли асинхронне/розподілене створення сторінок відповідає 202 Accepted; також приймається 409 для сумісності зі старими серверами. Не потрібно для звичайного синхронного переглядача. |
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // без початкового '/' : переглядач додає його ("/doconut" стане //doconut, інший хост)
ResPath = "doconut-res/images",
ShowHyperlinks = true
};Відображення C# у JavaScript
Не передавайте безпосередньо серіалізований ViewerConfig у docViewer(...). Більшість ключів віджета записані у camelCase, тоді як три встановлених ключі шляху/підгонки — у PascalCase.
| C# | JavaScript |
|---|---|
ShowThumbs | showThumbs |
AutoLoad | autoLoad |
AutoFocus | autoFocus |
AutoPageFocus | autoPageFocus |
PageZoom | pageZoom |
ZoomStep | zoomStep |
MaxZoom | maxZoom |
ShowToolTip | showToolTip |
ToolTipPageText | toolTipPageText |
CacheEnabled | cacheEnabled |
LargeDoc | largeDoc |
ShowHyperlinks | showHyperlinks |
FixedZoom | fixedZoom |
FixedZoomPercent | fixedZoomPercent |
FixedZoomPercentMobile | fixedZoomPercentMobile |
BasePath | BasePath |
ResPath | ResPath |
FitType | FitType |
RetryOn409 | retryOn409 |
Типові значення JavaScript
Віджет має старі типові значення, які відрізняються від класу C#. Наступні значення походять з поточної реалізації docViewer.js.
| Параметр | Типове | Примітки |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | Межі ширини панелі мініатюр. |
showThumbs | true | Початкова видимість мініатюр. |
autoFocus / autoPageFocus | true / false | autoPageFocus відрізняється від типового значення C#. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Геометрія мініатюр у пікселях. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom відрізняється від C# (300). |
showToolTip / toolTipPageText | true / "Page " | Підказка позиції сторінки. |
format / doc / AccessToken | "" / 0 / "" | Внутрішні значення ініціалізації; зазвичай заповнюються View(token). |
debugMode | false | Додаткова діагностика клієнта. |
FitType | "" | Немає автоматичного підгонки, якщо не вказано. |
BasePath | "DocImage.axd" | Історичне типове значення клієнта збережено для сумісності. Поточні хости ASP.NET Core повинні явно встановити його у відповідну гілку middleware. |
ResPath | "" | Встановлюється явно до шляху вбудованих зображень. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | Вікно та затримка попереднього завантаження сторінок у пам'яті. |
autoLoad | false | Рекомендується явний потік токенів. |
largeDoc | true | Відрізняється від типового значення C#. |
fixedZoom | false | Відрізняється від типового значення C#. |
fixedZoomPercent / fixedZoomPercentMobile | 100 / 50 | Мобільне значення відрізняється від C# (75). |
showHyperlinks | true | Потрібне серверне вилучення для створення накладок. |
Встановіть усі важливі з точки зору поведінки значення замість того, щоб покладатися на будь-який набір типових значень:
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>
<script>
const objViewer = $('#div_ctlDoc').docViewer({
showThumbs: true,
autoLoad: false,
autoFocus: true,
autoPageFocus: true,
pageZoom: 100,
zoomStep: 10,
maxZoom: 300,
FitType: 'width',
cacheEnabled: false,
largeDoc: false,
showHyperlinks: true,
fixedZoom: true,
fixedZoomPercent: 100,
fixedZoomPercentMobile: 75,
BasePath: 'doconut',
ResPath: 'doconut-res/images',
onViewerReady: function () {},
onError: function (message) { console.error('DocViewer:', message); }
});
</script>Зворотні виклики
| Зворотний виклик | Аргументи | Призначення |
|---|---|---|
onPageLoading | pageNum | Запит на сторінку починається. |
onPageLoaded | pageNum | Зображення сторінки завершило завантаження. |
onThumbnailClicked | pageNum | Користувач вибрав мініатюру. |
onPageClicked | pageNum | Користувач вибрав сторінку. |
onDoubleClick | none | Переглядач отримав подвійне клацання. |
onViewerBusy | none | Переглядач перейшов у зайнятий стан. |
onViewerReady | none | Ініціалізація завершена. |
onViewerError | none | Переглядач перейшов у стан помилки. |
onError | message | Операція повернула повідомлення про помилку. |
onCopy | data | Доступні дані копіювання тексту. |
onAutoLoadStatus | pageNum | Автозавантаження перейшло до сторінки. |
onThumbsShown | none | Панель мініатюр стала видимою. |
onAnnLoaded | none | Дані анотацій завантажено. |
onAnnSaved | none | Дані анотацій збережено. |
onAnnSaveError | none | Не вдалося зберегти анотації. |
onAnnClosed | none | Інтерфейс анотацій закрито. |
Тримайте зворотні виклики швидкими; надсилайте телеметрію асинхронно і не блокуйте рендеринг сторінки.
Кожен з них — це параметр у об’єкті ініціалізації. Попередній переглядач шукав глобальні функції, імена яких він отримував з ідентифікатора контейнера — сторінка з <div id="div_ctlDoc"> лише мала оголосити function ctlDoc_OnViewerReady(). Це пошук більше не використовується. Передайте функцію явно:
function ctlDoc_OnViewerBusy() { /* показати індикатор зайнятості */ }
function ctlDoc_OnViewerReady() { /* приховати його */ }
function ctlDoc_Copy(text) { /* використати скопійований текст */ }
function ctlDoc_AutoLoadStatus(pageNum) { /* повідомити про прогрес */ }
const objViewer = $('#div_ctlDoc').docViewer({
// ... ваші існуючі параметри ...
onViewerBusy: ctlDoc_OnViewerBusy, // було знайдено за назвою
onViewerReady: ctlDoc_OnViewerReady, // було знайдено за назвою
onCopy: ctlDoc_Copy, // було ctlDoc_Copy(text)
onAutoLoadStatus: ctlDoc_AutoLoadStatus // було ctlDoc_AutoLoadStatus(page)
});Старий пошук був обгорнутий у порожній catch, тому нічого не повідомлялося. У цьому випуску функції просто не виконуються: звичний симптом — індикатор зайнятості, який не зупиняється, бо обробник, який його приховував, був onViewerReady. Документ за ним рендериться правильно.
Два гачки збереження анотацій все ще шукаються за іменем: SaveAnnotations() викликає <elementId>_BeforeAnnSave() і <elementId>_DeletedAnnotationIds(), якщо вони існують, використовуючи повний id елемента (div_ctlDoc_BeforeAnnSave для наведеного вище прикладу).
Немає зворотного виклику на клік посилання — обробка гіперпосилань вбудована і керується showHyperlinks.
Групи публічних методів
| Група | Загальні методи |
|---|---|
| Життєвий цикл | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| Навігація | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| Масштабування та підгонка | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| Орієнтація | Rotate(page, angle), Flip(page, flipType) |
| Мініатюри | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| Пошук | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| Анотація | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| Копіювання | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
Файл JavaScript також містить внутрішні допоміжні функції. Вважаються стабільними точками інтеграції лише методи, що використовуються референтним інтерфейсом і задокументовані тут або у посібниках щодо функцій.
Повторна спроба, доки розподілена сторінка ще рендериться
retryOn409 зберігає свою історичну назву. Він призначений для асинхронного створення сторінок і повторює поточну відповідь готовності 202 Accepted, а також старіший сигнал 409 Conflict. Коли ввімкнено, віджет опитує з цими типово JavaScript параметрами:
| Параметр | За замовчуванням |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Залиште його вимкненим для звичайного одно‑вузлового переглядача. Увімкнення не може перетворити непідтримуваний синхронний рендер у асинхронний.
Увімкніть його, коли сторінки подаються зі спільного сховища за допомогою FirstPagePriority, де пізніші сторінки законно відповідають 202 Accepted, доки не будуть записані. Клієнт, який не повторює спробу, показує пошкоджені плитки для сторінок, що ще рендеряться — дивіться Розподілені розгортання.
Перелік перевірки шляху
DoconutOptions.MiddlewarePathмає описувати гілку, яку ви фактично мапуєте.BasePathмає вказувати цю гілку, записану без початкового/('doconut', а не'/doconut': переглядач додає слеш, і//doconut/...— це запит до іншого хоста). Типове налаштування зберігає історичну форму запитуDocImage.axdна гілціMapWhenі тому встановлюєBasePath: '/'.DoconutOptions.ResourcesPath— це маршрут вбудованих ресурсів.ResPathзазвичай вказує на його підпапкуimages, без початкового/—'doconut-res/images'з типовим префіксом. ПорожнійResPathбув правильним у попередній бібліотеці, де ресурси бралися з кореня застосунку; тут це неправильно, і призводить до збою без повідомлення про помилку.ExtractHyperlinksмає бути ввімкнено у конфігурації формату сервера, перш ніжshowHyperlinksзможе щось відобразити.
Чи була ця сторінка корисною?