ViewerConfig
אפשרויות וידג'ט מציג לקוח
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 גם הוא מתקבל לתאימות עם שרתים ישנים יותר. אינו נדרש על ידי המציג הסינכרוני הרגיל. |
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 |
|---|---|
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 | 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 | דורש חילוץ בצד השרת ליצירת שכבות. |
הגדר את כל הערכים החשובים להתנהגות במקום להסתמך על אחד משני סטי ברירות המחדל:
<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 | ללא | הצופה קיבל לחיצה כפולה. |
onViewerBusy | ללא | הצופה נכנס למצב עסוק. |
onViewerReady | ללא | האתחול הושלם. |
onViewerError | ללא | הצופה נכנס למצב שגיאה. |
onError | message | פעולה החזירה הודעת שגיאה. |
onCopy | data | נתוני העתקת טקסט זמינים. |
onAutoLoadStatus | pageNum | טעינה אוטומטית התקדמה לדף. |
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 הבאים:
| אפשרות | ברירת מחדל |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
השאר אותו מושבת עבור הצופה הרגיל. הפעלתו לא יכולה להפוך רינדור סינכרוני שאינו נתמך לאסינכרוני.
רשימת בדיקות נתיב
DoconutOptions.MiddlewarePathחייב לתאר את הסניף שאתה בפועל ממפה.BasePathחייב למקד את הסניף הזה, כתוב ללא/מוביל ('doconut', ולא'/doconut': הצופה מוסיף את הקו המפריד, ו//doconut/...הוא בקשה למארח אחר).DoconutOptions.ResourcesPathהוא נתיב המשאב המשובץ.ResPathבדרך כלל ממקד את תת-התיקייה שלוimages, גם ללא/מוביל ('doconut-res/images').ExtractHyperlinksחייב להיות מופעל בתצורת פורמט השרת לפני שshowHyperlinksיכול להציג משהו.
האם דף זה היה מועיל?