ViewerConfig

Tùy chọn widget trình xem khách hàng

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 kế thừa có các giá trị 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ểuThuộc tínhMặc địnhMô tả
boolShowThumbstrueHiển thị bảng thu nhỏ.
boolAutoLoadfalseTự động tải sau khi khởi tạo. Luồng token bình thường gọi View(token) một cách rõ ràng.
boolAutoFocustrueDi chuyển tiêu điểm/cuộn của trình duyệt tới bộ xem trong quá trình khởi tạo.
boolAutoPageFocustrueGiữ hình thu nhỏ hiện tại hiển thị khi các trang thay đổi.
intPageZoom100Phần trăm phóng to ban đầu.
intZoomStep10Phần trăm được thêm hoặc bớt bởi các lệnh phóng to.
intMaxZoom300Phần trăm phóng to tối đa.
boolShowToolTiptrueHiển thị tooltip vị trí trang khi cuộn.
stringToolTipPageText"Page "Tiền tố được dùng trong tooltip trang.
boolCacheEnabledfalseGiữ 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.
boolLargeDocfalseThêm các phần tử trang theo các lô thời gian cho tài liệu lớn.
boolShowHyperlinksfalseHiể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.
boolFixedZoomtrueSử dụng phần trăm phóng to cố định thay vì tính toán lại đáp ứng.
intFixedZoomPercent100Phóng to cố định cho máy tính để bàn.
intFixedZoomPercentMobile75Phóng to cố định cho thiết bị di động.
stringBasePath"/"Nơi bộ xem gửi yêu cầu trang. "/" là DocImage.axd ở gốc site; nếu không, nhánh nơi máy chủ ánh xạ UseDoconut(), không có / ở đầu ("doconut" có nghĩa là /doconut/DocImage.axd).
stringResPath"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ó / ở đầu.
stringFitType"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.
boolRetryOn409falseBậ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ũ hơn. Không cần thiết cho bộ xem đồng bộ bình thường.
csharp
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 ViewerConfig đã được tuần tự hoá trực tiếp tới docViewer(...). Hầu hết các khóa widget dùng camelCase, trong khi ba khóa đường dẫn/fit đã được thiết lập dùng PascalCase.

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

Mặc định JavaScript

Tiện ích có các mặc định cũ hơn so với lớp C#. Các giá trị sau đến từ triển khai hiện tại của docViewer.js.

Tùy chọnMặc địnhGhi chú
leftMinWidth / leftMaxWidth220 / 800Giới hạn độ rộng của khung hình thu nhỏ.
showThumbstrueKhả năng hiển thị hình thu nhỏ ban đầu.
autoFocus / autoPageFocustrue / falseautoPageFocus khác với mặc định C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Hình học hình thu nhỏ tính bằng pixel.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom khác với C# (300).
showToolTip / toolTipPageTexttrue / "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.
debugModefalseChẩn đoán khách hàng bổ sung.
FitType""Không tự động vừa nếu không được cung cấp.
BasePath"DocImage.axd"Mặc định trình xử lý cũ. Đặt nó một cách rõ ràng cho ASP.NET Core.
ResPath""Đặt rõ ràng tới đường dẫn hình ảnh nhúng.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Cửa sổ và độ trễ tải trước trang trong bộ nhớ.
autoLoadfalseKhuyến nghị luồng token rõ ràng.
largeDoctrueKhác với mặc định C#.
fixedZoomfalseKhác với mặc định C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Giá trị di động khác với C# (75).
showHyperlinkstrueYê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:

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>

Các hàm gọi lại

Hàm gọi lạiTham sốMục đích
onPageLoadingpageNumYêu cầu trang đang bắt đầu.
onPageLoadedpageNumHình ảnh trang đã tải xong.
onThumbnailClickedpageNumNgười dùng đã chọn hình thu nhỏ.
onPageClickedpageNumNgười dùng đã chọn một trang.
onDoubleClicknoneTrình xem nhận được nhấp đôi.
onViewerBusynoneTrình xem chuyển sang trạng thái bận.
onViewerReadynoneKhởi tạo hoàn tất.
onViewerErrornoneTrình xem chuyển sang trạng thái lỗi.
onErrormessageMột thao tác trả về thông báo lỗi.
onCopydataDữ liệu sao chép văn bản có sẵn.
onAutoLoadStatuspageNumTự động tải tiến tới một trang.
onThumbsShownnoneBảng điều khiển hình thu nhỏ đã hiển thị.
onAnnLoadednoneDữ liệu chú thích đã được tải.
onAnnSavednoneDữ liệu chú thích đã được lưu.
onAnnSaveErrornoneLưu chú thích thất bại.
onAnnClosednoneGiao diện người dùng chú thích đã đóng.

Giữ các hàm gọi lại nhanh; gửi dữ liệu đo lường một cách bất đồng bộ và không chặn việc kết xuất trang.

Các nhóm phương thức công khai

NhómCác phương thức chung
Vòng đờiView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
Điều hướngGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Phóng to và vừaZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
Định hướngRotate(page, angle), Flip(page, flipType)
Hình thu nhỏHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
Tìm kiếmCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
Chú thíchSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
Sao chépCopy(...), 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 tán vẫn đang được render

retryOn409 giữ nguyên tên lịch sử của nó. Nó dùng cho việc tạo 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ọnMặc định
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

Để nó tắt cho người xem bình thường. Bật nó không thể làm cho một 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.MiddlewarePath phải mô tả nhánh mà bạn thực sự ánh xạ.
  • BasePath phải nhắm tới nhánh đó, viết mà không có / ở đầ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.ResourcesPath là đường dẫn tài nguyên nhúng.
  • ResPath thường nhắm tới thư mục con images của nó, cũng không có / ở đầu ('doconut-res/images').
  • ExtractHyperlinks phải được bật trong cấu hình định dạng máy chủ trước khi showHyperlinks có thể hiển thị bất kỳ thứ gì.

Trang này có hữu ích không?