pdfViewer

openView

preView

category

clearCache

showView

hideView

closeView

论坛示例

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

概述

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

注意

Android 需要升级环境编译

openView

打开pdf文档视图

openView()

params

path

  • 类型：字符串
  • 描述：（必须）文档的路径，支持 fs://、http://、https:// 等本地和网络协议
  • 注意：对于网络资源插件会先下载完成然后再打开，开发者可通过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对象
  • 内部字段：

    {	
        cmd:"openView",//成功打开pdf；
        data:'success'
    }

示例代码


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

可用性

Android系统

可提供的1.0.0及更高版本

preView

打开pdf文档缩略图

params

bgColor:

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

preView()

callback(ret, err)

ret：

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


    {	
        cmd:"preView",
        data:'success'
    }

示例代码


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

可用性

Android系统

可提供的1.0.0及更高版本

category

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

category()

callback(ret, err)

ret：

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


    {	
        cmd:"category",
        data:'success'//如果pdf文档没有做目录，则会返回来失败
    }

示例代码


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

可用性

Android系统

可提供的1.0.0及更高版本

clearCache

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

clearCache()

callback(ret, err)

ret：

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


    {	
        cmd:"clearCache",
        data:'success'
    }

示例代码


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

可用性

Android系统

可提供的1.0.0及更高版本

showView

显示文档视图

showView()

callback(ret, err)

ret：

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


    {	
        cmd:"showView",
        data:'success'
    }

示例代码


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

可用性

Android系统

可提供的1.0.0及更高版本

hideView

隐藏文档视图

hideView()

callback(ret, err)

ret：

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


    {	
        cmd:"hideView",
        data:'success'
    }

示例代码


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

可用性

Android系统

可提供的1.0.0及更高版本

closeView

关闭文档视图

closeView()

callback(ret, err)

ret：

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


    {	
        cmd:"closeView",
        data:'success'
    }

示例代码


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

可用性

Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/11/18