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 trong 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 mục đích đó. Lớp C# và plugin JavaScript cũ 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 động 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 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 lại. |
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 ở gốc site; nếu không, là nhánh nơi máy chủ á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 nó: thư mục images dưới ResourcesPath, không có dấu / đầu. |
string | FitType | "width" | "width", "height" hoặc để trống nếu không muốn tự động vừa. "page" không được chấp nhận bởi widget hiện tại. |
bool | RetryOn409 | false | Bật polling khi yêu cầu trang bất đồng bộ/phân tán trả về 409. 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ẽ thêm nó ("/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 vào docViewer(...). Hầu hết các khóa widget dùng dạng camelCase, trong khi ba khóa đường dẫn/điều chỉnh đã được thiết lập dùng 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
Widget có các mặc định cũ hơn so với lớp C#. Các giá trị sau được lấy từ triển khai hiện tại của docViewer.js.
| Tùy chọn | Mặc định | Ghi chú |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | Giới hạn độ rộng của 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 | maxZoom của JavaScript 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 điền bởi View(token). |
debugMode | false | Chẩn đoán khách hàng bổ sung. |
FitType | "" | Không tự động vừa trừ khi được cung cấp. |
BasePath | "DocImage.axd" | Mặc định trình xử lý cũ. Đặt rõ ràng cho ASP.NET Core. |
ResPath | "" | Đặt 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ị sử dụng 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 Callback
| Callback | Đối số | Mục đích |
|---|---|---|
onPageLoading | pageNum | Yêu cầu tải một trang đang bắt đầu. |
onPageLoaded | pageNum | Hình ảnh của một trang đã tải xong. |
onThumbnailClicked | pageNum | Người dùng đã chọn một hình thu nhỏ. |
onPageClicked | pageNum | Người dùng đã chọn một trang. |
onDoubleClick | none | Trình xem nhận được một cú nhấp đôi. |
onViewerBusy | none | Trình xem chuyển sang trạng thái bận. |
onViewerReady | none | Hoàn tất khởi tạo. |
onViewerError | none | Trình xem chuyển sang 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 điều khiển hình thu nhỏ trở nên hiển thị. |
onAnnLoaded | none | Dữ liệu chú thích đã được tải. |
onAnnSaved | none | Dữ liệu chú thích đã được 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 callback nhanh; gửi dữ liệu telemetry một cách bất đồng bộ và không chặn việc render trang.
Các 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() |
| Định 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 helper 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 hoá ở đâ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 sau HTTP 409
retryOn409 dùng cho việc tạo trang bất đồng bộ. Khi bật, widget sẽ thực hiện polling với các giá trị mặc định JavaScript sau:
| Tùy chọn | Mặc định |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 60 |
retryMaxTotalMs | 120000 |
Giữ nó tắt cho trình xem thông thường. Bật nó không thể làm cho một quá trình render đồng bộ không được hỗ trợ 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 trỏ tới nhánh đó, viết mà không có dấu/ở đầu ('doconut', không phải'/doconut': trình xem sẽ thêm dấu gạch chéo, 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 trỏ tới thư mục conimagescủa nó, cũng không có dấu/ở đầu ('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?