API知识点.docx

1、API知识点打开window若 window 已存在，则会把该 window 显示到最前面，如果 url 和之前的 url 有变化，或者 reload 为 true 时，页面会刷新，但是该 window 里面已经打开的 frame 等不会移除若当前正在进行 openWin、closeWin 等带动画过渡的 window 操作，调用此方法会失效openWin(params)paramsname： 类型：字符串 默认值：无 描述：window 名字，不能为空字符串url： 类型：字符串 默认值：无 描述：页面地址，可以为本地文件路径，支持相对路径和绝对路径，以及 widget:/、fs:/等协议路

2、径，也可以为远程地址useWKWebView： 类型：布尔 默认值：false 描述：（可选项）是否使用WKWebView来加载页面，只支持iOS8.0及以上系统。WKWebView是iOS8新出的WebKit库中的 控件，相比于以前的UIWebView，在性能和功能等方面都有所提升。注意使用WKWebView后，localStorage可能不能和其它未使用 WKWebView加载的页面通用，同时也不支持方法结果同步返回。pageParam： 类型：JSON 对象 默认值：无 描述：（可选项）页面参数，新页面中可以通过 api.pageParam 获取bounces： 类型：布尔 默认值：若在

3、 config.xml 里面配置了pageBounce，则默认值为配置的值，否则为 false 描述：（可选项）页面是否弹动bgColor： 类型：字符串 默认值：若在 config.xml 里面配置了 windowBackground，则默认值为配置的值，否则透明 描述：（可选项）背景色，支持图片和颜色，格式为 #fff、#ffffff、rgba(r,g,b,a)等，图片路径支持 fs:/、widget:/等 APICloud 自定义文件路径协议，同时支持相对路径scrollToTop： 类型：布尔 默认值：false 描述：（可选项）当点击状态栏，页面是否滚动到顶部。若当前屏幕上不止一个页

4、面的 scrollToTop 属性为 true，则所有的都不会起作用。只 iOS 有效vScrollBarEnabled： 类型：布尔 默认值：true 描述：（可选项）是否显示垂直滚动条hScrollBarEnabled： 类型：布尔 默认值：true 描述：（可选项）是否显示水平滚动条scaleEnabled： 类型：布尔 默认值：false 描述：（可选项）页面是否可以缩放slidBackEnabled： 类型：布尔 默认值：true 描述：（可选项）是否支持滑动返回。iOS7.0及以上系统中，在新打开的页面中向右滑动，可以返回到上一个页面，该字段只 iOS 有效slidBackType

5、： 类型：字符串 默认值：full 描述：（可选项）当支持滑动返回时，设置手指在页面右滑的有效作用区域。取值范围（full:整个页面范围都可以右滑返回，edge:在页面左边缘右滑才可以返回），该字段只iOS有效animation： 类型：JSON 对象 默认值：无 描述：（可选项）动画参数，不传时使用默认动画，type：动画类型，subType：动画子类型。 内部字段： type:none, /动画类型（详见动画类型常量） subType:from_right, /动画子类型（详见动画子类型常量） duration:300 /动画过渡时间，默认300毫秒showProgress： 类型：布尔

6、默认值：false 描述：（可选项）是否显示等待框，此参数即将废弃，使用 progress 参数代替。若传了 progress 参数，此参数将忽略progress： 类型：JSON 对象 默认值：无 描述：（可选项）页面加载进度配置信息，若不传则无加载进度效果 内部字段： type:, /加载进度效果类型，默认值为 default，取值范围为 default|page，default 等同于 showProgress 参数效果；为 page 时，进度效果为仿浏览器类型，固定在页面的顶部 title:, /type 为 default 时显示的加载框标题 text:, /type 为 defau

7、lt 时显示的加载框内容 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： 类型

8、：布尔 默认值：false 描述：（可选项）是否允许长按页面时弹出选择菜单softInputMode： 类型：字符串 默认值：auto 描述：（可选项）当键盘弹出时，输入框被盖住时，当前页面的调整方式，详见键盘弹出页面调整方式常量；只iOS有效，Android请在 config.xml 里面配置并云编译使用customRefreshHeader： 类型：字符串 默认值：无 描述：（可选项）设置使用自定义下拉刷新模块的名称，设置后可以使用 api.setCustomRefreshHeaderInfo 方法来使用自定义下拉刷新组件示例代码api.openWin( name: page1, url:

9、 ./page1.html, pageParam: name: test );补充说明窗口操作可用性iOS系统，Android系统可提供的1.0.0及更高版本closeWin关闭 window若当前正在进行 openWin、closeWin 等带动画过渡的 window 操作，调用此方法会失效closeWin(params)paramsname： 类型：字符串 默认值：无 描述：（可选项）window 名字，不传时关闭当前 window，为 root 时无效animation： 类型：JSON 对象 默认值：无 描述：（可选项）动画参数，不传时使用默认动画，type：动画类型，subType：

