openSlidLayout

打開側滑式布局

打開后，其所在 window 的 name 默認為 slidLayout，所以關閉整個側滑布局可以通過 api.closeWin({name:'slidLayout'}) 實現(xiàn)，同時可以通過 api.openWin({name:'slidLayout'})來把整個側滑顯示到最前面

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

params

type：

• 類型：字符串
• 默認值：all
• 描述：（可選項）側滑類型（left：左側滑、right：右側滑、all：左右側滑）。安卓暫只支持left。

leftEdge：

• 類型：數(shù)字
• 默認值：60
• 描述：（可選項）左側滑時，側滑 window 停留時露出的寬度。即將廢棄，用 slidPaneStyle 中 leftEdge 參數(shù)代替

rightEdge：

• 類型：數(shù)字
• 默認值：60
• 描述：（可選項）右側滑時，側滑 window 停留時露出的寬度。即將廢棄，用 slidPaneStyle 中 rightEdge 參數(shù)代替

slidPaneStyle：

• 類型：JSON 對象
• 默認值：無
• 描述：側滑層 window 樣式
• 內(nèi)部字段：

{
    leftEdge:           //（可選項）左側滑時，側滑window停留時露出的寬度，默認60，數(shù)字類型
    rightEdge:          //（可選項）右側滑時，側滑window停留時露出的寬度，默認60，數(shù)字類型
    leftScale:          //（可選項）左側滑時，側滑window移動時能縮放的最小倍數(shù)，0-1.0，默認1.0，數(shù)字類型，只支持iOS
    rightScale:         //（可選項）右側滑時，側滑window移動時能縮放的最小倍數(shù)，0-1.0，默認1.0，數(shù)字類型，只支持iOS
}

fixedPaneStyle：

• 類型：JSON 對象
• 默認值：無
• 描述：底部固定層 window 樣式
• 內(nèi)部字段：

{
    leftEdge:           //（可選項）左側滑時，固定window能向左移動的最大寬度，默認0，數(shù)字類型，只支持iOS
    rightEdge:          //（可選項）右側滑時，固定window能向右移動的最大寬度，默認0，數(shù)字類型，只支持iOS
    leftScale:          //（可選項）左側滑時，固定window向左移動時能縮放的最小倍數(shù)，0-1.0，默認1.0，數(shù)字類型，只支持iOS
    rightScale:         //（可選項）右側滑時，固定window向右移動時能縮放的最小倍數(shù)，0-1.0，默認1.0，數(shù)字類型，只支持iOS
    leftMaskBg:         //（可選項）左側滑時，固定window上面的遮罩層背景，支持顏色和圖片，默認rgba(0,0,0,0)，字符串類型，只支持iOS
    rightMaskBg:        //（可選項）右側滑時，固定window上面的遮罩層背景，支持顏色和圖片，默認rgba(0,0,0,0)，字符串類型，只支持iOS
    leftBg:             //（可選項）左側滑時，固定window后面的背景，縮放過程中后面的背景將會顯示出來，支持顏色和圖片，默認rgba(0,0,0,0)，字符串類型，只支持iOS
    rightBg:            //（可選項）右側滑時，固定window后面的背景，縮放過程中后面的背景將會顯示出來，支持顏色和圖片，默認rgba(0,0,0,0)，字符串類型，只支持iOS
}

fixedPane：

• 類型：JSON 對象
• 默認值：無
• 描述：底部固定層 window
• 內(nèi)部字段：

