docReader

立即使用

论坛示例

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

概述

docReader 模块封装了对文档阅读的功能,开发者直接传进来一个文档,即可读出文档的内容显示出来,目前支持的文档格式主要有 excel、doc、pdf 等。

注意:

  • 由于系统差异,在 Android 端本模块是打开当前设备支持打开目标文本文件的 App 列表,然后用户选择指定某个 App 打开目标文本。

  • openDocView、closeDocView、hideDocView、showDocView 仅支持 iOS 平台

open

打开一个文档 (注意:在Android系统上调用此接口会打开第三方APP,通过第三方app阅读文档,而非在应用内打开)

open({params}, callback(ret, err))

params

path:

  • 类型:字符串
  • 描述:打开文档的路径,要求本地路径( widget://,fs:// )

autorotation:

  • 类型:布尔
  • 描述:(可选项)是否适应当前设备自动旋转屏幕方向。仅iOS平台支持
  • 默认:false

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true        //布尔类型;操作成功状态值,true|false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: ''          //数字类型;错误描述码,取值范围如下:
                      //-1(未知错误)
                      //1(文件不存在)
                      //2(文件格式不支持)
}

示例代码

var docReader = api.require('docReader');
docReader.open({
    path: 'widget://res/test.docx',
    autorotation: false
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addEventListener

监听交互事件,仅对 open 接口打开的文档阅读器有效

addEventListener(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: finish        //字符串类型;交互事件类型
}

示例代码

var docReader = api.require('docReader');
docReader.addEventListener(function(ret, err) {
      alert(JSON.stringify(ret));
});

可用性

iOS系统,Android系统

可提供的 1.0.3 及更高版本

openDocView

打开一个文档,仅支持 iOS 端

openDocView({params}, callback(ret, err))

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 内部字段:
{
    x: 0,   //(可选项)数字类型;地图左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
    y: 0,   //(可选项)数字类型;地图左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
    w: 320, //(可选项)数字类型;地图的宽度;默认:'auto'
    h: 480  //(可选项)数字类型;地图的高度;默认:'auto'
}

path:

  • 类型:字符串
  • 描述:打开文档的路径,要求本地路径( widget://,fs:// )

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

fixed:

  • 类型:布尔
  • 描述:(可选项)模块是否随所属 window 或 frame 滚动
  • 默认值:true(不随之滚动)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true        //布尔类型;操作成功状态值,true|false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: ''          //数字类型;错误描述码,取值范围如下:
                      //-1(未知错误)
                      //1(文件不存在)
                      //2(文件格式不支持)
}

示例代码

var docReader = api.require('docReader');
docReader.openDocView({
    rect: {
        x: 0,
        y: 0,
        w: 375,
        h:330
    },
    fixedOn: api.frameName,
    fixed: true,
    path: 'widget://res/2.pdf'
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS 系统

可提供的 1.0.3 及更高版本

closeDocView

关闭 openDocView 打开的文档预览区域,仅支持 iOS 端

closeDocView()

示例代码

var docReader = api.require('docReader');
docReader.closeDocView();

可用性

iOS 系统

可提供的 1.0.3 及更高版本

showDocView

显示 openDocView 打开的文档预览区域,仅支持 iOS 端

showDocView()

示例代码

var docReader = api.require('docReader');
docReader.showDocView();

可用性

iOS 系统

可提供的 1.0.3 及更高版本

hideDocView

隐藏 openDocView 打开的文档预览区域,仅支持 iOS 端

hideDocView()

示例代码

var docReader = api.require('docReader');
docReader.hideDocView();

可用性

iOS 系统

可提供的 1.0.3 及更高版本

论坛示例

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