文档配置

defaultUrl 必选

我们已经在 快速上手 中认识了它的用法,表示PDF文件的地址,

  • 类型:string

locale

设置语言环境

  • 类型:string
  • 默认值:zh-CN

resourcePath 必选

PDF Viewer 的运行依赖一些静态资源,该属性用来配置这些资源的所在路径,具体用法可以查看此处

  • 类型:string

defaultScaleValue

  • 类型:string

设置文档打开时默认缩放比例,可能的值包括:

说明
auto自动缩放
page-actual实际大小
page-fit适合页面
page-fit适合页面
page-width适合页宽
0.550%
0.7575%
1100%
1.25125%

以此类推

showAnnotationMenu

  • 类型:boolean
  • 默认值:false

PDF Viewer 内置了一个Annotation菜单栏,可用来改变要绘制的Annotation的类型,
设置为 true 来开启菜单,效果如图:

图片

你也可以通过设置 false 来关闭自带菜单栏的渲染,然后自己实现一个菜单栏,查看自定义菜单栏

disableCORSOriginCheck

关闭跨域资源检查。请确保你访问的PDF文件地址是受信任的,然后再设置为 true

  • 类型:boolean
  • 默认值:false

disableDocAnnotation

PDF源文件可能自带 Annotation 数据,如果你不想渲染它们,可以设置为 true.

  • 类型:boolean
  • 默认值:false

disableHistory

PDF Viewer 会记录当前文档的查看记录,如:当前页码、旋转角度、滚动位置、缩放比等,以便下次打开同一文档时恢复到上次的查看状态, 如果你不希望记录这内容,可以设置为 true

  • 类型:boolean
  • 默认值:false

disableRange

禁用 PDF 文件的分片加载。 启用后,如果服务器支持分片加载,则 PDF 将以分片的形式获取。

  • 类型:boolean
  • 默认值:false

disableStream

禁用 PDF 文件数据的流式传输。 默认情况下,PDF Viewer 会尝试分片加载 PDF 文件。

  • 类型:boolean
  • 默认值:false

author

当前打开文档的用户名称,最终会作为 Annotation 的 title 字段。

  • 类型:string
  • 默认值:anonymous

authorID

作者的 ID,与 author 为对应关系,如果设置了该值,会根据 authorID 判断某个 Annotation 的 author 是否为当前打开文档的用户, 如果不是,则不允许其修改该 Annotation 的内容;如果没有设置该值,则根据 author 值判断

  • 类型:string
  • 默认值:null

enableWordSegmentation

是否启用分词功能,启用后能更好的双击选词

  • 类型:boolean
  • 默认值:true

disablePopupList

是否禁用 Popup 列表的渲染,禁用后,Annotation 对应的 Popup 将不会渲染。

  • 类型:boolean
  • 默认值:false
  • 参考:Popup

disableDraggingAndDropping

是否禁用拖拽打开PDF文档,拖拽打开文档的功能默认是开启的,可以通过监听 fileinputchange 事件获取当前打开的PDF文件.

上次更新: