ViewerConfig

אפשרויות וידג'ט תצוגת לקוח

ViewerConfig (namespace Doconut) מתאר את המראה וההתנהגות של תצוגת הדפדפן. הוא אינו משפיע על איכות רינדור המסמך; השתמש בתצורת פורמט לכך. למחלקת C# והפלאגין הישן של JavaScript יש ערכי ברירת מחדל שונים, ולכן יש למפות ערכים במפורש.

מאפייני C#

סוגמאפייןברירת מחדלתיאור
boolShowThumbstrueהצג את לוח התמונות הממוזערות.
boolAutoLoadfalseטען אוטומטית לאחר האתחול. זרימת האסימונים הרגילה קוראת ל-View(token) במפורש.
boolAutoFocustrueהזז את המיקוד/גלילה של הדפדפן אל התצוגה במהלך האתחול.
boolAutoPageFocustrueשמור על התמונה הממוזערת הנוכחית גלויה בזמן שהדפים משתנים.
intPageZoom100אחוז זום ראשוני.
intZoomStep10אחוז שנוסף או מוסר על ידי פקודות זום.
intMaxZoom300אחוז זום מרבי.
boolShowToolTiptrueהצג את תיבת העזרה של מיקום העמוד בזמן גלילה.
stringToolTipPageText"Page "קידומת המשמשת בתיבת העזרה של העמוד.
boolCacheEnabledfalseשמור חלון נע של תמונות דף בזיכרון הדפדפן. הוא אינו משתמש ב-localStorage.
boolLargeDocfalseהוסף אלמנטים של דפים בקבוצות מתוזמנות עבור מסמכים גדולים.
boolShowHyperlinksfalseהצג שכבות קישורים כאשר תצורת השרת חילצה אותן.
boolFixedZoomtrueהשתמש באחוז זום קבוע במקום חישוב רספונסיבי.
intFixedZoomPercent100זום קבוע למחשב שולחני.
intFixedZoomPercentMobile75זום קבוע למובייל.
stringBasePath"/"היכן שהתצוגה שולחת בקשות דף. "/" הוא DocImage.axd בשורש האתר; אחרת הסניף שבו המארח ממפה את UseDoconut(), בלי / מוביל ("doconut" משמעותו /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" לפני)תיקייה שהוידג'ט טוען ממנה את התמונות שלו: תיקיית images תחת ResourcesPath, בלי / מוביל.
stringFitType"width""width", "height", או ריק ללא התאמה אוטומטית. "page" אינו מתקבל על ידי הוידג'ט הנוכחי.
boolRetryOn409falseאפשר סקר כאשר ייצור דפים אסינכרוני/מבוזר מגיב 202 Accepted; 409 גם הוא מתקבל לתאימות עם שרתים ישנים יותר. לא נדרש על ידי הצופה הסינכרוני הרגיל.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // אין '/' מוביל: הצופה מוסיף אותו ("/doconut" יהפוך ל-//doconut, מארח אחר)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

מיפוי C# ל-JavaScript

אל תעביר ViewerConfig שמסודר ישירות ל-docViewer(...). רוב מפתחות הווידג'ט הם camelCase, בעוד שלושה מפתחות נתיב/התאמה מבוססים הם PascalCase.

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

ברירות מחדל של JavaScript

הווידג׳ט מכיל ברירות מחדל ישנות השונות מהמחלקה ב‑C#. הערכים הבאים נלקחים מיישום ה‑docViewer.js הנוכחי.

אפשרותברירת מחדלהערות
leftMinWidth / leftMaxWidth220 / 800גבולות רוחב חלונית התמונות הממוזערות.
showThumbstrueנראות ראשונית של תמונה ממוזערת.
autoFocus / autoPageFocustrue / falseautoPageFocus שונה מברירת המחדל של C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10גאומטריית תמונות ממוזערות בפיקסלים.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom שונה מ‑C# (300).
showToolTip / toolTipPageTexttrue / "Page "תיאור מקף מיקום העמוד.
format / doc / AccessToken"" / 0 / ""ערכי אתחול פנימיים; בדרך כלל ממולאים על ידי View(token).
debugModefalseאבחונים נוספים של הלקוח.
FitType""אין התאמה אוטומטית אלא אם סופק.
BasePath"DocImage.axd"ברירת מחדל של מטפל ישן. יש להגדיר במפורש עבור ASP.NET Core.
ResPath""הגדר במפורש לנתיב התמונות המשובצות.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3חלון טעינה מוקדמת של דפים בזיכרון ועיכוב.
autoLoadfalseמומלץ זרימת אסימון מפורשת.
largeDoctrueשונה מברירת המחדל של C#.
fixedZoomfalseשונה מברירת המחדל של C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50ערך נייד שונה מ‑C# (75).
showHyperlinkstrueדורש חילוץ בצד השרת ליצירת שכבות.

הגדר את כל הערכים החשובים להתנהגות במקום להסתמך על אחד משני סטים של ברירות מחדל:

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>

קריאות חוזרות

קריאה חוזרתארגומנטיםמטרה
onPageLoadingpageNumמתחילה בקשת דף.
onPageLoadedpageNumתמונת דף הסתיימה בטעינה.
onThumbnailClickedpageNumהמשתמש בחר תמונה ממוזערת.
onPageClickedpageNumהמשתמש בחר דף.
onDoubleClicknoneהצופה קיבל לחיצה כפולה.
onViewerBusynoneהצופה נכנס למצב עסוק.
onViewerReadynoneהאתחול הושלם.
onViewerErrornoneהצופה נכנס למצב שגיאה.
onErrormessageפעולה החזירה הודעת שגיאה.
onCopydataנתוני העתקת טקסט זמינים.
onAutoLoadStatuspageNumטעינה אוטומטית התקדמה לדף.
onThumbsShownnoneפאנל התמונות הממוזערות הפך גלוי.
onAnnLoadednoneנתוני ההערות נטענו.
onAnnSavednoneנתוני ההערות נשמרו.
onAnnSaveErrornoneשמירת ההערות נכשלה.
onAnnClosednoneממשק ההערות נסגר.

שמור על קריאות חוזרות מהירות; שלח טלמטריה באופן אסינכרוני ואל תחסום את רינדור העמוד.

קבוצות שיטות ציבוריות

קבוצהשיטות משותפות
מחזור חייםView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
ניווטGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
זום והתאמהZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
כיווןRotate(page, angle), Flip(page, flipType)
תמונות ממוזערותHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
חיפושCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
הערותSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
העתקהCopy(...), CopyPage(pageNumber), CopyMode(enabled)

קובץ ה‑JavaScript מכיל גם עוזרים פנימיים. יש להתייחס רק לשיטות המשמשות את ממשק המשתמש הרפרנס והמתועדות כאן או במדריכי הפיצ'רים כנקודות אינטגרציה יציבות.

נסה מחדש בזמן שדף מבוזר עדיין מציג

retryOn409 שומר על שמו ההיסטורי. הוא מיועד לייצור דפים אסינכרוני ומבצע ניסיון חוזר לתגובה של מוכנות 202 Accepted הנוכחית וכן לאות 409 Conflict הישנה. כאשר הוא מופעל, הווידג'ט עושה פולינג עם ברירות המחדל של JavaScript אלו:

אפשרותברירת מחדל
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

השאר אותו מושבת עבור הצופה הרגיל. הפעלתו לא יכולה להפוך רינדור סינכרוני לא נתמך לאסינכרוני.

רשימת בדיקת נתיב

  • DoconutOptions.MiddlewarePath חייב לתאר את הסניף שאתה למעשה ממפה.
  • BasePath חייב למקד את הסניף הזה, נכתב ללא / מוביל ('doconut', ולא '/doconut': הצופה מוסיף את הקו המפריד, ו-//doconut/... הוא בקשה למארח אחר).
  • DoconutOptions.ResourcesPath הוא נתיב המשאב המוטמע.
  • ResPath בדרך כלל מכוון לתת-תיקייה של images, גם ללא / מוביל ('doconut-res/images').
  • ExtractHyperlinks חייב להיות מופעל בתצורת פורמט השרת לפני ש-showHyperlinks יכול להציג משהו.

האם דף זה היה מועיל?