pdfViewer

preView clearCache hideView

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

pdfViewer 封装了一个简单的 pdf 阅读器，本模块只支持阅读 pdf 格式的文档，本模块支持对网络 pdf 文件的阅读，当传入一个网络路径，模块内部会先下载文件到本地缓存文件，然后再打开读取。用户再次打开相同路径的网络文件时，则先读取缓存在本地的文件。

注意

Android 需要升级环境编译

openView

打开pdf文档视图

openView()

path

  • 类型：字符串
  • 描述：（必须）文档的路径，支持 fs://、 等本地和网络协议
  • 注意：对于网络资源模块会先下载完成然后再打开，开发者可通过clearCache接口清除下载到本地的文件

page

  • 描述：（可选）定位显示到哪一页。

clearCache

  • 类型：布尔型
  • 描述：（可选）在打开http或者https路径时关闭是否删除掉缓存，true为删除，false为不删除，默认为false。

rect

  • 类型：JSON 对象
  • 描述：（可选项）摄像头区域的位置及尺寸
  • 内部字段：
  • {
    • x: 0, //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    • y: 0, //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    • w: 320, //（可选项）数字类型；模块的宽度；默认：所属的 Window 或 Frame 的宽度
    • h: 300 //（可选项）数字类型；模块的高度；默认：w的3/4 }

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：

示例代码

  2.     var param = {
  3.         page:5,
  4.         clearCache:false,
  5.         path:'fs://mydownload/1.pdf',
  6.     };
  7.     var pdfViewer = api.require('pdfViewer');
  8.     pdfViewer.openView(param, function(ret, err){ });

可用性

Android系统

可提供的1.0.0及更高版本

preView

params

bgColor:

  • 类型：字符串
  • 描述：（可选项）预览视图和目录视图的背景色，默认为（#EE5E94A2），可带透明。

preView()

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"preView",
  5.         data:'success'
  6.     }

示例代码

  2.     var pdfViewer = api.require('pdfViewer');
  3.     pdfViewer.preView({bgColor:'#ff0000'},function(ret,err){})

Android系统

可提供的1.0.0及更高版本

category

打开pdf文档目录结构视图（如果pdf文档没有做目录，则会返回来失败）

category()

callback(ret, err)

ret：

  • 类型：JSON对象

示例代码

  2.     var pdfViewer = api.require('pdfViewer');
  3.     pdfViewer.category(function(ret,err){})

可用性

Android系统

可提供的1.0.0及更高版本

clearCache

清除缓存到本地的文件，本接口只清除本模块缓存的数据，若要清除本app缓存的所有数据这调用api.clearCache

clearCache()

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"clearCache",
  5.         data:'success'
  6.     }

示例代码

  2.     var pdfViewer = api.require('pdfViewer');

可用性

Android系统

showView

显示文档视图

showView()

ret：

  • 类型：JSON对象
  • 内部字段：

示例代码

  2.     var pdfViewer = api.require('pdfViewer');
  3.     pdfViewer.showView(function(ret,err){})

可用性

Android系统

可提供的1.0.0及更高版本

hideView

隐藏文档视图

hideView()

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     {    
  4.         cmd:"hideView",
  5.         data:'success'
  6.     }

示例代码

  2.     var pdfViewer = api.require('pdfViewer');
  3.     pdfViewer.preView(function(ret,err){})

可用性

Android系统

可提供的1.0.0及更高版本

closeView

关闭文档视图

closeView()

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  3.     pdfViewer.closeView(function(ret,err){})

可用性

Android系统