ViewerConfig – Doconut תיעוד

ViewerConfig (namespace Doconut) describes the browser viewer's appearance and behavior. It does not affect document rendering quality; use a format config for that. The C# class and the legacy JavaScript plugin have different defaults, so map values explicitly.

מאפייני C#

סוג	מאפיין	ברירת מחדל	תיאור
`bool`	`ShowThumbs`	`true`	הצגת לוח התמונות הממוזערות.
`bool`	`AutoLoad`	`false`	טעינה אוטומטית לאחר האתחול. זרימת האסימונים הרגילה קוראת ל-`View(token)` במפורש.
`bool`	`AutoFocus`	`true`	הזזת המיקוד/גלילה של הדפדפן לתצוגה במהלך האתחול.
`bool`	`AutoPageFocus`	`true`	שמירת התמונה הממוזערת הנוכחית גלויה בזמן שינוי דפים.
`int`	`PageZoom`	`100`	אחוז זום ראשוני.
`int`	`ZoomStep`	`10`	אחוז שנוסף או מוסר על ידי פקודות זום.
`int`	`MaxZoom`	`300`	אחוז זום מרבי.
`bool`	`ShowToolTip`	`true`	הצגת תיאור מקומי של העמוד בעת גלילה.
`string`	`ToolTipPageText`	`"Page "`	קידומת המשמשת בתיאור העמוד.
`bool`	`CacheEnabled`	`false`	שמירת חלון נע של תמונות עמוד בזיכרון הדפדפן. אינו משתמש ב-`localStorage`.
`bool`	`LargeDoc`	`false`	הוספת אלמנטים של עמודים במנות מתוזמנות עבור מסמכים גדולים.
`bool`	`ShowHyperlinks`	`false`	הצגת שכבות קישורים כאשר תצורת השרת חילצה אותן.
`bool`	`FixedZoom`	`true`	שימוש באחוז זום קבוע במקום חישוב רספונסיבי.
`int`	`FixedZoomPercent`	`100`	זום קבוע למחשב שולחני.
`int`	`FixedZoomPercentMobile`	`75`	זום קבוע למובייל.
`string`	`BasePath`	`"/"`	היכן שהצופה שולח בקשות דפים. `"/"` הוא `DocImage.axd` בשורש האתר; אחרת הסניף שבו המארח ממפה את `UseDoconut()`, בלי `/` מוביל (`"doconut"` משמעותו `/doconut/DocImage.axd`).
`string`	`ResPath`	`"doconut-res/images"` (26.9.0; `"doconut-res"` before)	תיקייה שממנה הווידג'ט טוען את התמונות שלו: תיקיית `images` תחת `ResourcesPath`, בלי `/` מוביל.
`string`	`FitType`	`"width"`	`"width"`, `"height"`, או ריק עבור ללא התאמה אוטומטית. `"page"` אינו מתקבל על ידי הווידג'ט הנוכחי.
`bool`	`RetryOn409`	`false`	הפעלת סקר כאשר בקשת דף אסינכרונית/מבוזרת מגיבה `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

Do not pass a directly serialized ViewerConfig to docViewer(...). Most widget keys are camelCase, while three established path/fit keys are PascalCase.

C#	JavaScript
`ShowThumbs`	`showThumbs`
`AutoLoad`	`autoLoad`
`AutoFocus`	`autoFocus`
`AutoPageFocus`	`autoPageFocus`
`PageZoom`	`pageZoom`
`ZoomStep`	`zoomStep`
`MaxZoom`	`maxZoom`
`ShowToolTip`	`showToolTip`
`ToolTipPageText`	`toolTipPageText`
`CacheEnabled`	`cacheEnabled`
`LargeDoc`	`largeDoc`
`ShowHyperlinks`	`showHyperlinks`
`FixedZoom`	`fixedZoom`
`FixedZoomPercent`	`fixedZoomPercent`
`FixedZoomPercentMobile`	`fixedZoomPercentMobile`
`BasePath`	`BasePath`
`ResPath`	`ResPath`
`FitType`	`FitType`
`RetryOn409`	`retryOn409`

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

The widget has older defaults that differ from the C# class. The following values come from the current docViewer.js implementation.

אפשרות	ברירת מחדל	הערות
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	גבולות רוחב לוח התמונות הממוזערות.
`showThumbs`	`true`	נראות ראשונית של תמונה ממוזערת.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` שונה מברירת המחדל של C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	גאומטריית תמונה ממוזערת בפיקסלים.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	JavaScript `maxZoom` שונה מ- C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	תיאור מקומי של העמוד.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	ערכי אתחול פנימיים; בדרך כלל ממולאים על ידי `View(token)`.
`debugMode`	`false`	אבחונים נוספים של הלקוח.
`FitType`	`""`	אין התאמה אוטומטית אלא אם כן מסופק.
`BasePath`	`"DocImage.axd"`	ברירת מחדל של מטפל ישן. הגדר זאת במפורש עבור ASP.NET Core.
`ResPath`	`""`	הגדר במפורש לנתיב התמונות המוטמעים.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	חלון טעינה מראש של דפים בזיכרון ועיכוב.
`autoLoad`	`false`	מומלץ להשתמש בזרימת אסימונים מפורשת.
`largeDoc`	`true`	שונה מברירת המחדל של C#.
`fixedZoom`	`false`	שונה מברירת המחדל של C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	ערך למובייל שונה מ- C# (`75`).
`showHyperlinks`	`true`	דורש חילוץ בצד השרת ליצירת שכבות.

Set all behaviorally important values instead of relying on either set of defaults:

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>

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

קריאה חוזרת	ארגומנטים	מטרה
`onPageLoading`	`pageNum`	בקשת דף מתחילה.
`onPageLoaded`	`pageNum`	תמונת דף הסתיימה בטעינה.
`onThumbnailClicked`	`pageNum`	המשתמש בחר בתמונה ממוזערת.
`onPageClicked`	`pageNum`	המשתמש בחר בדף.
`onDoubleClick`	none	הצופה קיבל לחיצה כפולה.
`onViewerBusy`	none	הצופה נכנס למצב עסוק.
`onViewerReady`	none	האתחול הושלם.
`onViewerError`	none	הצופה נכנס למצב שגיאה.
`onError`	`message`	פעולה החזירה הודעת שגיאה.
`onCopy`	`data`	נתוני העתקת טקסט זמינים.
`onAutoLoadStatus`	`pageNum`	טעינה אוטומטית התקדמה לדף.
`onThumbsShown`	none	פאנל התמונות הממוזערות הפך גלוי.
`onAnnLoaded`	none	נתוני ההערות נטענו.
`onAnnSaved`	none	נתוני ההערות נשמרו.
`onAnnSaveError`	none	שמירת ההערות נכשלה.
`onAnnClosed`	none	ממשק המשתמש של ההערות נסגר.

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

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

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

ניסיון חוזר אחרי HTTP 409

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

אפשרות	ברירת מחדל
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

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

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

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