选项

类型

默认值

描述

acceleration

Boolean

true

设置硬件加速模式，用于触摸设备此值必须是真的

autoCenter

Boolean

false

是否居中

display

String

single

single 单页书，double 双页书

duration

Number

600

设置翻页动画时间，单位：毫秒

gradients

Number

true

置翻页时是否显示翻页跟阴影

height

Number

null

设置高度

page

Number

1

返回当前页数

pages

Number

Dom的页数

页码总数

when

Object

{}

监听事件

width

Number

null

设置宽度

监听事件名

介绍

返回值

turning

翻页前触发

event--事件对象 整个动画书，

page-- 翻页后的页码，

view-- 翻页后的dom

turned

翻页后触发

event--事件对象

page-- 翻页后的页码，

view-- 翻页后的dom

start

页面开始时触发

event--事件对象

page-- 页码，

pageObject -- 页面数据

end

页面停止时触发

event--事件对象

page-页码，

pageObject -- 页面数据

first

第一页触发

event--事件对象

last

最后一页触发

event--事件对象

zooming

当缩放改变时触发此事件

event--事件对象

newFactor -- 新的缩放比例

current -- 当前缩放比例

方法名

参数1

参数2

描述

addPage

element

需要添加的dom元素

pageNumber

可选，你希望插入页面的位置，默认值为当前的总页数+1（最后一页）

将页面添加到动画书中

display

displayMode

display 的类型 single，double 默认值为double

无

控制书是单页书还是双页书

disable

disable （Boolean）

True表示禁用效果，false表示启用

无

禁用和启用效果。如果它被禁用，用户将不能够更改当前页面（效果，所有书页不允许翻动，鼠标移动到书角不会有翻页动画）

destroy

$(‘#flipbook’).turn(‘destroy’); 只销毁书页，不销毁容器

$(‘#flipbook’).turn(‘destroy’).remove();

容器也销毁

销毁动画书。它将删除DOM和内存

hasPage

pageNumber

要查询的是第几页

无

如果页在内存中，则返回true

next

$(‘#flipbook’).turn(‘next’);

无

将视图转到下一个视图（翻到下一页）

is

if (!$(‘#flipbook’).turn(‘is’)) { $(‘#flipbook’).turn();

}

无

检测选择器是否有turn.js实例（检查当前选中的dom元素是否已经转化为动画书了）

page

page

需要跳转到的界面

无

跳转到指定界面

pages

pages

页面总数

无

设置动画书的页数。如果数字的页面数小于当前页面数，它将删除这些超出范围的页面

peel

corner

 可选值tl（左上）, tr（右上）, bl, br, r, l.

无

显示一个剥落的角落--（展示一个书角的翻页hover）

previous

$(‘#flipbook’).turn(‘previous’

无

将视图转换为上一个视图-（跳转到翻页前的页面）

range

pageNumber

范围内的页码。此参数

是可选的，默认值是当前的DOM上下标

无

它返回一个由两个值组成的数组，第一个数值表示当切换到pageNumber页时DOM中存在的第一页的下标，第二个数值表格DOM中存在的最后一页的下标，为了动态添加新页面，使用这个方法是必须的。

removePage

pageNumber

要删除的页码数

无

从DOM中删除页面及其所有引用

resize

无

无

重新计算所有页面的位置

size

width

宽度

height

高度

设置书的尺寸

stop

无

无

停止当前动画。例如，可以直接跳转到指定页面，（不带动画）

zoom

factor

倍数2能增大一倍 0.5则缩小一倍

duration

缩放动画持续时间（毫秒）默认值为500

按比例缩书的大小