ViewerConfig

Tùy chọn widget trình xem phía máy khách

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.

Hai thay đổi phía máy khách trong bản phát hành này thất bại một cách im lặng. Các hàm xử lý được truyền dưới dạng tùy chọn — widget không còn lấy các callback sự kiện từ id của container — và ResPath phải trỏ tới tiền tố tài nguyên thay vì gốc ứng dụng. Cả hai đều để máy chủ hoạt động bình thường và không báo cáo gì trong console của trình duyệt. Nếu bạn đang chuyển một trang từ thư viện trước, hãy đọc Các hàm gọi lại và Danh sách kiểm tra đường dẫn trước mọi thứ khác.

Thuộc tính C#

KiểuThuộc tínhMặc địnhMô tả
boolShowThumbstrueHiển thị bảng điều khiển hình 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 trình 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 đại ban đầu.
intZoomStep10Phần trăm được thêm hoặc bớt bởi các lệnh phóng đại.
intMaxZoom300Phần trăm phóng đại tối đa.
boolShowToolTiptrueHiển thị tooltip vị trí trang khi cuộn.
stringToolTipPageText"Page "Tiền tố được sử dụng trong tooltip trang.
boolCacheEnabledfalseGiữ 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.
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 đại cố định thay vì tính toán lại đáp ứng.
intFixedZoomPercent100Phóng đại cố định cho máy tính để bàn.
intFixedZoomPercentMobile75Phóng đại cố định cho thiết bị di động.
stringBasePath"/"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 máy chủ ánh xạ UseDoconut(), không có dấu / đầ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 nó: thư mục images dưới ResourcesPath, không có dấ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 việc thăm dò 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 trình xem đồng bộ thông 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ẽ 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 tới docViewer(...). Hầu hết các khóa widget sử dụng camelCase, trong khi ba khóa đường dẫn/điều chỉnh đã được thiết lập sử 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 này 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 chiều rộng khung thu nhỏ.
showThumbstrueKhả năng hiển thị thu nhỏ ban đầu.
autoFocus / autoPageFocustrue / falseautoPageFocus khác với mặc định C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Hình học 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 vặn trừ khi được cung cấp.
BasePath"DocImage.axd"Mặc định khách hàng 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 / 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ạiĐối 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 một ảnh thu nhỏ.
onPageClickedpageNumNgười dùng đã chọn một trang.
onDoubleClicknoneTrình xem nhận được double-click.
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 thu nhỏ trở nên hiển thị.
onAnnLoadednoneDữ liệu chú thích đã tải.
onAnnSavednoneDữ liệu chú thích đã lưu.
onAnnSaveErrornoneLưu chú thích thất bại.
onAnnClosednoneGiao diện 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 render trang.

Mỗi một trong số này là một tùy chọn trên đối tượng init. Trình xem trước đây tìm kiếm các hàm toàn cục mà tên của chúng được suy ra từ id của container — một trang với <div id="div_ctlDoc"> chỉ cần khai báo function ctlDoc_OnViewerReady(). Việc tìm kiếm đó đã biến mất. Truyền hàm một cách rõ ràng:

javascript
function ctlDoc_OnViewerBusy() { /* hiển thị chỉ báo bận của bạn */ }
function ctlDoc_OnViewerReady() { /* ẩn nó */ }
function ctlDoc_Copy(text) { /* sử dụng văn bản đã sao chép */ }
function ctlDoc_AutoLoadStatus(pageNum) { /* báo cáo tiến độ */ }

const objViewer = $('#div_ctlDoc').docViewer({
    // ... các tùy chọn hiện có của bạn ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // được tìm thấy theo tên
    onViewerReady:    ctlDoc_OnViewerReady,     // được tìm thấy theo tên
    onCopy:           ctlDoc_Copy,              // đã ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // đã ctlDoc_AutoLoadStatus(page)
});

Việc tìm kiếm cũ được bao bọc trong một catch trống, vì vậy không có gì được báo cáo. Trong bản phát hành này, các hàm đơn giản không bao giờ chạy: triệu chứng thường gặp là một biểu tượng quay bận không bao giờ dừng, vì trình xử lý ẩn nó đã là onViewerReady. Tài liệu phía sau đang được render đúng cách.

Hai hook lưu chú thích vẫn được tìm kiếm theo tên: SaveAnnotations() gọi <elementId>_BeforeAnnSave() và <elementId>_DeletedAnnotationIds() khi chúng tồn tại, sử dụng id đầy đủ của phần tử div_ctlDoc_BeforeAnnSave cho ví dụ trên.

Không có hàm gọi lại khi nhấp liên kết — việc xử lý siêu liên kết được tích hợp sẵn và được điều khiển bởi showHyperlinks.

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

NhómPhươ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()
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 sử dụng bởi giao diện tham chiếu 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 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 202 Accepted cũng như tín hiệu cũ hơn 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 trình xem đơn nút bình 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ộ.

Bật nó khi các trang được phục vụ từ bộ nhớ chia sẻ với FirstPagePriority, nơi các trang sau này hợp pháp trả lời 202 Accepted cho đến khi chúng được ghi. Một client không thử lại sẽ hiển thị các ô bị hỏng cho các trang vẫn đang render — xem Triển khai Phân tán.

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 tiên ('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). Một cấu hình phổ biến giữ nguyên dạng yêu cầu lịch sử DocImage.axd trên một nhánh MapWhen và do đó đặt BasePath: '/'.
  • DoconutOptions.ResourcesPath là tuyến đường tài nguyên nhúng.
  • ResPath thường nhắm tới thư mục con images của nó, mà không có / đầu — 'doconut-res/images' với tiền tố mặc định. Một ResPath trống đã đúng trong thư viện trước, nơi các tài nguyên đến từ gốc ứng dụng; ở đây nó không đúng, và nó sẽ thất bại mà không có lỗi.
  • 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?