openFrameGroup

打開frame組

若frame組已存在，則會(huì)把該frame組顯示到最前面。frame組打開后，當(dāng)前頁面加載完成后，頁面會(huì)預(yù)加載后面指定個(gè)數(shù)頁面

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

params

name：

• 類型：字符串
• 默認(rèn)值：無
• 描述：frame 組名字

background：

• 類型：字符串
• 默認(rèn)值：無
• 描述：（可選項(xiàng)）frame 組背景，顏色（#fff,#ffffff,rgba(r,g,b,a)）或圖片（支持文件路徑協(xié)議和相對路徑）

scrollEnabled：

• 類型：布爾
• 默認(rèn)值：true
• 描述：（可選項(xiàng)）frame 組是否能夠左右滾動(dòng)

fixedOn：

• 類型：字符串
• 默認(rèn)值：若當(dāng)前在tabLayout組件中為ui_layout，否則為ui_window
• 描述：（可選項(xiàng)）frameGroup所要添加到的目標(biāo)頁面。
• 取值范圍：

ui_window    //頁面添加到當(dāng)前window中。若當(dāng)前在tabLayout組件中，頁面只能添加到navigationBar和tabBar之間的區(qū)域，無法覆蓋在navigationBar、tabBar之上。
ui_layout    //頁面添加到當(dāng)前tabLayout中。此時(shí)頁面能夠添加到tabLayout中任意位置，能夠覆蓋在navigationBar、tabBar之上，只在tabLayout組件中有效。

rect：

• 類型：JSON 對象
• 默認(rèn)值：充滿整個(gè)父頁面
• 描述：（可選項(xiàng)）設(shè)置frameGroup的位置和大小。如果要固定寬高則使用x、y、w、h等參數(shù)；如果要自適應(yīng)狀態(tài)欄高度變化、橫豎屏切換等，則需要使用margin相關(guān)參數(shù)，不能使用w、h固定寬高。推薦使用margin相關(guān)參數(shù)來布局。
• 內(nèi)部字段：

{
    x:,             //左上角x坐標(biāo)，數(shù)字類型
    y:,             //左上角y坐標(biāo)，數(shù)字類型
    w:,             //寬度，若傳'auto'，頁面從x位置開始自動(dòng)充滿父頁面寬度，數(shù)字或固定值'auto'
    h:,             //高度，若傳'auto'，頁面從y位置開始自動(dòng)充滿父頁面高度，數(shù)字或固定值'auto'


    marginLeft:,    //相對父頁面左外邊距的距離，數(shù)字類型
    marginTop:,     //相對父頁面上外邊距的距離，數(shù)字類型
    marginBottom:,  //相對父頁面下外邊距的距離，數(shù)字類型
    marginRight:    //相對父頁面右外邊距的距離，數(shù)字類型
}

index：

• 類型：數(shù)字
• 默認(rèn)值：0
• 描述：（可選項(xiàng)）默認(rèn)顯示的頁面索引

preload：

• 類型：數(shù)字
• 默認(rèn)值：1
• 描述：（可選項(xiàng)）預(yù)加載的 frame 個(gè)數(shù)，默認(rèn)加載當(dāng)前頁后面一個(gè)

frames：

• 類型：數(shù)組
• 默認(rèn)值：無
• 描述：frame 數(shù)組
• 內(nèi)部字段：

