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`	`"/"`	היכן שהמציג שולח בקשות דפים. `"/"` הוא `DocImage.axd` בשורש האתר; אחרת הסניף שבו המארח ממפה `UseDoconut()`, בלי מקדמת `/` (`"doconut"` משמעותו `/doconut/DocImage.axd`).
`string`	`ResPath`	`"doconut-res/images"` (26.9.0; `"doconut-res"` לפני)	תיקייה שהווידג'ט טוען ממנה את התמונות שלו: תיקיית `images` תחת `ResourcesPath`, בלי מקדמת `/`.
`string`	`FitType`	`"width"`	`"width"` (רוחב), `"height"` (גובה), או ריק ללא התאמה אוטומטית. `"page"` אינו מתקבל על‑ידי הווידג'ט הנוכחי.
`bool`	`RetryOn409`	`false`	הפעלת משאלות כאשר ייצור דפים אסינכרוני/מבוזר מחזיר `202 Accepted`; `409` גם מתקבל לתאימות עם שרתים ישנים. לא נדרש על‑ידי המציג הסינכרוני הרגיל.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // no leading '/': the viewer adds it ("/doconut" would become //doconut, another host)
    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 נוכחיים חייבים להגדיר זאת במפורש לסניף ה‑middleware הממופה.
`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 מכיל גם עוזרים פנימיים. התייחס רק לשיטות המשמשות את ממשק המשתמש הרפרנסי ומתועדות כאן או במדריכי הפיצ'רים כנקודות אינטגרציה יציבות.

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

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