ViewerConfig
客户端查看器小部件选项
ViewerConfig(命名空间 Doconut)描述浏览器查看器的外观和行为。它不影响文档渲染质量;请使用格式配置来控制。C# 类和旧版 JavaScript 插件的默认值不同,因此请显式映射值。
C# 属性
| 类型 | 属性 | 默认值 | 描述 |
|---|---|---|---|
bool | ShowThumbs | true | 显示缩略图面板。 |
bool | AutoLoad | false | 初始化后自动加载。正常的令牌流会显式调用 View(token)。 |
bool | AutoFocus | true | 在初始化期间将浏览器焦点/滚动移动到查看器。 |
bool | AutoPageFocus | true | 在页面切换时保持当前缩略图可见。 |
int | PageZoom | 100 | 初始缩放百分比。 |
int | ZoomStep | 10 | 缩放命令添加或移除的百分比。 |
int | MaxZoom | 300 | 最大缩放百分比。 |
bool | ShowToolTip | true | 滚动时显示页面位置工具提示。 |
string | ToolTipPageText | "Page " | 页面工具提示中使用的前缀。 |
bool | CacheEnabled | false | 在浏览器内存中保留页面图像的移动窗口。它不使用 localStorage。 |
bool | LargeDoc | false | 为大型文档以定时批次追加页面元素。 |
bool | ShowHyperlinks | false | 当服务器配置提取超链接时渲染覆盖层。 |
bool | FixedZoom | true | 使用固定的缩放百分比,而不是响应式重新计算。 |
int | FixedZoomPercent | 100 | 固定的桌面缩放。 |
int | FixedZoomPercentMobile | 75 | 固定的移动端缩放。 |
string | BasePath | "/" | 查看器发送页面请求的位置。"/" 在站点根目录为 DocImage.axd;否则为主机映射 UseDoconut() 的分支,不带前导 /("doconut" 意味着 /doconut/DocImage.axd)。 |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" before) | 小部件加载其自身图像的文件夹:ResourcesPath 下的 images 文件夹,不带前导 /。 |
string | FitType | "width" | "width"、"height" 或为空表示不自动适配。当前小部件不接受 "page"。 |
bool | RetryOn409 | false | 当异步/分布式页面生成响应 202 Accepted 时启用轮询;为兼容旧服务器也接受 409。普通同步查看器不需要此功能。 |
csharp
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // 没有前导 '/':查看器会自动添加它("/doconut" 将变成 //doconut,另一个主机)
ResPath = "doconut-res/images",
ShowHyperlinks = true
};C# 到 JavaScript 映射
不要将直接序列化的 ViewerConfig 传递给 docViewer(...)。大多数小部件键采用 camelCase,而三个已确定的路径/适配键采用 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 |
JavaScript 默认值
该小部件具有不同于 C# 类的旧默认值。以下数值来自当前的 docViewer.js 实现。
| 选项 | 默认值 | 备注 |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | 缩略图面板宽度范围。 |
showThumbs | true | 初始缩略图可见性。 |
autoFocus / autoPageFocus | true / false | autoPageFocus 与 C# 默认值不同。 |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | 像素单位的缩略图几何尺寸。 |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom 与 C# 不同(300)。 |
showToolTip / toolTipPageText | true / "Page " | 页面位置工具提示。 |
format / doc / AccessToken | "" / 0 / "" | 内部初始化值;通常由 View(token) 填充。 |
debugMode | false | 额外的客户端诊断信息。 |
FitType | "" | 除非提供,否则不自动适配。 |
BasePath | "DocImage.axd" | 旧版处理程序默认值。针对 ASP.NET Core 请显式设置。 |
ResPath | "" | 显式设置为嵌入图像路径。 |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | 内存中的页面预加载窗口和延迟。 |
autoLoad | false | 建议使用显式令牌流。 |
largeDoc | true | 与 C# 默认值不同。 |
fixedZoom | false | 与 C# 默认值不同。 |
fixedZoomPercent / fixedZoomPercentMobile | 100 / 50 | 移动端值与 C# 不同(75)。 |
showHyperlinks | true | 需要服务器端提取以生成覆盖层。 |
请设置所有行为关键的值,而不要依赖任一默认设置:
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>回调
| 回调 | 参数 | 目的 |
|---|---|---|
onPageLoading | pageNum | 页面请求正在开始。 |
onPageLoaded | pageNum | 页面图像已加载完成。 |
onThumbnailClicked | pageNum | 用户选择了缩略图。 |
onPageClicked | pageNum | 用户选择了页面。 |
onDoubleClick | none | 查看器收到双击。 |
onViewerBusy | none | 查看器进入忙碌状态。 |
onViewerReady | none | 初始化完成。 |
onViewerError | none | 查看器进入错误状态。 |
onError | message | 操作返回错误信息。 |
onCopy | data | 可获取文本复制数据。 |
onAutoLoadStatus | pageNum | 自动加载已进展到页面。 |
onThumbsShown | none | 缩略图面板变为可见。 |
onAnnLoaded | none | 注释数据已加载。 |
onAnnSaved | none | 注释数据已保存。 |
onAnnSaveError | none | 注释保存失败。 |
onAnnClosed | none | 注释 UI 已关闭。 |
保持回调快速;异步发送遥测数据,避免阻塞页面渲染。
公共方法组
| 组 | 常用方法 |
|---|---|
| 生命周期 | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| 导航 | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| 缩放与适配 | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| 方向 | Rotate(page, angle), Flip(page, flipType) |
| 缩略图 | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| 搜索 | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| 注释 | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| 复制 | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
JavaScript 文件也包含内部辅助函数。仅将参考 UI 使用并在此处或功能指南中记录的方法视为稳定的集成点。
当分布式页面仍在渲染时重试
retryOn409 保留其历史名称。它用于异步页面生成,并重试当前的 202 Accepted 就绪响应以及较旧的 409 Conflict 信号。启用后,部件会使用以下 JavaScript 默认值进行轮询:
| 选项 | 默认 |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
对普通查看器保持禁用。启用它并不能将不受支持的同步渲染转换为异步渲染。
路径检查清单
DoconutOptions.MiddlewarePath必须描述您实际映射的分支。BasePath必须指向该分支,写时不带前导/('doconut',而不是'/doconut':查看器会添加斜杠,且//doconut/...是对另一个主机的请求)。DoconutOptions.ResourcesPath是嵌入式资源路径。ResPath通常指向其images子文件夹,同样不带前导/('doconut-res/images')。ExtractHyperlinks必须在服务器格式配置中启用,才能让showHyperlinks显示任何内容。
此页面对您有帮助吗?