ViewerConfig

گزینه‌های ویجت نمایش‌گر سمت‌کلاینت

ViewerConfig (namespace Doconut) ظاهر و رفتار نمایشگر مرورگر را توصیف می‌کند. این بر کیفیت رندر سند تأثیری ندارد؛ برای آن از یک پیکربندی فرمت استفاده کنید. کلاس C# و افزونه جاوااسکریپت قدیمی مقادیر پیش‌فرض متفاوتی دارند، بنابراین مقادیر را به‌صورت صریح نگاشت کنید.

ویژگی‌های 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# به جاوااسکریپت

از ارسال مستقیم 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 به‌صورت صریح تنظیم کنید.
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کاربر یک صفحه را انتخاب کرد.
onDoubleClickهیچنمایشگر یک دوبار کلیک دریافت کرد.
onViewerBusyهیچنمایشگر به حالت مشغول رفت.
onViewerReadyهیچراه‌اندازی تکمیل شد.
onViewerErrorهیچنمایشگر به حالت خطا رفت.
onErrormessageیک عملیات پیام خطا برگرداند.
onCopydataداده‌های کپی متن در دسترس هستند.
onAutoLoadStatuspageNumبارگذاری خودکار به صفحه‌ای پیشرفت کرد.
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 دوباره تلاش می‌کند. زمانی که فعال شود، ویجت با این پیش‌فرض‌های جاوااسکریپت نظرسنجی می‌کند:

گزینهپیش‌فرض
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

این را برای نمایشگر عادی غیرفعال بگذارید. فعال‌سازی آن نمی‌تواند رندر همزمانی که پشتیبانی نمی‌شود را به‌صورت ناهمزمان تبدیل کند.

فهرست بررسی مسیر

  • DoconutOptions.MiddlewarePath باید شاخه‌ای که واقعاً نقشه می‌کنید را توصیف کند.
  • BasePath باید به آن شاخه هدف بگیرد، به‌صورت بدون پیشوند / نوشته شود ('doconut'، نه '/doconut': نمایشگر اسلش را اضافه می‌کند، و //doconut/... یک درخواست به میزبان دیگر است).
  • DoconutOptions.ResourcesPath مسیر منبع جاسازی‌شده است.
  • ResPath به‌طور معمول زیرپوشه images خود را هدف می‌گیرد، همچنین بدون پیشوند / ('doconut-res/images').
  • ExtractHyperlinks باید در تنظیمات فرمت سرور فعال شود تا showHyperlinks بتواند چیزی نمایش دهد.

آیا این صفحه مفید بود؟