ViewerConfig

İstemci görüntüleyici widget seçenekleri

ViewerConfig (namespace Doconut) tarayıcı görüntüleyicisinin görünüm ve davranışını tanımlar. Belge render kalitesini etkilemez; bunun için bir format yapılandırması kullanın. C# sınıfı ve uzun süredir var olan JavaScript widget farklı varsayılanlara sahiptir, bu yüzden değerleri açıkça eşleyin.

Bu sürümde iki istemci tarafı değişikliği sessizce başarısız olur. İşleyici fonksiyonları seçenek olarak geçirilir — widget artık konteyner kimliğinden global fonksiyon adları türetmez — ve ResPath uygulama kökü yerine kaynak önekine işaret etmelidir. İkisi de sunucunun sorunsuz çalışmasını sağlar ve tarayıcı konsolunda hiçbir şey raporlamaz. Önceki kütüphaneden bir sayfayı taşıyorsanız, her şeyden önce Geri Çağrılar ve Yol kontrol listesi bölümlerini okuyun.

C# özellikleri

TürÖzellikVarsayılanAçıklama
boolShowThumbstrueKüçük resim panelini göster.
boolAutoLoadfalseBaşlatmadan sonra otomatik olarak yükle. Normal token akışı View(token)'ı açıkça çağırır.
boolAutoFocustrueBaşlatma sırasında tarayıcı odak/scroll'ını görüntüleyiciye taşı.
boolAutoPageFocustrueSayfalar değişirken mevcut küçük resmi görünür tut.
intPageZoom100İlk yakınlaştırma yüzdesi.
intZoomStep10Yakınlaştırma komutlarıyla eklenen veya çıkarılan yüzde.
intMaxZoom300Maksimum yakınlaştırma yüzdesi.
boolShowToolTiptrueKaydırma sırasında sayfa konumu araç ipucunu göster.
stringToolTipPageText"Page "Sayfa araç ipucunda kullanılan önek.
boolCacheEnabledfalseTarayıcı belleğinde sayfa görüntülerinin hareketli bir penceresini tut. localStorage kullanmaz.
boolLargeDocfalseBüyük belgeler için sayfa öğelerini zamanlanmış gruplar halinde ekle.
boolShowHyperlinksfalseSunucu yapılandırması bunları çıkardığında hiperlink bindirmelerini render et.
boolFixedZoomtrueDuyarlı yeniden hesaplama yerine sabit bir yakınlaştırma yüzdesi kullan.
intFixedZoomPercent100Sabit masaüstü yakınlaştırması.
intFixedZoomPercentMobile75Sabit mobil yakınlaştırma.
stringBasePath"/"Görüntüleyicinin sayfa isteklerini gönderdiği yer. "/" site kökünde DocImage.axd'dir; aksi takdirde ana bilgisayarın UseDoconut()'ı eşlediği dal, başında / olmadan ("doconut" /doconut/DocImage.axd anlamına gelir).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" önce)Widget'in kendi görüntülerini yüklediği klasör: ResourcesPath altındaki images klasörü, başında / olmadan.
stringFitType"width""width", "height" veya otomatik uyum yoksa boş. "page" mevcut widget tarafından kabul edilmez.
boolRetryOn409falseAsenkron/dağıtık sayfa üretimi 202 Accepted yanıtı verdiğinde yoklamayı etkinleştir; 409 da eski sunucularla uyumluluk için kabul edilir. Normal senkron görüntüleyici için gerekli değildir.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // başında '/' yok: görüntüleyici ekler ("/doconut" //doconut olur, başka bir host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C#'den JavaScript'e eşleme

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

JavaScript varsayılanları

Widget, C# sınıfından farklı eski varsayılanlara sahiptir. Aşağıdaki değerler mevcut docViewer.js uygulamasından gelmektedir.

SeçenekVarsayılanNotlar
leftMinWidth / leftMaxWidth220 / 800Küçük resim bölmesi genişlik sınırları.
showThumbstrueBaşlangıçta küçük resim görünürlüğü.
autoFocus / autoPageFocustrue / falseautoPageFocus C# varsayılanından farklıdır.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Küçük resim geometrisi piksel cinsinden.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom C# (300) değerinden farklıdır.
showToolTip / toolTipPageTexttrue / "Page "Sayfa konumlu araç ipucu.
format / doc / AccessToken"" / 0 / ""İçsel başlatma değerleri; genellikle View(token) ile doldurulur.
debugModefalseEk istemci tanılamaları.
FitType""Sağlanmadıkça otomatik uyum yok.
BasePath"DocImage.axd"Uyumluluk için tutulan tarihsel istemci varsayılanı. Mevcut ASP.NET Core barındırıcıları, bunu açıkça eşlenmiş middleware dalına ayarlamalıdır.
ResPath""Gömülü resim yolu olarak açıkça ayarlayın.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Bellek içi sayfa ön yükleme penceresi ve gecikmesi.
autoLoadfalseAçık token akışı önerilir.
largeDoctrueC# varsayılanından farklıdır.
fixedZoomfalseC# varsayılanından farklıdır.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Mobil değer C# (75) değerinden farklıdır.
showHyperlinkstrueKatmanlar üretmek için sunucu tarafı çıkarımı gerekir.

Davranışsal olarak önemli tüm değerleri ayarlayın, varsayılanlardan birine güvenmek yerine:

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

