pdfPlus

立即使用

openPdfViewer hidePdfViewer showPdfViewer closePdfViewer openPdfPage hidePdfPage showPdfPage closePdfPage

概述

pdfPlus 封装了可查看pdf的视图。视图分为两种一种为上下滑动查看，另一种为左右翻页查看。

openPdfViewer

打开一个上下滑动的pdf查看视图

openPdfViewer({params},callback(ret))

params

rect:

  • 类型：JSON对象类型

  • 描述：（可选项）位置参数

  • 内部参数

{
    x:,    //数字类型；视图左上角x坐标，默认0
    y:,    //数字类型；视图左上角y坐标，默认0
    w:,    //数字类型；视图宽,默认充满当前frame或win
    h:,     //数字类型；视图高，默认充满当前frame或win
}

path：

  • 类型：字符串
  • 描述：文档的路径，支持 widget://、fs://

backGroundColor

  • 类型：字符串类型
  • 描述：当前视图背景色
  • 默认：“#CCCCCC”

fixedOn：

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

fixed:

  • 类型：布尔类型
  • 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
  • 默认：false

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
  eventType: 'show'     //字符串类型；交互事件类型
                        //取值范围：
                        //show（打开文件成功）
                      //loadComplete(加载成功,iOS不支持)
                      //pageChanged(当前页变化,iOS不支持)
  pageCount:,          //数字类型；总页数 加载成功后返回
  currentPage:,       //数字类型；当前页 页面切换时返回，iOS不支持
}

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.openPdfViewer({
    path: '',
},function(ret,err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hidePdfViewer

隐藏上下滑动的pdf查看视图

hidePdfViewer({params},callback(ret))

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.hidePdfViewer();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showPdfViewer

显示上下滑动的pdf查看视图

showPdfViewer({params},callback(ret))

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.showPdfViewer();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

closePdfViewer

关闭上下滑动的pdf查看视图

closePdfViewer({params},callback(ret))

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.closePdfViewer();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openPdfPage

打开一个左右翻页的pdf查看视图

openPdfPage({params},callback(ret))

params

rect:

  • 类型：JSON对象类型

  • 描述：（可选项）位置参数

  • 内部参数

{
    x:,    //数字类型；视图左上角x坐标，默认0
    y:,    //数字类型；视图左上角y坐标，默认0
    w:,    //数字类型；视图宽,默认充满当前frame或win
    h:,     //数字类型；视图高，默认充满当前frame或win
}

path：

  • 类型：字符串
  • 描述：文档的路径，支持 widget://、fs://

index:

  • 类型：数字
  • 描述：（可选项）打开指定页的页码，从1开始
  • 默认值：1

backGroundColor

  • 类型：字符串类型
  • 描述：当前视图背景色
  • 默认：“#CCCCCC”

fixedOn：

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

fixed:

  • 类型：布尔类型
  • 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
  • 默认：false

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
  eventType: 'show'     //字符串类型；交互事件类型
                        //取值范围：
                        //show（打开文件成功）
                      //loadComplete(加载成功,iOS不支持)
                      //pageChanged(当前页变化)
  pageCount:,          //数字类型；总页数 加载成功后返回
  currentPage:,       //数字类型；当前页 页面切换时返回
}

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.openPdfPage({
    path: '',
},function(ret,err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hidePdfPage

隐藏左右翻页的pdf查看视图

hidePdfPage({params},callback(ret))

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.hidePdfPage();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showPdfPage

显示左右翻页的pdf查看视图

showPdfPage({params},callback(ret))

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.showPdfPage();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

closePdfPage

关闭左右翻页的pdf查看视图

closePdfPage({params},callback(ret))

示例代码

var pdfPlus = api.require('pdfPlus');
pdfPlus.closePdfPage();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本