ViewerConfig
گزینههای ویجت نمایشگر سمتکلاینت
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" 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# به جاوااسکریپت
از ارسال مستقیم 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 |
پیشفرضهای JavaScript
ویجت دارای پیشفرضهای قدیمی است که با کلاس 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 | هیچ | نمایشگر یک دوبار کلیک دریافت کرد. |
onViewerBusy | هیچ | نمایشگر به حالت مشغول رفت. |
onViewerReady | هیچ | راهاندازی تکمیل شد. |
onViewerError | هیچ | نمایشگر به حالت خطا رفت. |
onError | message | یک عملیات پیام خطا برگرداند. |
onCopy | data | دادههای کپی متن در دسترس هستند. |
onAutoLoadStatus | pageNum | بارگذاری خودکار به صفحهای پیشرفت کرد. |
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 دوباره تلاش میکند. زمانی که فعال شود، ویجت با این پیشفرضهای جاوااسکریپت نظرسنجی میکند:
| گزینه | پیشفرض |
|---|---|
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بتواند چیزی نمایش دهد.
آیا این صفحه مفید بود؟