{
    name:'',                            // window名字（字符串類型）
    url:'',                             // 頁面地址，可以為本地文件路徑，支持相對路徑和絕對路徑，以及widget://、fs://等協(xié)議路徑，也可以為遠程地址
    pageParam:{},                       //（可選項）頁面參數(shù)，頁面中可以通過api.pageParam獲取，JSON對象
    bgColor:'',                         //（可選項）背景色，支持圖片和顏色，格式為#fff、#ffffff、rgba(r,g,b,a)等，圖片路徑支持fs://、widget://等APICloud自定義文件路徑協(xié)議，同時支持相對路徑
    bounces:false,                      //（可選項）是否彈動，默認值：若在 config.xml 里面配置了pageBounce，則默認值為配置的值，否則為false
    scrollToTop:false                   //（可選項）當點擊狀態(tài)欄，頁面是否滾動到頂部。若當前屏幕上不止一個頁面的scrollToTop屬性為true，則所有的都不會起作用。默認值：true。只iOS有效
    scrollEnabled:true                  //（可選項）頁面內(nèi)容超出后是否可以滾動，默認為true，只支持iOS
    vScrollBarEnabled:true,             //（可選項）是否顯示垂直滾動條，默認true 
    hScrollBarEnabled:true,             //（可選項）是否顯示水平滾動條，默認true
    scaleEnabled:true,                  //（可選項）頁面是否可以縮放，布爾型，默認值：false
    allowEdit:false,                    //（可選項）是否允許長按頁面時彈出選擇菜單
    softInputMode:'auto'                //（可選項）當鍵盤彈出時，輸入框被蓋住時，當前頁面的調(diào)整方式，只iOS有效
                                        //取值范圍：
                                        //resize      //若鍵盤蓋住輸入框，頁面會自動上移
                                        //pan         //若鍵盤蓋住輸入框，頁面不會自動上移
                                        //auto        //默認值，由系統(tǒng)決定如何處理，iOS平臺該字段等同于resize
    softInputBarEnabled:false,          //（可選項）是否顯示鍵盤上方的工具條，布爾型，默認值：true，只iOS有效
    defaultRefreshHeader:''             //（可選項）設置使用默認下拉刷新類型，取值范圍：pull、swipe
    customRefreshHeader:''              //（可選項）設置使用自定義下拉刷新模塊的名稱，設置后可以使用api.setCustomRefreshHeaderInfo方法來使用自定義下拉刷新組件
}

slidPane：

• 類型：JSON 對象
• 默認值：無
• 描述：側滑層window
• 內(nèi)部字段：

{
    name:'',                            // window名字（字符串類型）
    url:'',                             // 頁面地址，可以為本地文件路徑，支持相對路徑和絕對路徑，以及widget://、fs://等協(xié)議路徑，也可以為遠程地址
    pageParam:{},                       //（可選項）頁面參數(shù)，頁面中可以通過api.pageParam獲取，JSON對象
    bgColor:'',                         //（可選項）背景色，支持圖片和顏色，格式為#fff、#ffffff、rgba(r,g,b,a)等，圖片路徑支持fs://、widget://等APICloud自定義文件路徑協(xié)議，同時支持相對路徑
    bounces:false,                      //（可選項）是否彈動，默認值：若在 config.xml 里面配置了pageBounce，則默認值為配置的值，否則為false
    scrollToTop:false                   //（可選項）當點擊狀態(tài)欄，頁面是否滾動到頂部。若當前屏幕上不止一個頁面的scrollToTop屬性為true，則所有的都不會起作用。默認值：true。只iOS有效
    scrollEnabled:true                  //（可選項）頁面內(nèi)容超出后是否可以滾動，默認為true，只支持iOS
    vScrollBarEnabled:true,             //（可選項）是否顯示垂直滾動條，默認true 
    hScrollBarEnabled:true,             //（可選項）是否顯示水平滾動條，默認true
    scaleEnabled:true,                  //（可選項）頁面是否可以縮放，布爾型，默認值：false
    allowEdit:false,                    //（可選項）是否允許長按頁面時彈出選擇菜單
    softInputMode:'auto'                //（可選項）當鍵盤彈出時，輸入框被蓋住時，當前頁面的調(diào)整方式，只iOS有效
                                        //取值范圍：
                                        //resize       //若鍵盤蓋住輸入框，頁面會自動上移
                                        //pan          //若鍵盤蓋住輸入框，頁面不會自動上移
                                        //auto         //默認值，由系統(tǒng)決定如何處理，iOS平臺該字段等同于resize
    softInputBarEnabled:false,          //（可選項）是否顯示鍵盤上方的工具條，布爾型，默認值：true，只iOS有效
    defaultRefreshHeader:''             //（可選項）設置使用默認下拉刷新類型，取值范圍：pull、swipe
    customRefreshHeader:''              //（可選項）設置使用自定義下拉刷新模塊的名稱，設置后可以使用api.setCustomRefreshHeaderInfo方法來使用自定義下拉刷新組件
}

callback(ret, err)

ret：

• 類型：JSON 對象
• 描述：手指頭觸摸屏幕，引起開始側滑時的回調(diào)，左右側滑時應該在這里面判斷顯示左邊頁面還是右邊頁面
• 內(nèi)部字段：

{
    type: 'left'        //側滑方向，left或right
    event: 'slide'      //側滑事件，（slide-當前處于滑動狀態(tài)、open-側滑打開狀態(tài)、close-側滑關閉狀態(tài)
}

示例代碼

api.openSlidLayout({
    type: 'left',
    fixedPane: {
        name: 'win1',
        url: 'win1.html'
    },
    slidPane: {
        name: 'win2',
        url: 'win2.html'
    }
}, function(ret, err) {


});

可用性

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

可提供的1.0.0及更高版本