ViewerConfig
Các tùy chọn widget xem trên client
ViewerConfig (namespace Doconut) mô tả giao diện và hành vi của trình xem trên trình duyệt. Nó không ảnh hưởng đến chất lượng hiển thị tài liệu; hãy sử dụng cấu hình định dạng cho việc đó. Lớp C# và widget JavaScript lâu đời có các mặc định khác nhau, vì vậy hãy ánh xạ các giá trị một cách rõ ràng.
Thuộc tính C#
| Kiểu | Thuộc tính | Mặc định | Mô tả |
|---|---|---|---|
bool | ShowThumbs | true | Hiển thị bảng điều khiển hình thu nhỏ. |
bool | AutoLoad | false | Tự động tải sau khi khởi tạo. Luồng token thông thường gọi View(token) một cách rõ ràng. |
bool | AutoFocus | true | Di chuyển tiêu điểm/cuộn của trình duyệt tới trình xem trong quá trình khởi tạo. |
bool | AutoPageFocus | true | Giữ hình thu nhỏ hiện tại hiển thị khi các trang thay đổi. |
int | PageZoom | 100 | Phần trăm thu phóng ban đầu. |
int | ZoomStep | 10 | Phần trăm được thêm hoặc bớt bởi các lệnh thu phóng. |
int | MaxZoom | 300 | Phần trăm thu phóng tối đa. |
bool | ShowToolTip | true | Hiển thị tooltip vị trí trang khi cuộn. |
string | ToolTipPageText | "Page " | Tiền tố được sử dụng trong tooltip trang. |
bool | CacheEnabled | false | Giữ một cửa sổ di chuyển của các hình ảnh trang trong bộ nhớ trình duyệt. Nó không sử dụng localStorage. |
bool | LargeDoc | false | Thêm các phần tử trang theo các lô thời gian cho tài liệu lớn. |
bool | ShowHyperlinks | false | Hiển thị lớp phủ siêu liên kết khi cấu hình máy chủ đã trích xuất chúng. |
bool | FixedZoom | true | Sử dụng phần trăm thu phóng cố định thay vì tính toán đáp ứng. |
int | FixedZoomPercent | 100 | Thu phóng cố định trên máy tính để bàn. |
int | FixedZoomPercentMobile | 75 | Thu phóng cố định trên thiết bị di động. |
string | BasePath | "/" | Nơi trình xem gửi yêu cầu trang. "/" là DocImage.axd tại gốc site; nếu không, nhánh nơi host ánh xạ UseDoconut(), không có dấu / ở đầu ("doconut" có nghĩa là /doconut/DocImage.axd). |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" before) | Thư mục mà widget tải các hình ảnh của mình: thư mục images dưới ResourcesPath, không có dấu / ở đầu. |
string | FitType | "width" | "width", "height", hoặc trống để không tự động vừa. "page" không được widget hiện tại chấp nhận. |
bool | RetryOn409 | false | Bật polling khi việc tạo trang bất đồng bộ/phân tán phản hồi 202 Accepted; 409 cũng được chấp nhận để tương thích với máy chủ cũ. Không cần thiết cho trình xem đồng bộ thông thường. |
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // không có dấu '/' ở đầu: trình xem sẽ tự thêm ("/doconut" sẽ trở thành //doconut, một máy chủ khác)
ResPath = "doconut-res/images",
ShowHyperlinks = true
};Ánh xạ C# sang JavaScript
Không truyền một ViewerConfig đã được tuần tự hoá trực tiếp tới docViewer(...). Hầu hết các khóa widget sử dụng camelCase, trong khi ba khóa đường dẫn/fit đã được thiết lập sử dụng 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 |
Mặc định JavaScript
Tiện ích này có các mặc định cũ hơn khác với lớp C#. Các giá trị sau đến từ triển khai docViewer.js hiện tại.
| Tùy chọn | Mặc định | Ghi chú |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | Giới hạn chiều rộng khung hình thu nhỏ. |
showThumbs | true | Hiển thị hình thu nhỏ ban đầu. |
autoFocus / autoPageFocus | true / false | autoPageFocus khác với mặc định C#. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Hình học hình thu nhỏ tính bằng pixel. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom khác với C# (300). |
showToolTip / toolTipPageText | true / "Page " | Tooltip vị trí trang. |
format / doc / AccessToken | "" / 0 / "" | Giá trị khởi tạo nội bộ; thường được View(token) điền. |
debugMode | false | Chẩn đoán khách bổ sung. |
FitType | "" | Không tự động vừa nếu không được cung cấp. |
BasePath | "DocImage.axd" | Mặc định khách lịch sử được giữ lại để tương thích. Các máy chủ ASP.NET Core hiện tại phải đặt nó một cách rõ ràng tới nhánh middleware đã ánh xạ. |
ResPath | "" | Đặt một cách rõ ràng tới đường dẫn hình ảnh nhúng. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | Cửa sổ và độ trễ tải trước trang trong bộ nhớ. |
autoLoad | false | Khuyến nghị luồng token rõ ràng. |
largeDoc | true | Khác với mặc định C#. |
fixedZoom | false | Khác với mặc định C#. |
fixedZoomPercent / fixedZoomPercentMobile | 100 / 50 | Giá trị di động khác với C# (75). |
showHyperlinks | true | Yêu cầu trích xuất phía máy chủ để tạo lớp phủ. |
Đặt tất cả các giá trị quan trọng về hành vi thay vì dựa vào bất kỳ bộ mặc định nào:
<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>Các hàm gọi lại
| Hàm gọi lại | Tham số | Mục đích |
|---|---|---|
onPageLoading | pageNum | Một yêu cầu trang đang bắt đầu. |
onPageLoaded | pageNum | Hình ảnh trang đã tải xong. |
onThumbnailClicked | pageNum | Người dùng đã chọn hình thu nhỏ. |
onPageClicked | pageNum | Người dùng đã chọn một trang. |
onDoubleClick | none | Trình xem nhận được double-click. |
onViewerBusy | none | Trình xem vào trạng thái bận. |
onViewerReady | none | Khởi tạo hoàn tất. |
onViewerError | none | Trình xem vào trạng thái lỗi. |
onError | message | Một thao tác trả về thông báo lỗi. |
onCopy | data | Dữ liệu sao chép văn bản có sẵn. |
onAutoLoadStatus | pageNum | Tự động tải tiến tới một trang. |
onThumbsShown | none | Bảng hình thu nhỏ trở nên hiển thị. |
onAnnLoaded | none | Dữ liệu chú thích đã tải. |
onAnnSaved | none | Dữ liệu chú thích đã lưu. |
onAnnSaveError | none | Lưu chú thích thất bại. |
onAnnClosed | none | Giao diện chú thích đã đóng. |
Giữ các hàm gọi lại nhanh; gửi dữ liệu telemetry bất đồng bộ và không chặn việc render trang.
Nhóm phương thức công khai
| Nhóm | Phương thức chung |
|---|---|
| Vòng đời | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| Điều hướng | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| Phóng to và vừa | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| Hướng | Rotate(page, angle), Flip(page, flipType) |
| Hình thu nhỏ | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| Tìm kiếm | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| Chú thích | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| Sao chép | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
Tệp JavaScript cũng chứa các trợ giúp nội bộ. Chỉ coi các phương thức được UI tham chiếu sử dụng và được tài liệu ở đây hoặc trong các hướng dẫn tính năng là các điểm tích hợp ổn định.
Thử lại khi một trang phân phối vẫn đang render
retryOn409 giữ nguyên tên lịch sử của nó. Nó dùng cho việc sản xuất trang bất đồng bộ và thử lại phản hồi sẵn sàng hiện tại của 202 Accepted cũng như tín hiệu cũ hơn của 409 Conflict. Khi được bật, widget sẽ thực hiện polling với các mặc định JavaScript sau:
| Tùy chọn | Mặc định |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Để nó tắt cho người xem bình thường. Bật nó không thể biến một render đồng bộ không được hỗ trợ thành bất đồng bộ.
Danh sách kiểm tra đường dẫn
DoconutOptions.MiddlewarePathphải mô tả nhánh mà bạn thực sự ánh xạ.BasePathphải nhắm tới nhánh đó, được viết mà không có/đầu tiên ('doconut', không phải'/doconut': viewer sẽ thêm dấu slash, và//doconut/...là một yêu cầu tới máy chủ khác).DoconutOptions.ResourcesPathlà đường dẫn tài nguyên nhúng.ResPaththường nhắm tới thư mục conimagescủa nó, cũng không có/đầu tiên ('doconut-res/images').ExtractHyperlinksphải được bật trong cấu hình định dạng máy chủ trước khishowHyperlinkscó thể hiển thị bất kỳ thứ gì.
Trang này có hữu ích không?