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ı açıklar. Belge render kalitesini etkilemez; bunun için bir format yapılandırması kullanın. C# sınıfı ve eski JavaScript eklentisi farklı varsayılanlara sahiptir, bu yüzden değerleri açıkça eşleyin.

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ış partiler halinde ekle.
boolShowHyperlinksfalseSunucu yapılandırması bunları çıkardığında hiperlink bindirmelerini render et.
boolFixedZoomtrueYanıt veren yeniden hesaplamadan ziyade 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 ana bilgisayarın UseDoconut()'ı eşlediği dal, başında / bulunmayan ("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 / bulunmayan.
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; eski sunucularla uyumluluk için 409 da 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 bunu ekler ("/doconut" //doconut olur, başka bir ana bilgisayar)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C#'tan 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 sığdırma yok.
BasePath"DocImage.axd"Eski işleyici varsayılanı. ASP.NET Core için açıkça ayarlayın.
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) ile farklıdır.
showHyperlinkstrueÜst katmanlar üretmek için sunucu tarafı çıkarımı gerekir.

Her iki varsayılan kümesine güvenmek yerine davranışsal olarak önemli tüm 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 resmi seçti.
onPageClickedpageNumKullanıcı bir sayfa seçti.
onDoubleClicknoneGörüntüleyici çift tıklama aldı.
onViewerBusynoneGörüntüleyici meşgul durumuna 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.

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ı entegrasyon 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 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 görüntüleyici için devre dışı bırakın. Etkinleştirmek, desteklenmeyen senkron bir render'ı asenkron hâle getiremez.

Yol kontrol listesi

  • DoconutOptions.MiddlewarePath, gerçekten eşlediğiniz dalı tanımlamalıdır.
  • BasePath, o dalı hedeflemelidir, başında / olmadan yazılmış olarak ('doconut', '/doconut' değil: görüntüleyici eğik çizgiyi ekler ve //doconut/... başka bir ana bilgisayara istek anlamına gelir).
  • DoconutOptions.ResourcesPath, gömülü kaynak yoludur.
  • ResPath genellikle images alt klasörünü hedefler, aynı şekilde başında / olmadan ('doconut-res/images').
  • ExtractHyperlinks, showHyperlinks herhangi bir şey gösterebilmeden önce sunucu format yapılandırmasında etkinleştirilmelidir.

Bu sayfa yardımcı oldu mu?