bookReader
来自于：官方立即使用
论坛示例
为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。
概述
本模块是原生实现的一个文本阅读器，开发者只要传进来一个 text 文本文件，配置相应的参数，模块底层即可实现一个翻页效果的图书阅读器
open
打开阅读器
open({params}, callback(ret, err))
params
x：
- 类型：数字
- 描述：（可选项）模块视图左上角点的坐标
- 默认值： 0
y：
- 类型：数字
- 描述：（可选项）模块视图左上角点的坐标
- 默认值：0
w：
- 类型：数字
- 描述：（可选项）模块视图的宽
- 默认值：当前设备屏幕的宽
h：
- 类型：数字
- 描述：（可选项）模块视图的高
- 默认值：当前设备屏幕的高
bg：
- 类型：字符串
- 描述：（可选项）阅读器的背景色，支持 rgb，rgba，img，#
- 默认值：#FFFFF0
animType：
- 类型：字符串
- 描述：翻页动画效果，可为空。（保留使用）
- 默认值：curl
- 取值范围：
- curl ：翻页效果
- scroll ：滚动效果 （仅ios支持）
- empty : 无效果 （iOS点击翻页，点击左侧屏幕向上翻页，点击右侧向下翻页）
progress：
- 类型：数字
- 描述：（可选项）阅读器打开时的进度的百分比，取值范围 0-100
- 默认值：最近一次关闭时的进度百分比
textStyle：
- 类型：JSON 对象
- 描述：（可选项）阅读文本字体样式设置
- 默认值：见内部字段
- 内部字段：
{
size： //（可选项）字体大小，数字，默认12
color: //（可选项）字体颜色，字符串，支持 rgb，rgba，#，默认#424242
}
filePath：
- 类型：字符串
- 描述：阅读器数据源文件地址，支持 widget 等本地路径协议，必传
codingType：
- 类型：字符串
- 描述：（可选项）所要阅读的文本的编码格式，取值范围:gbk、utf8
- 默认值：gbk
fixedOn：
- 类型：字符串类型
- 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认：模块依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
- 默认值：true
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
eventType: //事件类型，字符串，取值范围
- show //打开完成并显示
- click //点击（中间区域）
- page_up //向上翻页（点击左边或向右滑动）
- page_down //向下翻页（点击右边或向左滑动）
- page_over //在最后一页时的下翻页事件（deprecated）
- page_end //在最后一页时的下翻页事件
- page_begin //在第一页时的上翻页事件
- longPress //长按
progress: //阅读当前进度（翻页时）
}
示例代码
var bookReader = api.require('bookReader');
bookReader.open({
filePath: 'widget://res/test.txt'
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统，Android 系统
可提供的1.0.0及更高版本
setValue
设置阅读器的参数
setValue({params}, callback(ret, err))
params
bg：
- 类型：字符串
- 描述：（可选项）阅读器的背景色，支持 rgb，rgba，img，#
- 默认值：#FFFFFF
- 备注：若不传或传空字符串，则不刷新背景
animType：
- 类型：字符串
- 描述：翻页动画效果，可为空。（保留使用）
- 默认值：curl
- 取值范围：
- curl ：翻页效果
- scroll ：滚动效果
progress：
- 类型：数字
- 描述：（可选项）阅读器打开时的进度百分比，取值范围 0-100
- 默认值：0
- 备注：若不传或传空，则表示不刷新进度
textStyle：
- 类型：JSON 对象
- 描述：（可选项）阅读文本字体样式设置
- 备注：若不传或传空，则表示不刷新文本字体样式
- 默认值：见内部字段
- 内部字段：
{
size： //（可选项）字体大小，数字，默认12，不传或传空则不刷新
color: //（可选项）字体颜色，字符串，支持 rgb，rgba，#，不传或传空则不刷新
}
filePath：
- 类型：字符串
- 描述：（可选项）阅读器数据源文件地址，支持 widget 等本地路径协议
- 备注：不传或传空则不刷新数据源
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true //操作成功状态值，布尔值
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg:''//错误描述，字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.setValue({
bg: '#f00'
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统，Android 系统
可提供的1.0.0及更高版本
show
显示阅读器
show(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true //操作成功状态值，布尔值
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg:'' //错误描述，字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.show({
textStyle: {
size: 15
}
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
hide
隐藏阅读器
hide(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true //操作成功状态值，布尔值
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg: '' //错误描述，字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.hide(function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
close
关闭阅读器
close(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true //操作成功状态值，布尔值
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg: '' //错误描述,字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.close(function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getProgress
关获取指定文件的阅读进度
getProgress({params}, callBack(ret, err))
params
filePath：
- 类型：字符串
- 描述：所要获取当前阅读进度的文件地址
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: //状态值，布尔值
progress: //进度，数字
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg: '' //错误描述,字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.getProgress({
filePath: 'widget://README.md'
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统，Android系统
可提供的1.0.1及更高版本
setBrightness
设置屏幕亮度，iOS 平台上设置的是系统屏幕亮度，Android 平台上设置的是本 APP 内的屏幕亮度
setBrightness({params}, callBack(ret, err))
params
brightness：
- 类型：数字
- 描述：（可选项）设置的屏幕的亮度，取值范围 0-100
- 默认值：80
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: //是否设置成功，布尔值
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg: '' //错误描述,字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.setBrightness({
brightness: 80
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统，Android系统
可提供的1.0.1及更高版本
getBrightness
获取屏幕亮度，iOS 平台上获取的是系统屏幕亮度，Android 平台上获取的是本 APP 内的屏幕亮度
getBrightness(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: //是否设置成功，布尔值
brightness: //返回的当前屏幕亮度，数字类型
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg: '' //错误描述,字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.getBrightness(function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
补充说明
在Android 平台上，若当前设备屏幕亮度为自动调节，则此接口获取的是非自动调节时的亮度
可用性
iOS系统，Android系统
可提供的1.0.1及更高版本
brightness
获取、设置屏幕亮度，iOS 平台上操作的是系统屏幕亮度，Android 平台上操作的是本 APP 内的屏幕亮度
brightness({params}, callBack(ret, err))
params
brightness：
- 类型：数字
- 描述：（可选项）设置的屏幕的亮度，取值范围 0-100
- 备注：若不传则本接口返回当前屏幕亮度
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: //是否设置成功，布尔值
brightness: //params为空时返回当前屏幕亮度，数字类型
}
err：
- 类型：JSON 对象
- 内部字段：
{
msg: “” //错误描述,字符串
}
示例代码
var bookReader = api.require('bookReader');
bookReader.brightness({
brightness: 80
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
补充说明
若本接口不传参数则表示获取当前设备屏幕亮度，在 Android 平台上，若当前设备屏幕亮度为自动调节，则此接口获取的是非自动调节时的亮度
可用性
iOS系统，Android系统
可提供的1.0.1及更高版本
论坛示例
为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。