ViewerConfig – Doconut الوثائق

ViewerConfig (المساحة الاسمية 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`	تمكين الاستطلاع عندما تستجيب إنتاج الصفحات غير المتزامنة/الموزعة بـ `202 Accepted`؛ كما يتم قبول `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

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

الخيار	الافتراضي	ملاحظات
`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 أيضًا على مساعدات داخلية. اعتبر فقط الطرق المستخدمة من قبل واجهة المستخدم المرجعية والموثقة هنا أو في أدلة الميزات كنقاط تكامل مستقرة.

إعادة المحاولة أثناء استمرار عرض صفحة موزعة

retryOn409 يحتفظ باسمه التاريخي. يُستخدم لإنتاج الصفحات غير المتزامن ويعيد محاولة استجابة الجاهزية الحالية 202 Accepted بالإضافة إلى إشارة 409 Conflict القديمة. عند تمكينه، يستطلع العنصر هذه الإعدادات الافتراضية في JavaScript:

الخيار	الافتراضي
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

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

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

DoconutOptions.MiddlewarePath يجب أن يصف الفرع الذي تقوم بربطه فعليًا.
BasePath يجب أن يستهدف ذلك الفرع.
DoconutOptions.ResourcesPath هو مسار المورد المضمن.
ResPath عادةً ما يستهدف المجلد الفرعي /images.
ExtractHyperlinks يجب تمكينه في إعداد تنسيق الخادم قبل أن يتمكن showHyperlinks من عرض أي شيء.