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" before) | المجلد الذي يحمل منه العنصر صوره الخاصة: مجلد 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 |
الإعدادات الافتراضية لجافاسكريبت
الودجت يحتوي على إعدادات افتراضية أقدم تختلف عن فئة 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 | 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) |
يحتوي ملف جافاسكريبت أيضًا على مساعدات داخلية. اعتبر فقط الطرق المستخدمة من قبل واجهة المستخدم المرجعية والموثقة هنا أو في أدلة الميزات كنقاط دمج مستقرة.
إعادة المحاولة بينما لا يزال الصفحة الموزعة تُعرض
retryOn409 يحتفظ باسمه التاريخي. وهو مخصص لإنتاج الصفحات غير المتزامنة ويعيد محاولة استجابة الجاهزية الحالية 202 Accepted بالإضافة إلى الإشارة القديمة 409 Conflict. عند التمكين، يقوم الودجت بالاستطلاع باستخدام هذه الإعدادات الافتراضية لجافاسكريبت:
| الخيار | الافتراضي |
|---|---|
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من عرض أي شيء.
هل كانت هذه الصفحة مفيدة؟