ViewerConfig

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#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = the DocImage.axd handler at the site root (Web.config)
    ResPath = "doconut-res/images", // the images folder under ResourcesPath, no leading '/'
    ShowHyperlinks = true
};
// Emit it with viewer.RenderViewer("viewerEl", token, config) - see the Viewer reference.

Phát ra ViewerConfig với RenderViewer

Viewer.RenderViewer(elementId, token, config) chuyển một ViewerConfig thành script khởi tạo của widget. Nó ghi sáu thuộc tính ở trên — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom và FitType — và sau đó gọi View(token). Các thuộc tính khác không được ghi: đối với MaxZoom, ShowHyperlinks, các cài đặt thu phóng, hoặc bất kỳ callback nào, hãy tự khởi tạo widget bằng các tùy chọn JavaScript bên dưới. Xem Viewer để biết RenderViewer.

Á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 của widget là camelCase, trong khi ba khóa đường dẫn/fit đã được thiết lập là PascalCase.

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 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: '/',
    ResPath: 'doconut-res/images',
    onViewerReady: function () {},
    onError: function (message) { console.error('DocViewer:', message); }
});
</script>

Các callback

Giữ các callback nhanh; gửi telemetry bất đồng bộ và không chặn việc render trang.

Nhóm phương thức công cộng

Tệp JavaScript cũng chứa các hàm 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.

Tùy chọn thử lại

Widget cũng chấp nhận retryOn409 và các cài đặt backoff của nó (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Chúng phục vụ các triển khai mà các trang được tạo trong nền. DocImage.axd render mỗi trang trong quá trình yêu cầu, vì vậy hãy để retryOn409 tắt.

Danh sách kiểm tra đường dẫn

• BasePath là '/' khi trình xử lý DocImage.axd nằm ở gốc site — thuộc tính path của trình xử lý trong Web.config quyết định nơi nó trả lời. Trong một thư mục ảo, sử dụng tên thư mục mà không có dấu / đầu ('myapp', không phải '/myapp': trình xem thêm dấu gạch chéo, và //myapp/... là một yêu cầu tới máy chủ khác).
• DoconutOptions.ResourcesPath là nơi mô-đun tài nguyên phục vụ các tệp nhúng (/doconut-res theo mặc định).
• ResPath chỉ tới thư mục con images của nó, cũng không có dấu / đầu ('doconut-res/images'). Đặt nó thành 'doconut-res' sẽ khiến mọi biểu tượng trả về 404 trong khi tài liệu vẫn được render.
• Trong MVC, routes.IgnoreRoute("doconut-res/{*pathInfo}") phải được đặt sau ResourcesPath nếu bạn thay đổi nó.
• 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ì.