ViewerConfig

ViewerConfig (namespace Doconut) opisuje wygląd i zachowanie przeglądarki w przeglądarce. Nie wpływa na jakość renderowania dokumentu; do tego użyj konfiguracji formatu. Klasa C# i długo istniejący widget JavaScript mają różne wartości domyślne, więc mapuj wartości explicite.

Dwie zmiany po stronie klienta w tej wersji nie wywołują błędów. Funkcje obsługi są przekazywane jako opcje — widget już nie wyprowadza globalnych nazw funkcji z identyfikatora kontenera — oraz ResPath musi wskazywać prefiks zasobów, a nie korzeń aplikacji. Obie pozostawiają serwer w pełni sprawnym i nie zgłaszają nic w konsoli przeglądarki. Jeśli przenosisz stronę z poprzedniej biblioteki, przeczytaj Callbacks i Path checklist przed czymkolwiek innym.

Właściwości C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // brak początkowego '/': przeglądarka dodaje go ("/doconut" stałoby się //doconut, inny host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

Mapowanie C# na JavaScript

Nie przekazuj bezpośrednio zserializowanego ViewerConfig do docViewer(...). Większość kluczy widgetu jest w camelCase, podczas gdy trzy ustalone klucze ścieżki/dopasowania są w PascalCase.

Domyślne ustawienia JavaScript

Widżet ma starsze wartości domyślne, które różnią się od klasy C#. Poniższe wartości pochodzą z bieżącej implementacji docViewer.js.

Ustaw wszystkie wartości istotne pod względem zachowania zamiast polegać na którejkolwiek z domyślnych konfiguracji:

<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>

Wywołania zwrotne

Utrzymuj wywołania zwrotne szybkie; wysyłaj telemetrykę asynchronicznie i nie blokuj renderowania strony.

Każde z nich jest opcją w obiekcie inicjalizacyjnym. Poprzedni podgląd wyszukiwał globalne funkcje, których nazwy wyprowadzał z identyfikatora kontenera — strona z <div id="div_ctlDoc"> musiała jedynie zadeklarować function ctlDoc_OnViewerReady(). To wyszukiwanie zniknęło. Przekaż funkcję wyraźnie:

objctlDoc = $('#div_ctlDoc').docViewer({
    // ... your existing options ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // was found by name
    onViewerReady:    ctlDoc_OnViewerReady,     // was found by name
    onCopy:           ctlDoc_Copy,              // was ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // was ctlDoc_AutoLoadStatus(page)
});

Stare wyszukiwanie było owinięte w pusty catch, więc nic nie było zgłaszane. W tej wersji funkcje po prostu nigdy się nie wykonują: typowy objaw to nieustannie obracający się wskaźnik zajętości, ponieważ obsługa, która go ukrywała, była onViewerReady. Dokument za nim renderuje się prawidłowo.

Nie ma wywołania zwrotnego przy kliknięciu linku — obsługa hiperłączy jest wbudowana i sterowana przez showHyperlinks.

Publiczne grupy metod

Plik JavaScript zawiera również wewnętrzne pomocnicze funkcje. Traktuj wyłącznie metody używane przez referencyjny interfejs użytkownika i udokumentowane tutaj lub w przewodnikach funkcji jako stabilne punkty integracji.

Ponawianie, gdy rozproszona strona nadal jest renderowana

retryOn409 zachowuje swoją historyczną nazwę. Służy do asynchronicznej produkcji stron i ponawia bieżącą odpowiedź gotowości 202 Accepted oraz starszy sygnał 409 Conflict. Po włączeniu widget odpyta z tymi domyślnymi wartościami JavaScript:

Pozostaw wyłączone dla standardowego jednowęzłowego podglądu. Włączenie nie może uczynić nieobsługiwanego renderowania synchronicznego asynchronicznym.

Włącz go, gdy strony są serwowane z udostępnionego magazynu przy użyciu FirstPagePriority, gdzie późniejsze strony prawidłowo zwracają 202 Accepted, dopóki nie zostaną zapisane. Klient, który nie ponawia, wyświetla uszkodzone kafelki dla stron nadal renderowanych — zobacz Rozproszone wdrożenia.

Lista kontrolna ścieżek

• DoconutOptions.MiddlewarePath musi opisywać gałąź, którą faktycznie mapujesz.
• BasePath musi wskazywać tę gałąź, zapisaną bez początkowego / ('doconut', a nie '/doconut': podgląd dodaje ukośnik, a //doconut/... jest żądaniem do innego hosta). Aplikacja referencyjna zachowuje historyczny kształt żądania DocImage.axd na gałęzi MapWhen i dlatego ustawia BasePath: '/'.
• DoconutOptions.ResourcesPath jest trasą wbudowanych zasobów.
• ResPath zazwyczaj wskazuje podfolder images, bez początkowego / — 'doconut-res/images' z domyślnym prefiksem. Pusty ResPath był poprawny w poprzedniej bibliotece, gdzie zasoby pochodziły z katalogu głównego aplikacji; nie jest prawidłowy tutaj i powoduje niepowodzenie bez błędu.
• ExtractHyperlinks musi być włączony w konfiguracji formatu serwera, zanim showHyperlinks będzie mógł wyświetlić cokolwiek.