ViewerConfig – תיעוד Doconut

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

מאפייני 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`	`"/"`	הענף שבו המארח ממפה `UseDoconut()`.
`string`	`ResPath`	`"doconut-res"`	בסיס המשאבים בו משתמש הווידג'ט. בהגדרה רגילה הפנו אותו אל `<ResourcesPath>/images`.
`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",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

מיפוי מ‑C# ל‑JavaScript

אל תעבירו ViewerConfig שמורשד ישירות ל‑docViewer(...). רוב מפתחות הווידג'ט הם camelCase, בעוד שלושה מפתחות נתיב/התאמה קבועים הם 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

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

אפשרות	ברירת מחדל	הערות
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	גבולות רוחב לוח התמונות הממוזערות.
`showThumbs`	`true`	נראות ראשונית של התמונות הממוזערות.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` שונה מברירת המחדל של C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	גיאומטריית תמונות ממוזערות בפיקסלים.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	`maxZoom` של JavaScript שונה מ‑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`	דורש חילוץ בצד השרת ליצירת שכבות.

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

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

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

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

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

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

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

DoconutOptions.MiddlewarePath חייב לתאר את הענף שאתה בפועל ממפה.
BasePath חייב למקד את הענף הזה.
DoconutOptions.ResourcesPath הוא נתיב המשאבים המוטמעים.
ResPath בדרך כלל מכוון לתת‑תיקייה /images שלו.
ExtractHyperlinks חייב להיות מופעל בתצורת פורמט השרת לפני ש‑showHyperlinks יכול להציג משהו.