epub

open

addEventListener

removeEventListener

setValue

getChapters

openChapter

getBrightness

setBrightness

resetWithProgress

getAllbooks

deleteBookWithBook

setNightMode

close

概述

本插件实现阅读epub格式电子书功能，可以将阅读书籍存入本地，具有记录阅读位置和阅读器相关设置的功能。可以设置夜间阅读模式，也可以根据进度跳转对应章节。

open

打开阅读器

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

params

path：

  • 类型：字符串
  • 描述：epub文件路径，支持fs,widget

bookId：

  • 类型：字符串
  • 描述：文件存入本地的唯一标识，不同文件标识应为唯一，不同文件不可重复传入

currentChapter：

  • 类型：数字
  • 描述：（可选项）打开书籍的章节数
  • 默认值：第一次打开电子书默认值为 1，第二次及以后默认值为上一次打开的章节

bg：

  • 类型：字符串
  • 描述：（可选项）阅读器的背景，支持颜色（rgb，rgba，#）和图片（支持fs,widget）
  • 默认值：第一次打开阅读器默认值为 #fff，第二次及以后默认值为上一次打设置的背景，

textColor：

  • 类型：字符串
  • 描述：（可选项）阅读器显示文字颜色
  • 默认值：第一次打开阅读器默认值为 #000，第二次及以后默认值为上一次设置的文字颜色

textSize：

  • 类型：数字
  • 描述：（可选项）阅读器显示文字字体大小
  • 默认值：第一次打开阅读器默认值为 12，第二次及以后默认值为上一次打设置的文字字体大小

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：点击的事件类型；
  • 内部字段：
{
    currentChapter:'',        //字符串类型，当前章节
    currentChapterTitle:'',   //字符串类型，当前章节标题
    progress:'',              //字符串类型，当前进度（1-100），可为小数
    
}

示例代码

var epub = api.require('epub');
epub.open({
    bookId:'123',
    path: 'fs://test.epub'
}, function(ret) {
     api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统

可提供的1.0.0及更高版本

addEventListener

添加监听

addEventListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON对象
  • 内部字段：
{
       eventType : 'gestureTap',  //字符串类型；事件类型
       // 取值范围：
       //gestureTap : 点击阅读器事件（单击手势）点击阅读器 上下左右角会进行翻页操作，不会监听到该事件
       //gestureDoubleTap : 双击阅读器事件（双击手势）

}

示例代码

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

可用性

iOS系统

可提供的1.0.0及更高版本

removeEventListener

移除添加监听

removeEventListener()

示例代码

var epub = api.require('epub');
epub.removeEventListener();

可用性

iOS系统

可提供的1.0.0及更高版本

setValue

设置阅读器的参数

setValue({params})

params

bg：

  • 类型：字符串
  • 描述：（可选项）阅读器的背景色，支持颜色（rgb，rgba，#）和图片（支持fs,widget）
  • 默认值：当前背景色

currentChapter：

  • 类型：数字
  • 描述：（可选项）打开的章节数
  • 默认值：当前章节

textColor：

  • 类型：字符串
  • 描述：（可选项）文字颜色
  • 默认值：当前文字颜色

textSize：

  • 类型：数字
  • 描述：（可选项）文字字体大小。重新设置字体大小后，会重新分页，触发分页的事件
  • 默认值：当前字体大小

示例代码

var epub = api.require('epub');
epub.setValue({
    bg: '#000',
    textColor: '#fff',
    textSize: 15
});

可用性

iOS系统

可提供的1.0.0及更高版本

getChapter

获取章节列表

getChapters(callback(ret))

callback(ret)

ret：

  • 类型：JSON对象
  • 描述：获取的章节列表；
  • 内部字段：
{
    chapters:[{			//JSON对象数组
        title:''		   //章节标题，字符串类型
        playOrder:''	   //章节序列号，数字类型
    }]
}

示例代码

var epub = api.require('epub');
epub.getChapters(function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } 
});

可用性

iOS系统

可提供的1.0.0及更高版本

openChapter

打开指定章节

openChapter({params})

params

currentChapter：

  • 类型：数字
  • 描述：（可选项）打开的章节数

示例代码

var epub = api.require('epub');
epub.openChapter({
   currentChapter:6
});

可用性

iOS系统

可提供的1.0.0及更高版本

getBrightness

获取当前屏幕亮度值

getBrightness(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    brightness:            //数字类型；当前屏幕亮度值
}

示例代码

var epub = api.require('epub');
epub.getBrightness(function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } 
});

可用性

iOS系统

可提供的1.0.0及更高版本

setBrightness

设置屏幕亮度

setBrightness({params})

params

brightness：

  • 类型：数字
  • 描述：设置的屏幕的亮度，取值范围：0-100，在 iOS 平台上设置的是系统屏幕亮度。Android 平台上设置的本应用内的屏幕亮度
  • 默认值：当前屏幕亮度

示例代码

var epub = api.require('epub');
epub.setBrightness({
    brightness: 50
});

可用性

iOS系统

可提供的1.0.0及更高版本

resetWithProgress

根据进度跳转对应章节

resetWithProgress({params})

params

progress：

  • 类型：数字
  • 描述：进度值（0-100），可为小数

示例代码

var epub = api.require('epub');
epub.resetWithProgress({
  progress:10.5
});

可用性

iOS系统

可提供的1.0.0及更高版本

getAllbooks

获取全部本地书籍

getAllbooks(callback(ret))

callback(ret)

ret：

  • 类型：JSON对象
  • 描述：获取的书籍文件列表；
  • 内部字段：
{
    allBook:[{			
        bookName:'',		   //书籍名称
        currentChapter:'',	//阅读到的章节
        bookId:'',          //唯一标识符
    }]
}

示例代码

var epub = api.require('epub');
epub.getAllbooks(function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } 
});

可用性

iOS系统

可提供的1.0.0及更高版本

deleteBookWithBook

删除一本书籍

deleteBookWithBook({params})

params

bookId：

  • 类型：字符
  • 描述：书记唯一标识符

示例代码

var epub = api.require('epub');
epub.deleteBookWithBook({
  bookId:'111'
});

可用性

iOS系统

可提供的1.0.0及更高版本

setNightMode

设置夜间模式

setNightMode({params})

params

isNightMode：

  • 类型：布尔
  • 描述：是否开启夜间模式
  • 默认：true

示例代码

var epub = api.require('epub');
epub.setNightMode({
   isNightMode:true
});

可用性

iOS系统

可提供的1.0.0及更高版本

close

关闭阅读器

close()

示例代码

var epub = api.require('epub');
epub.close();

可用性

iOS系统

可提供的1.0.0及更高版本

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