10、动画子类型。 内部字段： 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 间的所有

11、window 都会被关闭若当前正在进行 openWin、closeWin 等带动画过渡的 window 操作，调用此方法会失效closeToWin(params)paramsname： 类型：字符串 默认值：无 描述：window 名字animation： 类型：JSON 对象 默认值：无 描述：（可选项）动画参数，不传时使用默认动画，type：动画类型，subType：动画子类型。 内部字段： type:none, /动画类型（详见动画类型常量） subType:from_right, /动画子类型（详见动画子类型常量） duration:300 /动画过渡时间，默认300毫秒示例代码api

12、.closeToWin( name: root);补充说明无可用性iOS系统，Android系统可提供的1.0.0及更高版本setWinAttr设置 window 属性setWinAttr(params)paramsbounces： 类型：布尔 默认值：无 描述：（可选项）页面是否弹动bgColor： 类型：字符串 默认值：无 描述：（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba(r,g,b,a)等，图片路径支持fs:/、widget:/等APICloud自定义文件路径协议，同时支持相对路径scrollToTop： 类型：布尔 默认值：无 描述：（可选项）当点击状态

13、栏，页面是否滚动到顶部。若当前屏幕上不止一个页面的scrollToTop属性为true，则所有的都不会起作用。只iOS有效vScrollBarEnabled： 类型：布尔 默认值：无 描述：（可选项）是否显示垂直滚动条hScrollBarEnabled： 类型：布尔 默认值：无 描述：（可选项）是否显示水平滚动条scaleEnabled： 类型：布尔 默认值：无 描述：（可选项）页面是否可以缩放slidBackEnabled： 类型：布尔 默认值：无 描述：（可选项）是否支持滑动返回。iOS7.0及以上系统中，在新打开的页面中向右滑动，可以返回到上一个页面，该字段只iOS有效softInput

14、Mode： 类型：字符串 默认值：无 描述：（可选项）当键盘弹出时，输入框被盖住时，当前页面的调整方式，详见键盘弹出页面调整方式常量；只iOS有效，Android请在 config.xml 里面配置并云编译使用示例代码api.setWinAttr( bounces: true, bgColor: #fff, vScrollBarEnabled: true, hScrollBarEnabled: true, scaleEnabled: true, slidBackEnabled: true);补充说明无可用性iOS系统，Android系统可提供的1.0.0及更高版本openFrame打开 fra

15、me若 frame 已存在，则会把该窗口显示到最前面并显示，如果 url 和之前的 url 有变化，或者 reload 为 true 时，页面会刷新此方法对 frameGroup 里面的 frame 不起作用openFrame(params)paramsname： 类型：字符串 默认值：无 描述：frame 名字url： 类型：字符串 默认值：无 描述：页面地址，可以为本地文件路径，支持相对路径和绝对路径，以及widget:/、fs:/等协议路径，也可以为远程地址useWKWebView： 类型：布尔 默认值：false 描述：（可选项）是否使用WKWebView来加载页面，只支持iOS8.0

16、及以上系统。WKWebView是iOS8新出的WebKit库中的 控件，相比于以前的UIWebView，在性能和功能等方面都有所提升。注意使用WKWebView后，localStorage可能不能和其它未使用 WKWebView加载的页面通用，同时也不支持方法结果同步返回。pageParam： 类型：JSON 对象 默认值：无 描述：（可选项）页面参数，在新页面通过 api.pageParam 获取bounces： 类型：布尔 默认值：若在 config.xml 里面配置了 pageBounce，则默认值为配置的值，否则为 true 描述：（可选项）页面是否弹动bgColor： 类型：字符串

17、默认值：若在 config.xml 里面配置了 frameBackgroundColor，则默认值为配置的值，否则透明 描述：（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba(r,g,b,a)等，图片路径支持fs:/、widget:/等 APICloud 自定义文件路径协议，同时支持相对路径scrollToTop： 类型：布尔 默认值：true 描述：（可选项）当点击状态栏，页面是否滚动到顶部。若当前屏幕上不止一个页面的 scrollToTop 属性为 true，则所有的都不会起作用。只iOS有效vScrollBarEnabled： 类型：布尔 默认值：true 描述

18、：（可选项）是否显示垂直滚动条hScrollBarEnabled： 类型：布尔 默认值：true 描述：（可选项）是否显示水平滚动条scaleEnabled： 类型：布尔 默认值：false 描述：（可选项）页面是否可以缩放rect： 类型：JSON 对象 默认值：充满整个父页面 描述：（可选项）frame 的位置和大小，设置 margin 后，在不同手机上面会保持与父页面的各方向边距一致，而中间区域会自动扩充。 内部字段： x:0, /左上角x坐标 y:0, /左上角y坐标 w:320, /宽度，若传auto，页面从x位置开始自动充满父页面宽度 h:480 /高度，若传auto，页面从y位置

19、开始自动充满父页面高度 marginLeft:0, /相对父 window 左外边距的距离 marginTop:0, /相对父 window 上外边距的距离 marginBottom:0, /相对父 window 下外边距的距离 marginRight:0 /相对父 window 右外边距的距离showProgress： 类型：布尔 默认值：false 描述：（可选项）是否显示等待框，此参数即将废弃，使用 progress 参数代替。若传了 progress 参数，此参数将忽略progress： 类型：JSON 对象 默认值：无 描述：（可选项）页面加载进度配置信息，若不传则无加载进度效果 内

20、部字段： 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 描述：（可选项）页面已经打开时

21、，是否重新加载页面allowEdit： 类型：布尔 默认值：false 描述：（可选项）是否允许长按页面时弹出选择菜单softInputMode： 类型：字符串 默认值：auto 描述：（可选项）当键盘弹出时，输入框被盖住时，当前页面的调整方式，详见键盘弹出页面调整方式常量；只iOS有效，Android请在 config.xml 里面配置并云编译使用animation： 类型：JSON 对象 默认值：无 描述：（可选项）动画参数，不传时无动画，type：动画类型，subType：动画子类型。 内部字段： type:none, /动画类型（详见动画类型常量） subType:from_right

22、, /动画子类型（详见动画子类型常量） 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

23、,0,0,0), vScrollBarEnabled: true, hScrollBarEnabled: true);补充说明无可用性iOS系统，Android系统可提供的1.0.0及更高版本closeFrame关闭framecloseFrame(params)paramsname： 类型：字符串 默认值：无 描述：（可选项）frame 名字，不传时关闭当前 frame示例代码api.closeFrame( name: page2);补充说明无可用性iOS系统，Android系统可提供的1.0.0及更高版本setFrameAttr设置frame属性setFrameAttr(params)par

