androidPdfReader

Method

概述

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

注意

Android 需要升级环境编译

open

打开一个 pdf 格式的文档

open({params},callback(ret))

params

path：

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

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  eventType: 'show'     //字符串类型；交互事件类型
                        //取值范围：
                        //show（打开文件成功）
                        //loadFail（下载文件失败）                    
}

示例代码

var androidPdfReader = api.require('androidPdfReader');
androidPdfReader.open({
    path: 'fs://res/test.pdf'
});

可用性

Android系统

可提供的1.0.0及更高版本

openView

打开pdf文档视图

openView({params},callback(ret))

params

rect：

类型：JSON 对象
描述：（可选项）原生插件的位置及尺寸
内部字段：

{
    x: 0,   //（可选项）数字类型；原生插件左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    y: 0,   //（可选项）数字类型；原生插件左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    w: 320, //（可选项）数字类型；原生插件的宽度；默认：auto
    h: 200  //（可选项）数字类型；原生插件的高度；默认：auto
}

path：

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

fixedOn：

类型：字符串类型
描述：（可选项）原生插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
默认：原生插件依附于当前 window

fixed:

类型：布尔
描述：（可选项）原生插件是否随所属 window 或 frame 滚动
默认值：true（不随之滚动）

callback(ret)

ret：

类型：JSON 对象
内部字段：

{
  eventType: 'show'     //字符串类型；交互事件类型
                        //取值范围：
                        //show（打开文件成功）   
                        //loadFail（下载失败）                
}

示例代码

var androidPdfReader = api.require('androidPdfReader');
androidPdfReader.openView({
    rect:{
      x:0,
      y:0,
      w:'auto',
      h:'auto'
    },
    path:'http://www.pdf.com/test.pdf',
    fixedOn:api.frameName,
    fixed:true
},function(ret){
    api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

Android系统

可提供的1.0.0及更高版本

hideView

隐藏文档视图

hideView({params})

示例代码

var androidPdfReader = api.require('androidPdfReader');
androidPdfReader.hideView();

可用性

Android系统

可提供的1.0.0及更高版本

showView

显示文档视图

showView({params})

示例代码

var androidPdfReader = api.require('androidPdfReader');
androidPdfReader.showView();

可用性

Android系统

可提供的1.0.0及更高版本

closeView

关闭文档视图

closeView({params})

示例代码

var androidPdfReader = api.require('androidPdfReader');
androidPdfReader.closeView();

可用性

Android系统

可提供的1.0.0及更高版本

clearCache

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

clearCache()

示例代码

var androidPdfReader = api.require('androidPdfReader');
androidPdfReader.clearCache();

可用性

Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？请保持联络！

最后更新于 2024/04/24