API知识点Word下载.docx
《API知识点Word下载.docx》由会员分享，可在线阅读，更多相关《API知识点Word下载.docx（130页珍藏版）》请在冰豆网上搜索。
pageParam：
JSON对象
（可选项）页面参数，新页面中可以通过api.pageParam获取
bounces：
若在config.xml里面配置了pageBounce，则默认值为配置的值，否则为false
（可选项）页面是否弹动
bgColor：
若在config.xml里面配置了windowBackground，则默认值为配置的值，否则透明
（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba（r,g,b,a）等，图片路径支持fs:
//、widget:
//等APICloud自定义文件路径协议，同时支持相对路径
scrollToTop：
（可选项）当点击状态栏，页面是否滚动到顶部。
若当前屏幕上不止一个页面的scrollToTop属性为true，则所有的都不会起作用。
只iOS有效
vScrollBarEnabled：
true
（可选项）是否显示垂直滚动条
hScrollBarEnabled：
（可选项）是否显示水平滚动条
scaleEnabled：
（可选项）页面是否可以缩放
slidBackEnabled：
（可选项）是否支持滑动返回。
iOS7.0及以上系统中，在新打开的页面中向右滑动，可以返回到上一个页面，该字段只iOS有效
slidBackType：
full
（可选项）当支持滑动返回时，设置手指在页面右滑的有效作用区域。
取值范围（full:
整个页面范围都可以右滑返回，edge:
在页面左边缘右滑才可以返回），该字段只iOS有效
animation：
（可选项）动画参数，不传时使用默认动画，type：
动画类型，subType：
动画子类型。
∙内部字段：
{
type:
"
none"
//动画类型（详见动画类型常量）
subType:
from_right"
//动画子类型（详见动画子类型常量）
duration:
300//动画过渡时间，默认300毫秒
}
showProgress：
（可选项）是否显示等待框，此参数即将废弃，使用progress参数代替。
若传了progress参数，此参数将忽略
progress：
（可选项）页面加载进度配置信息，若不传则无加载进度效果
//加载进度效果类型，默认值为default，取值范围为default|page，default等同于showProgress参数效果；
为page时，进度效果为仿浏览器类型，固定在页面的顶部
title:
//type为default时显示的加载框标题
text:
//type为default时显示的加载框内容
color:
//type为page时进度条的颜色，默认值为#45C01A，支持#FFF，#FFFFFF，rgb（255,255,255），rgba（255,255,255,1.0）等格式
delay：
数字
（可选项）window显示延迟时间，适用于将被打开的window中可能需要打开有耗时操作的模块时，可延迟window展示到屏幕的时间，保持UI的整体性
reload：
（可选项）页面已经打开时，是否重新加载页面，重新加载页面后apiready方法将会被执行
allowEdit：
（可选项）是否允许长按页面时弹出选择菜单
softInputMode：
auto
（可选项）当键盘弹出时，输入框被盖住时，当前页面的调整方式，详见键盘弹出页面调整方式常量；
只iOS有效，Android请在config.xml里面配置并云编译使用
customRefreshHeader：
（可选项）设置使用自定义下拉刷新模块的名称，设置后可以使用api.setCustomRefreshHeaderInfo方法来使用自定义下拉刷新组件
示例代码
api.openWin（{
name:
'
page1'
url:
./page1.html'
pageParam:
{
test'
}
}）;
补充说明
窗口操作
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
closeWin
关闭window
closeWin（{params}）
（可选项）window名字，不传时关闭当前window，为root时无效
//关闭当前window，使用默认动画
api.closeWin（）;
//关闭指定window，若待关闭的window不在最上面，则无动画
api.closeWin（{
closeToWin
关闭到指定window，最上面显示的window到指定name的window间的所有window都会被关闭
closeToWin（{params}）
window名字
api.closeToWin（{
root'
setWinAttr
设置window属性
setWinAttr（{params}）
（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba（r,g,b,a）等，图片路径支持fs:
//等APICloud自定义文件路径协议，同时支持相对路径
若当前屏幕上不止一个页面的scrollToTop属性为true，则所有的都不会起作用。
只iOS有效
iOS7.0及以上系统中，在新打开的页面中向右滑动，可以返回到上一个页面，该字段只iOS有效
api.setWinAttr（{
bounces:
true,
bgColor:
#fff'
vScrollBarEnabled:
hScrollBarEnabled:
scaleEnabled:
slidBackEnabled:
true
openFrame
打开frame
若frame已存在，则会把该窗口显示到最前面并显示，如果url和之前的url有变化，或者reload为true时，页面会刷新
此方法对frameGroup里面的frame不起作用
openFrame（{params}）
frame名字
页面地址，可以为本地文件路径，支持相对路径和绝对路径，以及widget:
（可选项）页面参数，在新页面通过api.pageParam获取
若在config.xml里面配置了pageBounce，则默认值为配置的值，否则为true
若在config.xml里面配置了frameBackgroundColor，则默认值为配置的值，否则透明
rect：
充满整个父页面
（可选项）frame的位置和大小，设置margin后，在不同手机上面会保持与父页面的各方向边距一致，而中间区域会自动扩充。
x:
0,//左上角x坐标
y:
0,//左上角y坐标
w:
320,//宽度，若传'
auto'
，页面从x位置开始自动充满父页面宽度
h:
480//高度，若传'
，页面从y位置开始自动充满父页面高度
marginLeft:
0,//相对父window左外边距的距离
marginTop:
0,//相对父window上外边距的距离
marginBottom:
0,//相对父window下外边距的距离
marginRight:
0//相对父window右外边距的距离
//加载进度效果类型，默认值为default，取值范围为default|page，default等同于showProgress参数效果；
为page时，进度效果为仿浏览器类型，固定在页面的顶部
//type为default时显示的加载框标题
//type为default时显示的加载框内容
//type为page时进度条的颜色，默认值为#45C01A，支持#FFF，#FFFFFF，rgb（255,255,255），rgba（255,255,255,1.0）等格式
（可选项）页面已经打开时，是否重新加载页面
（可选项）动画参数，不传时无动画，type：
api.openFrame（{
page2'
./page2.html'
rect:
0,
320,
480
},
rgba（0,0,0,0）'
closeFrame
关闭frame
closeFrame（{params}）
（可选项）frame名字，不传时关闭当前frame
api.closeFrame（{
setFrameAttr
设置frame属性
setFrameAttr（{params}）
frame名称
hidden：
（可选项）本frame是否隐藏（隐藏即从屏幕上移除，但不销毁）
（可选项）窗口区域
，页面从y位置开始自动充满父页面高度}
api.setFrameAttr（{
设置frame属性
bringFrameToFront
调整frame到前面
bringFrameToFront（{params}）
from：
待调整显示顺序的frame名字
to：
（可选项）frame名字，不传时调整from对应frame到最前面，否则调整from对应frame到此frame前面
api.bringFrameToFront（{
from:
to:
sendFrameToBack
调整frame到后面
sendFrameToBack（{params}）
（可选项）frame名字，不传时调整from对应frame到最后面，否则调整from对应frame到此frame后面
api.sendFrameToBack（{
setFrameClient
设置指定frame的页面加载监听，仅在window中调用生效，可以对多个frame进行监听。
setFrameClient（{params},callback（ret,err））
frameName：
callback（ret,err）
ret：
frame加载状态、加载进度等发生变化时的回调
state:
0,//加载状态，数字类型，取
升级会员 