24、amsname： 类型：字符串 默认值：无 描述：frame 名称bounces： 类型：布尔 默认值：无 描述：（可选项）页面是否弹动hidden： 类型：布尔 默认值：无 描述：（可选项）本 frame 是否隐藏（隐藏即从屏幕上移除，但不销毁）bgColor： 类型：字符串 默认值：无 描述：（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba(r,g,b,a)等，图片路径支持fs:/、widget:/等 APICloud 自定义文件路径协议，同时支持相对路径scrollToTop： 类型：布尔 默认值：无 描述：（可选项）当点击状态栏，页面是否滚动到顶部。若当前屏幕

25、上不止一个页面的 scrollToTop 属性为 true，则所有的都不会起作用。只iOS有效vScrollBarEnabled： 类型：布尔 默认值：无 描述：（可选项）是否显示垂直滚动条hScrollBarEnabled： 类型：布尔 默认值：无 描述：（可选项）是否显示水平滚动条scaleEnabled： 类型：布尔 默认值：无 描述：（可选项）页面是否可以缩放rect： 类型：JSON 对象 默认值：无 描述：（可选项）窗口区域 内部字段： x:0, /左上角x坐标 y:0, /左上角y坐标 w:320, /宽度，若传auto，页面从x位置开始自动充满父页面宽度 h:480 /高度，若

26、传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

27、属性可用性iOS系统，Android系统可提供的1.0.0及更高版本bringFrameToFront调整 frame 到前面bringFrameToFront(params)paramsfrom： 类型：字符串 默认值：无 描述：待调整显示顺序的 frame 名字to： 类型：字符串 默认值：无 描述：（可选项）frame 名字，不传时调整 from 对应 frame 到最前面，否则调整 from 对应 frame 到此 frame 前面示例代码api.bringFrameToFront( from: page1, to: page2);补充说明调整 frame 到前面可用性iOS系统，An

28、droid系统可提供的1.0.0及更高版本sendFrameToBack调整 frame 到后面sendFrameToBack(params)paramsfrom： 类型：字符串 默认值：无 描述：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)paramsframeName： 类型：字符串 默认值：无 描述：frame 名字callback(ret, err)ret： 类型：JSON 对象 描述：frame 加载状态、加载进度等发生变化时的回调 内部字段： state:0, /加载状态，数字类型，取