ViewerConfig
Опції віджету переглядача клієнта
ViewerConfig (namespace Doconut) описує зовнішній вигляд та поведінку браузерного переглядача. Це не впливає на якість відображення документу; використовуйте конфігурацію формату для цього. Клас C# та застарілий плагін JavaScript мають різні типові значення, тому явно зіставляйте їх.
Властивості 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. |
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 | Інтерфейс анотації закрито. |
Тримайте зворотні виклики швидкими; надсилайте телеметрію асинхронно і не блокуйте рендеринг сторінки.
Групи публічних методів
| Група | Загальні методи |
|---|---|
| Життєвий цикл | 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 також містить внутрішні допоміжні функції. Вважаючи стабільними точками інтеграції, розглядайте лише методи, які використовуються референтним інтерфейсом та задокументовані тут або у посібниках з функціоналу.
Retry while a distributed page is still rendering
retryOn409 зберігає свою історичну назву. Він призначений для асинхронного створення сторінок і повторює поточну відповідь готовності 202 Accepted, а також старіший сигнал 409 Conflict. При увімкненні віджет опитує з цими стандартними параметрами JavaScript:
| Опція | За замовчуванням |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Leave it disabled for the normal viewer. Enabling it cannot make an unsupported synchronous render asynchronous.
Path checklist
DoconutOptions.MiddlewarePathмає описувати гілку, яку ви фактично мапите.BasePathмає вказувати цю гілку, записану без початкового/('doconut', а не'/doconut': переглядач додає слеш, і//doconut/...є запитом до іншого хоста).DoconutOptions.ResourcesPath— це маршрут вбудованого ресурсу.ResPathзазвичай вказує на його підпапкуimages, також без початкового/('doconut-res/images').ExtractHyperlinksмає бути ввімкнено у конфігурації формату сервера, перш ніжshowHyperlinksзможе щось відображати.
Чи була ця сторінка корисною?