[{
    name:'',                                //frame名字，字符串類型，不能為空字符串
    url:'',                                 //頁面地址，可以為本地文件路徑，支持相對路徑和絕對路徑，以及 widget://、fs://等協(xié)議路徑，也可以為遠(yuǎn)程地址。 當(dāng)data參數(shù)不為空時(shí)，url將做為baseUrl，data中的html引用的資源文件根路徑以該url為基礎(chǔ)。字符串類型
    data:'',                                //（可選項(xiàng)）頁面加載的數(shù)據(jù)內(nèi)容，可以為html片段或者整張html文件的數(shù)據(jù)
    headers:{},                             //（可選項(xiàng)）請求頭
    avm:false,                              //（可選項(xiàng)）是否使用原生引擎來加載頁面，頁面必須是使用avm框架語法生成。
    useWKWebView:false,                     //（可選項(xiàng)）是否使用WKWebView來加載頁面。參考[WKWebView介紹](https://community.apicloud.com/bbs/thread-151904-1-1.html)。
    allowAccessFromFile:false,              //（可選項(xiàng)）設(shè)置是否可以在本地頁面中訪問本地或遠(yuǎn)程資源，為保證代碼安全，在開啟全局加密情況下默認(rèn)禁止訪問。只在useWKWebView參數(shù)為true時(shí)有效。
    historyGestureEnabled:false,            //（可選項(xiàng)）是否可以通過手勢來進(jìn)行歷史記錄前進(jìn)后退，只在useWKWebView參數(shù)為true時(shí)有效。
    pageParam:{},                           //（可選項(xiàng)）頁面參數(shù)，頁面中可以通過api.pageParam獲取，JSON對象
    bounces:true,                           //（可選項(xiàng)）是否彈動(dòng)，布爾型，默認(rèn)值：若在 config.xml 里面配置了pageBounce，則默認(rèn)值為配置的值，否則為true。注意如果頁面使用了上拉、下拉刷新等功能，該屬性可能會(huì)被刷新組件重新設(shè)置。
    bgColor:'#fff',                         //（可選項(xiàng)）背景色，支持圖片和顏色，格式為#fff、#ffffff、rgba(r,g,b,a)等，圖片路徑支持fs://、widget://等APICloud自定義文件路徑協(xié)議，同時(shí)支持相對路徑
    scrollToTop:true                        //（可選項(xiàng)）當(dāng)點(diǎn)擊狀態(tài)欄，頁面是否滾動(dòng)到頂部。若當(dāng)前屏幕上不止一個(gè)頁面的scrollToTop屬性為true，則所有的都不會(huì)起作用。默認(rèn)值：true。只iOS有效
    scrollEnabled:true                      //（可選項(xiàng)）頁面內(nèi)容超出后是否可以滾動(dòng)，默認(rèn)為true，只支持iOS
    vScrollBarEnabled:true,                 //（可選項(xiàng)）是否顯示垂直滾動(dòng)條，布爾型，默認(rèn)值：true
    hScrollBarEnabled:false,                //（可選項(xiàng)）是否顯示水平滾動(dòng)條，布爾型，默認(rèn)值：false
    scaleEnabled:true,                      //（可選項(xiàng)）頁面是否可以縮放，布爾型，默認(rèn)值：false
    allowEdit:false,                        //（可選項(xiàng)）是否允許長按頁面時(shí)彈出選擇菜單
    softInputMode:'auto'                    //（可選項(xiàng)）當(dāng)鍵盤彈出時(shí)，輸入框被蓋住時(shí)，當(dāng)前頁面的調(diào)整方式，只iOS有效。
                                            //取值范圍：
                                            //resize    //若鍵盤蓋住輸入框，頁面會(huì)自動(dòng)上移
                                            //pan       //若鍵盤蓋住輸入框，頁面不會(huì)自動(dòng)上移
                                            //auto      //默認(rèn)值，由系統(tǒng)決定如何處理，iOS平臺(tái)該字段等同于resize
    softInputBarEnabled:false,              //（可選項(xiàng)）是否顯示鍵盤上方的工具條，布爾型，默認(rèn)值：true，只iOS有效
    overScrollMode,                         //（可選項(xiàng)）設(shè)置頁面滾動(dòng)到頭部或尾部時(shí)，顯示回彈陰影效果的模式，僅Android有效。取值范圍：never，always，scrolls
    defaultRefreshHeader:''                 //（可選項(xiàng)）設(shè)置使用默認(rèn)下拉刷新類型，取值范圍：pull、swipe
    customRefreshHeader:''                  //（可選項(xiàng)）設(shè)置使用自定義下拉刷新模塊的名稱，設(shè)置后可以使用api.setCustomRefreshHeaderInfo方法來使用自定義下拉刷新組件
}]

callback(ret, err)

ret：

• 類型：JSON 對象
• 描述：當(dāng)前顯示在屏幕上的 frame 變化時(shí)會(huì)回調(diào)
• 內(nèi)部字段：

{
    name:'',         //當(dāng)前 frame 名稱
    index:0          //當(dāng)前 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;
});

可用性

iOS系統(tǒng)，Android系統(tǒng)

可提供的1.0.0及更高版本