ViewerConfig

خيارات عنصر واجهة المشاهد للعميل

ViewerConfig (namespace Doconut) يصف مظهر وسلوك عارض المتصفح. لا يؤثر على جودة عرض المستند؛ استخدم تكوين تنسيق لهذا الغرض. فئة C# وعنصر واجهة JavaScript القديم لديهما إعدادات افتراضية مختلفة، لذا يجب تعيين القيم صراحةً.

خصائص C#

النوعالخاصيةالافتراضيالوصف
boolShowThumbstrueإظهار لوحة الصور المصغرة.
boolAutoLoadfalseتحميل تلقائي بعد التهيئة. تدفق الرموز العادي يستدعي View(token) صراحةً.
boolAutoFocustrueنقل تركيز المتصفح/التمرير إلى العارض أثناء التهيئة.
boolAutoPageFocustrueإبقاء الصورة المصغرة الحالية مرئية أثناء تغيير الصفحات.
intPageZoom100نسبة التكبير الأولية.
intZoomStep10النسبة المئوية المضافة أو المزالة بأوامر التكبير.
intMaxZoom300الحد الأقصى لنسبة التكبير.
boolShowToolTiptrueإظهار تلميح موضع الصفحة أثناء التمرير.
stringToolTipPageText"Page "البادئة المستخدمة في تلميح الصفحة.
boolCacheEnabledfalseالاحتفاظ بنوافذ متحركة من صور الصفحات في ذاكرة المتصفح. لا يستخدم localStorage.
boolLargeDocfalseإضافة عناصر الصفحات على دفعات زمنية للوثائق الكبيرة.
boolShowHyperlinksfalseعرض طبقات الروابط التشعبية عندما يستخرجها تكوين الخادم.
boolFixedZoomtrueاستخدام نسبة تكبير ثابتة بدلاً من إعادة حساب استجابية.
intFixedZoomPercent100تكبير ثابت لسطح المكتب.
intFixedZoomPercentMobile75تكبير ثابت للهواتف المحمولة.
stringBasePath"/"المكان الذي يرسل فيه العارض طلبات الصفحات. "/" هو DocImage.axd في جذر الموقع؛ وإلا الفرع حيث يطابق المضيف UseDoconut()، دون بادئة / ("doconut" يعني /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" before)المجلد الذي يحمل منه العنصر صوره الخاصة: مجلد images تحت ResourcesPath، دون بادئة /.
stringFitType"width""width"، "height"، أو فارغ لعدم وجود ضبط تلقائي. لا يُقبل "page" في العنصر الحالي.
boolRetryOn409falseتمكين الاستطلاع عندما تستجيب إنتاج الصفحات غير المتزامنة/الموزعة 202 Accepted؛ كما يُقبل 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

لا تمرر ViewerConfig المتسلسل مباشرةً إلى docViewer(...). معظم مفاتيح العنصر هي camelCase، بينما ثلاثة مفاتيح مسار/ضبط معروفة هي PascalCase.

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

الافتراضات في JavaScript

تحتوي الأداة على إعدادات افتراضية أقدم تختلف عن فئة C#. القيم التالية مستمدة من تنفيذ docViewer.js الحالي.

الخيارالافتراضيملاحظات
leftMinWidth / leftMaxWidth220 / 800حدود عرض لوحة الصور المصغرة.
showThumbstrueرؤية الصور المصغرة الأولية.
autoFocus / autoPageFocustrue / falseautoPageFocus يختلف عن الإعداد الافتراضي في C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10هندسة الصور المصغرة بالبكسل.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom يختلف عن C# (300).
showToolTip / toolTipPageTexttrue / "Page "تلميح موضع الصفحة.
format / doc / AccessToken"" / 0 / ""قيم التهيئة الداخلية؛ عادةً ما يتم ملؤها بواسطة View(token).
debugModefalseتشخيصات إضافية للعميل.
FitType""لا يوجد ضبط تلقائي ما لم يتم توفيره.
BasePath"DocImage.axd"الافتراضي التاريخي للعميل محفوظ للتوافق. يجب على مضيفي ASP.NET Core الحاليين تعيينه صراحةً إلى فرع middleware المقابل.
ResPath""تعيين صراحةً إلى مسار الصور المدمجة.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3نافذة تحميل الصفحات مسبقًا في الذاكرة والمدة.
autoLoadfalseيوصى بتدفق الرموز الصريح.
largeDoctrueيختلف عن الإعداد الافتراضي في C#.
fixedZoomfalseيختلف عن الإعداد الافتراضي في C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50القيمة للهواتف المحمولة تختلف عن C# (75).
showHyperlinkstrueيتطلب استخراجًا من جانب الخادم لإنتاج الطبقات الفوقية.

قم بتعيين جميع القيم ذات الأهمية السلوكية بدلاً من الاعتماد على أي من مجموعتي الإعدادات الافتراضية:

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>

ردود النداء

رد النداءالوسائطالغرض
onPageLoadingpageNumيبدأ طلب صفحة.
onPageLoadedpageNumانتهى تحميل صورة الصفحة.
onThumbnailClickedpageNumاختار المستخدم صورة مصغرة.
onPageClickedpageNumاختار المستخدم صفحة.
onDoubleClicknoneاستقبل العارض نقرة مزدوجة.
onViewerBusynoneدخل العارض في حالة مشغولة.
onViewerReadynoneاكتملت التهيئة.
onViewerErrornoneدخل العارض في حالة الخطأ.
onErrormessageأرجعت عملية رسالة خطأ.
onCopydataبيانات نسخ النص متاحة.
onAutoLoadStatuspageNumتقدم التحميل التلقائي إلى صفحة.
onThumbsShownnoneأصبح لوحة الصور المصغرة مرئية.
onAnnLoadednoneتم تحميل بيانات التعليقات التوضيحية.
onAnnSavednoneتم حفظ بيانات التعليقات التوضيحية.
onAnnSaveErrornoneفشل حفظ التعليقات التوضيحية.
onAnnClosednoneتم إغلاق واجهة التعليقات التوضيحية.

احرص على أن تكون ردود النداء سريعة؛ أرسل بيانات القياس عن بُعد بشكل غير متزامن ولا تحجب عملية عرض الصفحة.

مجموعات الطرق العامة

المجموعةالطرق الشائعة
دورة الحياة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 القديمة. عند التفعيل، يقوم الودجت بالاستطلاع باستخدام هذه الإعدادات الافتراضية لجافاسكريبت:

الخيارالافتراضي
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

اتركه معطلاً للمشاهد العادي. تمكينه لا يمكن أن يجعل عرضًا متزامنًا غير مدعومًا غير متزامن.

قائمة التحقق من المسار

  • DoconutOptions.MiddlewarePath يجب أن يصف الفرع الذي تقوم بربطه فعليًا.
  • BasePath يجب أن يستهدف ذلك الفرع، مكتوبًا دون مقدمة / ('doconut'، وليس '/doconut': يضيف المشاهد الشرطة المائلة، و//doconut/... هو طلب إلى مضيف آخر).
  • DoconutOptions.ResourcesPath هو مسار المورد المدمج.
  • ResPath عادةً ما يستهدف المجلد الفرعي images الخاص به، أيضًا دون مقدمة / ('doconut-res/images').
  • ExtractHyperlinks يجب تمكينه في إعداد تنسيق الخادم قبل أن يتمكن showHyperlinks من عرض أي شيء.

هل كانت هذه الصفحة مفيدة؟