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