ViewerConfig – Doconut الوثائق

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

خصائص 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`	تمكين الاستطلاع عندما يستجيب طلب صفحة غير متزامن/موزع بـ `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# إلى جافاسكريبت

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

C#	جافاسكريبت
`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`	`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`	يتطلب استخراجًا من جانب الخادم لإنتاج الطبقات.

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

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

إعادة المحاولة بعد HTTP 409

retryOn409 مخصص للإنتاج غير المتزامن للصفحات. عند التفعيل، يقوم الودجت بالاستطلاع باستخدام الإعدادات الافتراضية التالية لجافاسكريبت:

الخيار	القيمة الافتراضية
`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 من عرض أي شيء.