ViewerConfig
Možnosti widgetu klientského prohlížeče
ViewerConfig (namespace Doconut) popisuje vzhled a chování prohlížeče. Nemá vliv na kvalitu vykreslování dokumentu; pro to použijte konfigurační formát. Třída C# a dlouho etablovaný JavaScript widget mají různé výchozí hodnoty, takže hodnoty mapujte explicitně.
Dvě změny na straně klienta v tomto vydání selhávají tiše. Funkce obsluhy jsou předávány jako možnosti — widget již neodvozuje své zpětné volání událostí z ID kontejneru — a
ResPathmusí ukazovat na předponu zdrojů místo kořene aplikace. Obě ponechávají server v perfektním provozu a nehlásí nic v konzoli prohlížeče. Pokud přenášíte stránku z předchozí knihovny, přečtěte si Zpětná volání a Seznam kontrolních cest před čímkoli jiným.
Vlastnosti C#
| Typ | Vlastnost | Výchozí | Popis |
|---|---|---|---|
bool | ShowThumbs | true | Zobrazit panel miniatur. |
bool | AutoLoad | false | Automaticky načíst po inicializaci. Normální tok tokenů volá View(token) explicitně. |
bool | AutoFocus | true | Přesunout fokus/posun prohlížeče do prohlížeče během inicializace. |
bool | AutoPageFocus | true | Udržet aktuální miniaturu viditelnou při změně stránek. |
int | PageZoom | 100 | Počáteční procento přiblížení. |
int | ZoomStep | 10 | Procento přidané nebo odebrané příkazy zoomu. |
int | MaxZoom | 300 | Maximální procento přiblížení. |
bool | ShowToolTip | true | Zobrazit tooltip pozice stránky při posouvání. |
string | ToolTipPageText | "Page " | Předpona použitá v tooltipu stránky. |
bool | CacheEnabled | false | Udržovat pohyblivé okno obrázků stránek v paměti prohlížeče. Nepoužívá localStorage. |
bool | LargeDoc | false | Přidávat prvky stránky v časově řízených dávkách pro velké dokumenty. |
bool | ShowHyperlinks | false | Vykreslovat překryvy hyperodkazů, když je serverová konfigurace extrahovala. |
bool | FixedZoom | true | Použít pevné procento přiblížení místo responzivního přepočtu. |
int | FixedZoomPercent | 100 | Pevné přiblížení pro desktop. |
int | FixedZoomPercentMobile | 75 | Pevné přiblížení pro mobil. |
string | BasePath | "/" | Kam prohlížeč odesílá požadavky na stránky. "/" je DocImage.axd v kořeni webu; jinak větev, kde hostitel mapuje UseDoconut(), bez úvodního / ("doconut" znamená /doconut/DocImage.axd). |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" before) | Složka, ze které widget načítá své vlastní obrázky: složka images pod ResourcesPath, bez úvodního /. |
string | FitType | "width" | "width", "height", nebo prázdné pro žádné automatické přizpůsobení. "page" není akceptováno aktuálním widgetem. |
bool | RetryOn409 | false | Povolit polling, když asynchronní/rozptýlená výroba stránek odpovídá 202 Accepted; 409 je také akceptováno pro kompatibilitu se staršími servery. Není potřeba pro běžný synchronní prohlížeč. |
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // žádný úvodní '/' : prohlížeč jej přidá ("/doconut" by se stal //doconut, jiný host)
ResPath = "doconut-res/images",
ShowHyperlinks = true
};Mapování C# na JavaScript
Nepropusťte přímo serializovaný ViewerConfig do docViewer(...). Většina klíčů widgetu je v camelCase, zatímco tři zavedené klíče cesty/přizpůsobení jsou v 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 |
Výchozí hodnoty JavaScriptu
Widget má starší výchozí hodnoty, které se liší od třídy C#. Následující hodnoty pocházejí z aktuální implementace docViewer.js.
| Možnost | Výchozí | Poznámky |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | Meze šířky panelu miniatur. |
showThumbs | true | Počáteční viditelnost miniatur. |
autoFocus / autoPageFocus | true / false | autoPageFocus se liší od výchozí hodnoty C#. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Geometrie miniatur v pixelech. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom se liší od C# (300). |
showToolTip / toolTipPageText | true / "Page " | Tooltip umístění stránky. |
format / doc / AccessToken | "" / 0 / "" | Interní hodnoty inicializace; obvykle naplněny pomocí View(token). |
debugMode | false | Další diagnostika klienta. |
FitType | "" | Žádné automatické přizpůsobení, pokud není poskytnuto. |
BasePath | "DocImage.axd" | Historická výchozí hodnota klienta zachována pro kompatibilitu. Současní hostitelé ASP.NET Core ji musí nastavit explicitně na mapovanou větev middleware. |
ResPath | "" | Nastavte explicitně na cestu vložených obrázků. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | Okno a zpoždění přednačítání stránek v paměti. |
autoLoad | false | Doporučuje se explicitní tok tokenu. |
largeDoc | true | Liší se od výchozí hodnoty C#. |
fixedZoom | false | Liší se od výchozí hodnoty C#. |
fixedZoomPercent / fixedZoomPercentMobile | 100 / 50 | Mobilní hodnota se liší od C# (75). |
showHyperlinks | true | Vyžaduje serverovou extrakci pro vytvoření překryvů. |
Nastavte všechny behaviorálně důležité hodnoty místo spolehání se na některou sadu výchozích hodnot:
<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>Zpětné volání
| Zpětné volání | Argumenty | Účel |
|---|---|---|
onPageLoading | pageNum | Počíná požadavek na stránku. |
onPageLoaded | pageNum | Obrázek stránky se načetl. |
onThumbnailClicked | pageNum | Uživatel vybral miniaturu. |
onPageClicked | pageNum | Uživatel vybral stránku. |
onDoubleClick | none | Prohlížeč obdržel dvojklik. |
onViewerBusy | none | Prohlížeč vstoupil do zaneprázdněného stavu. |
onViewerReady | none | Inicializace dokončena. |
onViewerError | none | Prohlížeč vstoupil do chybového stavu. |
onError | message | Operace vrátila chybovou zprávu. |
onCopy | data | Data pro kopírování textu jsou k dispozici. |
onAutoLoadStatus | pageNum | Automatické načítání postoupilo na stránku. |
onThumbsShown | none | Panel miniatur se stal viditelným. |
onAnnLoaded | none | Data anotací načtena. |
onAnnSaved | none | Data anotací uložena. |
onAnnSaveError | none | Ukládání anotací selhalo. |
onAnnClosed | none | Uživatelské rozhraní anotací uzavřeno. |
Udržujte zpětná volání rychlá; odesílejte telemetrii asynchronně a neblokujte vykreslování stránky.
Každá z nich je možností v init objektu. Předchozí prohlížeč vyhledával globální funkce, jejichž názvy odvozoval od ID kontejneru — stránka s <div id="div_ctlDoc"> stačila pouze deklarovat function ctlDoc_OnViewerReady(). Toto vyhledávání zmizelo. Předávejte funkci explicitně:
function ctlDoc_OnViewerBusy() { /* zobrazte svůj indikátor zaneprázdnění */ }
function ctlDoc_OnViewerReady() { /* skryjte jej */ }
function ctlDoc_Copy(text) { /* použijte zkopírovaný text */ }
function ctlDoc_AutoLoadStatus(pageNum) { /* oznamte průběh */ }
const objViewer = $('#div_ctlDoc').docViewer({
// ... vaše existující možnosti ...
onViewerBusy: ctlDoc_OnViewerBusy, // byl nalezen podle jména
onViewerReady: ctlDoc_OnViewerReady, // byl nalezen podle jména
onCopy: ctlDoc_Copy, // was ctlDoc_Copy(text)
onAutoLoadStatus: ctlDoc_AutoLoadStatus // was ctlDoc_AutoLoadStatus(page)
});Staré vyhledávání bylo zabalené do prázdného catch, takže nic nebylo nikdy hlášeno. V tomto vydání funkce prostě neběží: typickým příznakem je neustále běžící spinner, protože obslužná rutina, která jej skrývala, byla onViewerReady. Dokument za ním se vykresluje správně.
Stále jsou dva háčky pro ukládání anotací vyhledávány podle názvu: SaveAnnotations() volá <elementId>_BeforeAnnSave() a <elementId>_DeletedAnnotationIds(), pokud existují, a používá úplné ID elementu (div_ctlDoc_BeforeAnnSave pro výše uvedený příklad).
Není žádné zpětné volání při kliknutí na odkaz — zpracování hypertextových odkazů je vestavěné a řízené pomocí showHyperlinks.
Veřejné skupiny metod
| Skupina | Společné metody |
|---|---|
| Životní cyklus | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| Navigace | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| Přiblížení a přizpůsobení | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| Orientace | Rotate(page, angle), Flip(page, flipType) |
| Náhledy | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| Vyhledávání | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| Anotace | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| Kopírování | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
Soubor JavaScript také obsahuje interní pomocníky. Považujte za stabilní integrační body pouze metody používané referenčním uživatelským rozhraním a dokumentované zde nebo v průvodcích funkcí.
Opakování, dokud je distribuovaná stránka stále vykreslována
retryOn409 si zachovává svůj historický název. Slouží k asynchronní produkci stránek a opakuje aktuální odpověď připravenosti 202 Accepted i starší signál 409 Conflict. Když je povoleno, widget provádí dotazování s těmito výchozími hodnotami JavaScriptu:
| Možnost | Výchozí |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Nechte to zakázáno pro běžného jednojádrového prohlížeče. Povolení nemůže učinit nepodporované synchronní vykreslování asynchronním.
Povolte to, když jsou stránky poskytovány ze sdíleného úložiště s FirstPagePriority, kde pozdější stránky legitimně odpovídají 202 Accepted, dokud nejsou zapsány. Klient, který neprovádí opakování, zobrazuje poškozené dlaždice pro stránky, které se stále vykreslují — viz Distribuovaná nasazení.
Kontrolní seznam cesty
DoconutOptions.MiddlewarePathmusí popisovat větev, kterou skutečně mapujete.BasePathmusí cílit na tuto větev, zapsáno bez úvodního/('doconut', ne'/doconut': prohlížeč přidá lomítko a//doconut/...je požadavek na jiný hostitel). Běžné nastavení zachovává historický tvar požadavkuDocImage.axdna větviMapWhena proto nastavujeBasePath: '/'.DoconutOptions.ResourcesPathje cesta pro vložené zdroje.ResPathnormálně cílí na jeho podadresářimages, bez úvodního/—'doconut-res/images's výchozím předponou. PrázdnýResPathbyl v předchozí knihovně správný, kde zdroje pocházely z kořene aplikace; zde to není správné a selže bez chyby.ExtractHyperlinksmusí být povoleno v konfiguraci formátu serveru, nežshowHyperlinksmůže něco zobrazit.
Byla tato stránka užitečná?