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המשתמש בחר דף.
onDoubleClickללאהצופה קיבל לחיצה כפולה.
onViewerBusyללאהצופה נכנס למצב עסוק.
onViewerReadyללאהאתחול הושלם.
onViewerErrorללאהצופה נכנס למצב שגיאה.
onErrormessageפעולה החזירה הודעת שגיאה.
onCopydataנתוני העתקת טקסט זמינים.
onAutoLoadStatuspageNumטעינה אוטומטית התקדמה לדף.
onThumbsShownללאפאנל התמונות הממוזערות הפך גלוי.
onAnnLoadedללאנתוני ההערה נטענו.
onAnnSavedללאנתוני ההערה נשמרו.
onAnnSaveErrorללאשמירת ההערה נכשלה.
onAnnClosedללאממשק ההערה נסגר.

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

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

קבוצהשיטות נפוצות
מחזור חיים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 יכול להציג משהו.

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