Geri Çağrılar

Geri ÇağrıArgümanlarAmaç
onPageLoadingpageNumBir sayfa isteği başlıyor.
onPageLoadedpageNumBir sayfa resmi yüklenmeyi tamamladı.
onThumbnailClickedpageNumKullanıcı bir küçük resmi seçti.
onPageClickedpageNumKullanıcı bir sayfa seçti.
onDoubleClicknoneGörüntüleyici bir çift tıklama aldı.
onViewerBusynoneGörüntüleyici meşgul duruma girdi.
onViewerReadynoneBaşlatma tamamlandı.
onViewerErrornoneGörüntüleyici hata durumuna girdi.
onErrormessageBir işlem bir hata mesajı döndürdü.
onCopydataMetin kopyalama verisi mevcut.
onAutoLoadStatuspageNumOtomatik yükleme bir sayfaya ilerledi.
onThumbsShownnoneKüçük resim paneli görünür oldu.
onAnnLoadednoneAçıklama verisi yüklendi.
onAnnSavednoneAçıklama verisi kaydedildi.
onAnnSaveErrornoneAçıklama kaydetme başarısız oldu.
onAnnClosednoneAçıklama UI kapandı.

Geri çağrıları hızlı tutun; telemetrileri asenkron gönderin ve sayfa renderını engellemeyin.

Bunların her biri init nesnesindeki bir seçenektir. Önceki görüntüleyici, adını kapsayıcı kimliğinden türeten global fonksiyonları arıyordu — <div id="div_ctlDoc"> içeren bir sayfa sadece function ctlDoc_OnViewerReady() tanımlamalıydı. Bu arama artık yok. Fonksiyonu açıkça geçirin:

javascript
objctlDoc = $('#div_ctlDoc').docViewer({
    // ... mevcut seçenekleriniz ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // isimle bulunmuştu
    onViewerReady:    ctlDoc_OnViewerReady,     // isimle bulunmuştu
    onCopy:           ctlDoc_Copy,              // ctlDoc_Copy(text) idi
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // ctlDoc_AutoLoadStatus(page) idi
});

Eski arama boş bir catch içinde sarılmıştı, bu yüzden hiçbir şey raporlanmadı. Bu sürümde fonksiyonlar basitçe hiç çalışmıyor: yaygın belirti, onViewerReady tarafından gizlenen işleyici olduğu için asla durmayan bir meşgul döndürme göstergesidir. Ardındaki belge doğru şekilde renderlanıyor.

Bağlantı tıklama geri çağrısı yoktur — hiperlink işleme dahili olarak bulunur ve showHyperlinks tarafından yönlendirilir.

Genel yöntem grupları

GrupOrtak yöntemler
Yaşam DöngüsüView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
GezintiGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Yakınlaştırma ve sığdırmaZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
YönlendirmeRotate(page, angle), Flip(page, flipType)
Küçük ResimlerHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
AramaCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AçıklamaSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
KopyalaCopy(...), CopyPage(pageNumber), CopyMode(enabled)

JavaScript dosyası ayrıca dahili yardımcılar içerir. Yalnızca referans UI tarafından kullanılan ve burada ya da özellik kılavuzlarında belgelenen yöntemleri kararlı bütünleşme noktaları olarak değerlendirin.

Dağıtılmış bir sayfa hâlâ işlenirken yeniden deneme

retryOn409 tarihsel adını korur. Asenkron sayfa üretimi içindir ve mevcut 202 Accepted hazır olma yanıtını ve eski 409 Conflict sinyalini yeniden dener. Etkinleştirildiğinde, widget aşağıdaki JavaScript varsayılanlarıyla periyodik istek yapar:

SeçenekVarsayılan
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts60
retryMaxTotalMs120000

Normal tek düğüm görüntüleyici için devre dışı bırakın. Etkinleştirmek, desteklenmeyen senkron bir renderı asenkron hâle getiremez.

Sayfalar FirstPagePriority ile paylaşımlı depolamadan sunulduğunda, daha sonraki sayfalar 202 Accepted yanıtını yazılana kadar geçerli bir şekilde verir; bu durumda etkinleştirin. Yeniden denemeyen bir istemci, hâlâ işlenen sayfalar için kırık döşemeler gösterir — bkz. Dağıtık Dağıtımlar.

Yol kontrol listesi

  • DoconutOptions.MiddlewarePath gerçekten eşlediğiniz dalı tanımlamalıdır.
  • BasePath o dalı hedeflemeli, başında / olmadan yazılmalıdır ('doconut', '/doconut' değil: görüntüleyici eğik çizgiyi ekler ve //doconut/... başka bir ana bilgisayara istek olur). Referans uygulama, MapWhen dalında tarihsel DocImage.axd istek biçimini korur ve bu nedenle BasePath: '/' ayarlar.
  • DoconutOptions.ResourcesPath gömülü kaynak yoludur.
  • ResPath normalde images alt klasörünü hedefler, başında / olmadan — varsayılan önekle 'doconut-res/images'. Boş bir ResPath, kaynakların uygulama kökünden geldiği önceki kitaplıkta doğruydu; burada doğru değildir ve hata vermeden başarısız olur.
  • ExtractHyperlinks, showHyperlinks bir şey görüntüleyebilmeden önce sunucu format yapılandırmasında etkinleştirilmelidir.

Bu sayfa yardımcı oldu mu?