ViewerConfig

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

Dwie zmiany po stronie klienta w tym wydaniu nie wyświetlają błędów. Funkcje obsługi są przekazywane jako opcje — widżet nie wyciąga już globalnych nazw funkcji z identyfikatora kontenera — oraz ResPath musi wskazywać prefiks zasobów, a nie korzeń aplikacji. Oba elementy pozostawiają serwer w pełni sprawnym i nie zgłaszają nic w konsoli przeglądarki. Jeśli przenosisz stronę z poprzedniej biblioteki, przeczytaj Wywołania zwrotne i Lista kontrolna ścieżek przed czymkolwiek innym.

Właściwości C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

Mapowanie C# → JavaScript

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

Domyślne wartości JavaScript

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

Ustaw wszystkie istotne wartości zamiast polegać na którekolwiek z zestawów domyślnych:

<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 krótkie; wysyłaj telemetrykę asynchronicznie i nie blokuj renderowania stron.

Każde z nich jest opcją w obiekcie inicjalizacyjnym. Poprzedni widok wyszukiwał globalne funkcje, których nazwy wyprowadzano z identyfikatora kontenera — strona z <div id="div_ctlDoc"> musiała zadeklarować function ctlDoc_OnViewerReady(). To wyszukiwanie zostało usunięte. Przekaż funkcję explicite:

objctlDoc = $('#div_ctlDoc').docViewer({
    // ... twoje istniejące opcje ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // było znajdowane po nazwie
    onViewerReady:    ctlDoc_OnViewerReady,     // było znajdowane po nazwie
    onCopy:           ctlDoc_Copy,              // było ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // było ctlDoc_AutoLoadStatus(page)
});

Stare wyszukiwanie było owinięte pustym catch, więc nic nigdy nie było zgłaszane. W tym wydaniu funkcje po prostu nigdy się nie uruchamiają: typowym objawem jest wirujący wskaźnik zajętości, który nie znika, ponieważ obsługa go ukrywająca (onViewerReady) nie została wywołana. Dokument za nim renderuje się poprawnie.

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

Grupy metod publicznych

Plik JavaScript zawiera także wewnętrzne pomocniki. Traktuj jako stabilne jedynie metody używane w interfejsie referencyjnym i udokumentowane tutaj lub w przewodnikach funkcji.

Ponowne próby, gdy rozproszona strona nadal jest renderowana

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

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

Włącz, gdy strony są serwowane z współdzielonego magazynu z FirstPagePriority, gdzie późniejsze strony rzeczywiście odpowiadają 202 Accepted, dopóki nie zostaną zapisane. Klient, który nie ponawia, pokazuje uszkodzone kafelki dla wciąż renderujących się stron — zobacz Rozproszone wdrożenia.

Lista kontrolna ścieżek

• DoconutOptions.MiddlewarePath musi opisywać gałąź, którą faktycznie mapujesz.
• BasePath musi wskazywać tę gałąź. Aplikacja referencyjna zachowuje historyczną formę żądania DocImage.axd na gałęzi MapWhen i dlatego ustawia BasePath: '/'.
• DoconutOptions.ResourcesPath to wbudowana trasa zasobów.
• ResPath zazwyczaj wskazuje podfolder /images — 'doconut-res/images' przy domyślnym prefiksie. Pusty ResPath był prawidłowy w poprzedniej bibliotece, gdzie zasoby pochodziły z korzenia aplikacji; tutaj nie jest prawidłowy i powoduje błąd bez komunikatu.
• ExtractHyperlinks musi być włączone w konfiguracji formatu serwera, zanim showHyperlinks będzie mógł coś wyświetlić.