API知识点Word下载.docx

1、pageParam：JSON 对象（可选项）页面参数，新页面中可以通过 api.pageParam 获取bounces：若在 config.xml 里面配置了pageBounce，则默认值为配置的值，否则为 false（可选项）页面是否弹动bgColor：若在 config.xml 里面配置了 windowBackground，则默认值为配置的值，否则透明（可选项）背景色，支持图片和颜色，格式为 #fff、#ffffff、rgba（r,g,b,a）等，图片路径支持 fs:/、widget:/等 APICloud 自定义文件路径协议，同时支持相对路径scrollToTop：（可选项）当点击状态栏

2、，页面是否滚动到顶部。若当前屏幕上不止一个页面的 scrollToTop 属性为 true，则所有的都不会起作用。只 iOS 有效vScrollBarEnabled：true（可选项）是否显示垂直滚动条hScrollBarEnabled：（可选项）是否显示水平滚动条scaleEnabled：（可选项）页面是否可以缩放slidBackEnabled：（可选项）是否支持滑动返回。iOS7.0及以上系统中，在新打开的页面中向右滑动，可以返回到上一个页面，该字段只 iOS 有效slidBackType：full（可选项）当支持滑动返回时，设置手指在页面右滑的有效作用区域。取值范围（full:整个页面范

3、围都可以右滑返回，edge:在页面左边缘右滑才可以返回），该字段只iOS有效animation：（可选项）动画参数，不传时使用默认动画，type：动画类型，subType：动画子类型。 内部字段： type:none, /动画类型（详见动画类型常量） subType:from_right, /动画子类型（详见动画子类型常量） duration:300 /动画过渡时间，默认300毫秒showProgress：（可选项）是否显示等待框，此参数即将废弃，使用 progress 参数代替。若传了 progress 参数，此参数将忽略progress：（可选项）页面加载进度配置信息，若不传则无加载进度效

4、果, /加载进度效果类型，默认值为 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 显示延迟时间，适用于将

5、被打开的 window 中可能需要打开有耗时操作的模块时，可延迟 window 展示到屏幕的时间，保持 UI 的整体性reload：（可选项）页面已经打开时，是否重新加载页面，重新加载页面后 apiready 方法将会被执行allowEdit：（可选项）是否允许长按页面时弹出选择菜单softInputMode：auto（可选项）当键盘弹出时，输入框被盖住时，当前页面的调整方式，详见键盘弹出页面调整方式常量；只iOS有效，Android请在 config.xml 里面配置并云编译使用customRefreshHeader：（可选项）设置使用自定义下拉刷新模块的名称，设置后可以使用 api.set

6、CustomRefreshHeaderInfo 方法来使用自定义下拉刷新组件示例代码api.openWin（ name: page1, url:./page1.html pageParam: test ）;补充说明窗口操作可用性iOS系统，Android系统可提供的1.0.0及更高版本closeWin关闭 windowcloseWin（params）（可选项）window 名字，不传时关闭当前 window，为 root 时无效/关闭当前window，使用默认动画api.closeWin（）;/关闭指定window，若待关闭的window不在最上面，则无动画api.closeWin（close

7、ToWin关闭到指定 window，最上面显示的 window 到指定 name 的 window 间的所有 window 都会被关闭closeToWin（params）window 名字api.closeToWin（rootsetWinAttr设置 window 属性setWinAttr（params）（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba（r,g,b,a）等，图片路径支持fs:/等APICloud自定义文件路径协议，同时支持相对路径若当前屏幕上不止一个页面的scrollToTop属性为true，则所有的都不会起作用。只iOS有效iOS7.0及以上系统中，

8、在新打开的页面中向右滑动，可以返回到上一个页面，该字段只iOS有效api.setWinAttr（ bounces: true, bgColor:#fff vScrollBarEnabled: hScrollBarEnabled: scaleEnabled: slidBackEnabled: trueopenFrame打开 frame若 frame 已存在，则会把该窗口显示到最前面并显示，如果 url 和之前的 url 有变化，或者 reload 为 true 时，页面会刷新此方法对 frameGroup 里面的 frame 不起作用openFrame（params）frame 名字页面地址，可

9、以为本地文件路径，支持相对路径和绝对路径，以及widget:（可选项）页面参数，在新页面通过 api.pageParam 获取若在 config.xml 里面配置了 pageBounce，则默认值为配置的值，否则为 true若在 config.xml 里面配置了 frameBackgroundColor，则默认值为配置的值，否则透明rect：充满整个父页面（可选项）frame 的位置和大小，设置 margin 后，在不同手机上面会保持与父页面的各方向边距一致，而中间区域会自动扩充。 x:0, /左上角x坐标 y:0, /左上角y坐标 w:320, /宽度，若传auto，页面从x位置开始自动充满

10、父页面宽度 h:480 /高度，若传，页面从y位置开始自动充满父页面高度 marginLeft:0, /相对父 window 左外边距的距离 marginTop:0, /相对父 window 上外边距的距离 marginBottom:0, /相对父 window 下外边距的距离 marginRight:0 /相对父 window 右外边距的距离, /加载进度效果类型，默认值为default，取值范围为default|page，default等同于showProgress参数效果；为page时，进度效果为仿浏览器类型，固定在页面的顶部, /type为default时显示的加载框标题, /type

11、为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关闭framecloseFrame（params）（可选项）frame 名字，不传时关闭当前 frameapi.closeFrame（setFrameAttr

12、设置frame属性setFrameAttr（params）frame 名称hidden：（可选项）本 frame 是否隐藏（隐藏即从屏幕上移除，但不销毁）（可选项）窗口区域，页面从y位置开始自动充满父页面高度api.setFrameAttr（设置 frame 属性bringFrameToFront调整 frame 到前面bringFrameToFront（params）from：待调整显示顺序的 frame 名字to：（可选项）frame 名字，不传时调整 from 对应 frame 到最前面，否则调整 from 对应 frame 到此 frame 前面api.bringFrameToFron

13、t（ 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, /加载状态，数字类型，取