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 olay geri aramalarını konteyner kimliğinden türetmez —
ve ResPath uygulama kökü yerine kaynak önekine işaret etmelidir.
Her ikisi de sunucunun mükemmel çalışmasını sağlar ve tarayıcı konsolunda hiçbir şey raporlamaz.
Eğer önceki kütüphaneden bir sayfayı taşıyorsanız, okuyun
Geri Aramalar ve Yol kontrol listesi her şeyden önce.

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/scrollunu 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ış toplu ekle.
boolShowHyperlinksfalseSunucu yapılandırması onları çı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'dır; aksi takdirde hostun 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ında images klasörü, başında / olmadan.
stringFitType"width""width", "height", ya da 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 eski sunucularla uyumluluk için de 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 '/' : görüntüleyici ekler ("/doconut" //doconut olur, başka bir host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C#'den JavaScript'e eşleme

Doğrudan serileştirilmiş bir ViewerConfig'ı docViewer(...)'a geçirmeyin. Çoğu widget anahtarı camelCase iken, üç yerleşik yol/uyum anahtarı PascalCase'dir.

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şliği sınırları.
showThumbstrueİlk küçük resim görünürlüğü.
autoFocus / autoPageFocustrue / falseautoPageFocus C# varsayılanından farklıdır.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Piksel cinsinden küçük resim geometrisi.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom C# (300) ile farklıdır.
showToolTip / toolTipPageTexttrue / "Page "Sayfa konumu araç ipucu.
format / doc / AccessToken"" / 0 / ""Dahili başlatma değerleri; genellikle View(token) tarafından doldurulur.
debugModefalseEk istemci tanılamaları.
FitType""Sağlanmadıkça otomatik uyum yok.
BasePath"DocImage.axd"Uyumluluk için tarihsel istemci varsayılanı korundu. Mevcut ASP.NET Core barındırıcıları, bunu açıkça eşlenmiş ara katman dalına ayarlamalıdır.
ResPath""Gömülü resim yoluna 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) ile farklıdır.
showHyperlinkstrueÜst katmanlar üretmek için sunucu tarafı çıkarımı gerekir.

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

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 resim seçti.
onPageClickedpageNumKullanıcı bir sayfa seçti.
onDoubleClicknoneGörüntüleyici ç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 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, konteyner kimliğinden türettiği global fonksiyonları arardı — <div id="div_ctlDoc"> içeren bir sayfa sadece function ctlDoc_OnViewerReady() tanımlamalıydı. O arama artık yok. Fonksiyonu açıkça geçirin:

javascript
function ctlDoc_OnViewerBusy() { /* meşgul göstergenizi göster */ }
function ctlDoc_OnViewerReady() { /* gizle */ }
function ctlDoc_Copy(text) { /* kopyalanan metni kullan */ }
function ctlDoc_AutoLoadStatus(pageNum) { /* ilerlemeyi raporla */ }

const objViewer = $('#div_ctlDoc').docViewer({
    // ... mevcut seçenekleriniz ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // isimle bulundu
    onViewerReady:    ctlDoc_OnViewerReady,     // isimle bulundu
    onCopy:           ctlDoc_Copy,              // idi ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // idi ctlDoc_AutoLoadStatus(page)
});

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ışmaz: yaygın semptom, hiç durmayan bir meşgul döndürücüdür, çünkü onu gizleyen işleyici onViewerReady idi. Onun arkasındaki belge doğru şekilde renderlanıyor.

İki açıklama-kaydet kancası hâlâ isimle aranıyor: SaveAnnotations(), mevcut olduğunda <elementId>_BeforeAnnSave() ve <elementId>_DeletedAnnotationIds() çağırır, öğenin tam kimliğini (div_ctlDoc_BeforeAnnSave örnek için) kullanarak.

Bağlantı tıklama geri çağrısı yoktur — hiperlink işleme yerleşiktir 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 da içerir. Yalnızca referans UI tarafından kullanılan ve burada ya da özellik kılavuzlarında belgelenen yöntemleri, kararlı entegrasyon noktaları olarak ele alın.

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 ayrıca eski 409 Conflict sinyalini yeniden dener. Etkinleştirildiğinde, widget bu JavaScript varsayılanlarıyla sorgular:

SeçenekVarsayılan
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

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.

FirstPagePriority ile paylaşılan depolamadan sayfalar sunulduğunda, sonraki sayfalar yazılana kadar meşru olarak 202 Accepted yanıt verirken bunu etkinleştirin. Yeniden denemeyen bir istemci, hâlâ işlenen sayfalar için bozuk döşemeler gösterir — bkz. Dağıtılmış Dağıtımlar.

Yol kontrol listesi

  • DoconutOptions.MiddlewarePath, gerçekten eşlediğiniz dalı tanımlamalıdır.
  • BasePath, o dalı hedeflemeli ve 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). Yaygın bir yapı, tarihsel DocImage.axd istek şeklini bir MapWhen dalında korur ve bu nedenle BasePath: '/' ayarlar.
  • DoconutOptions.ResourcesPath, gömülü kaynak yoludur.
  • ResPath genellikle 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 herhangi bir şey gösterebilmeye başlamadan önce sunucu format yapılandırmasında etkinleştirilmelidir.

Bu sayfa yardımcı oldu mu?