APICloud学习笔记1：openFrameGroup

最新推荐文章于 2023-04-26 08:39:53 发布

古道白云

最新推荐文章于 2023-04-26 08:39:53 发布

阅读量3.8k

点赞数

分类专栏： APICloud 文章标签： APICloud openFrameGroup

本文链接：https://blog.csdn.net/weixin_42467031/article/details/84938620

版权

APICloud 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

打开frame组

若frame组已存在，则会把该frame组显示到最前面。frame组打开后，当前页面加载完成后，页面会预加载后面指定个数页面

openFrameGroup({params}, callback(ret, err))

params

name：

类型：字符串
默认值：无
描述：frame 组名字

background：

类型：字符串
默认值：无
描述：（可选项）frame 组背景，颜色（#fff,#ffffff,rgba(r,g,b,a)）或图片（支持文件路径协议和相对路径）

scrollEnabled：

类型：布尔
默认值：true
描述：（可选项）frame 组是否能够左右滚动

rect：

类型：JSON 对象
默认值：充满整个父页面
描述：（可选项）frameGroup 的位置和大小，设置 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右外边距的距离
}

index：

类型：数字
默认值：0
描述：（可选项）默认显示的页面索引

preload：

类型：数字
默认值：1
描述：（可选项）预加载的 frame 个数，默认加载当前页后面一个

frames：

类型：数组
默认值：无
描述：frame 数组
内部字段：

[{
    name:'',                                //frame名字，字符串类型，不能为空字符串
    url:'',                                 //页面地址，可以为本地文件路径，支持相对路径和绝对路径，以及 widget://、fs://等协议路径，也可以为远程地址。 当data参数不为空时，url将做为baseUrl，data中的html引用的资源文件根路径以该url为基础。字符串类型
    data:'',                                //（可选项）页面加载的数据内容，可以为html片段或者整张html文件的数据
    headers:{},                             //（可选项）请求头
    useWKWebView:false,                        //（可选项）是否使用WKWebView来加载页面。WKWebView具有Safari相同的JavaScript引擎，支持更多的HTML5特性，相比于UIWebView，在性能和功能方面都有很大提升。只支持iOS8.0及以上系统。
    historyGestureEnabled:false,            //（可选项）是否可以通过手势来进行历史记录前进后退，只在useWKWebView参数为true时有效。
    pageParam:{},                           //（可选项）页面参数，页面中可以通过api.pageParam获取，JSON对象
    bounces:true,                           //（可选项）是否弹动，布尔型，默认值：若在 config.xml 里面配置了pageBounce，则默认值为配置的值，否则为true
    bgColor:'#fff',                         //（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba(r,g,b,a)等，图片路径支持fs://、widget://等APICloud自定义文件路径协议，同时支持相对路径
    scrollToTop:true                        //（可选项）当点击状态栏，页面是否滚动到顶部。若当前屏幕上不止一个页面的scrollToTop属性为true，则所有的都不会起作用。默认值：true。只iOS有效
    scrollEnabled:true                        //（可选项）页面内容超出后是否可以滚动，默认为true，只支持iOS
    vScrollBarEnabled:true,                 //（可选项）是否显示垂直滚动条，布尔型，默认值：true
    hScrollBarEnabled:false,                //（可选项）是否显示水平滚动条，布尔型，默认值：false
    scaleEnabled:true,                      //（可选项）页面是否可以缩放，布尔型，默认值：false
    allowEdit:false,                        //（可选项）是否允许长按页面时弹出选择菜单
    softInputMode:'auto'                    //（可选项）当键盘弹出时，输入框被盖住时，当前页面的调整方式，只iOS有效。
                                            //取值范围：
                                            //resize            //若键盘盖住输入框，页面会自动上移
                                            //pan                //若键盘盖住输入框，页面不会自动上移
                                            //auto                //默认值，由系统决定如何处理，iOS平台该字段等同于resize
    softInputBarEnabled:false,                //（可选项）是否显示键盘上方的工具条，布尔型，默认值：true，只iOS有效
    overScrollMode,                    //（可选项）设置页面滚动到头部或尾部时，显示回弹阴影效果的模式，仅Android有效。取值范围：never，always，scrolls
    customRefreshHeader:''                    //（可选项）设置使用自定义下拉刷新模块的名称，设置后可以使用api.setCustomRefreshHeaderInfo方法来使用自定义下拉刷新组件
}]

callback(ret, err)

ret：

类型：JSON 对象
描述：当前显示在屏幕上的 frame 变化时会回调
内部字段：

{
    name:'',         //当前 frame 名称
    index:0          //当前 frame 索引
}

示例代码

api.openFrameGroup({
    name: 'group1',
    rect: {
        x: 0,
        y: 0,
        w: 'auto',
        h: 'auto'
    },
    frames: [{
        name: 'frame1',
        url: 'frame1.html',
        bgColor: '#fff'
    }, {
        name: 'frame2',
        url: 'frame2.html',
        bgColor: '#fff'
    }]
}, function(ret, err) {
    var index = ret.index;
});