openWin_w3cschool

打开window

若window已存在，则会把该window显示到最前面，同时若url有变化或者reload参数为true时，页面会重新加载。

openWin({params})

params

name：

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

url：

类型：字符串
默认值：无
描述：页面地址，可以为本地文件路径，支持相对路径和绝对路径，以及 widget://、fs://等协议路径，也可以为远程地址。当data参数不为空时，url将做为baseUrl，data中的html引用的资源文件根路径以该url为基础。

data：

类型：字符串
默认值：无
描述：（可选项）页面加载的数据内容，可以为html片段或者整张html文件的数据

headers：

类型：JSON 对象
默认值：无
描述：（可选项）请求头

singleInstance：

类型：布尔
默认值：false
描述：（可选项）设置该window是否为单例对象。若设置为单例对象，当调用closeWin方法关闭时，window将只是从屏幕移除而不会被销毁，下次再打开时将直接使用已存在的window，而不会再重新创建。

avm：

类型：布尔
默认值：若在config.xml里面配置了avm字段，则默认值为配置的值，否则为false
描述：（可选项）是否使用原生引擎来加载页面，页面必须是使用avm框架语法生成。

useWKWebView：

类型：布尔
默认值：false
描述：（可选项）是否使用WKWebView来加载页面。参考WKWebView介绍。

allowAccessFromFile：

类型：布尔
默认值：全局加密下为false
描述：（可选项）设置是否可以在本地页面中访问本地或远程资源，为保证代码安全，在开启全局加密情况下默认禁止访问。只在useWKWebView参数为true时有效。

historyGestureEnabled：

类型：布尔
默认值：false
描述：（可选项）是否可以通过手势来进行历史记录前进后退，只在useWKWebView参数为true时有效。

syncCookie：

类型：布尔
默认值：true
描述：（可选项）是否自动同步WKWebView外部如ajax产生的Cookie到WKWebView中，只在useWKWebView参数为true时有效。

pageParam：

类型：JSON 对象
默认值：无
描述：（可选项）页面参数，新页面中可以通过 api.pageParam 获取

bounces：

类型：布尔
默认值：若在 config.xml 里面配置了pageBounce，则默认值为配置的值，否则为 false
描述：（可选项）页面是否弹动。注意如果页面使用了上拉、下拉刷新等功能，该属性可能会被刷新组件重新设置。

bgColor：

类型：字符串
默认值：若在 config.xml 里面配置了 windowBackground，则默认值为配置的值，否则透明
描述：（可选项）背景色，支持图片和颜色，格式为 #fff、#ffffff、rgba(r,g,b,a)等，图片路径支持 fs://、widget://等 APICloud 自定义文件路径协议，同时支持相对路径

scrollToTop：

类型：布尔
默认值：false
描述：（可选项）当点击状态栏，页面是否滚动到顶部。若当前屏幕上不止一个页面的 scrollToTop 属性为 true，则所有的都不会起作用。只 iOS 有效

scrollEnabled：

类型：布尔
默认值：true
描述：（可选项）页面内容超出后是否可以滚动，只支持iOS

vScrollBarEnabled：

类型：布尔
默认值：true
描述：（可选项）是否显示垂直滚动条

hScrollBarEnabled：

类型：布尔
默认值：true
描述：（可选项）是否显示水平滚动条

scaleEnabled：

类型：布尔
默认值：false
描述：（可选项）页面是否可以缩放

hideTopBar：

类型：布尔
默认值：无
描述：（可选项）是否隐藏原生navigationBar控件，该字段只 iOS 有效

hideBottomBar：

类型：布尔
默认值：无
描述：（可选项）是否隐藏原生tabBar控件，该字段只 iOS 有效

slidBackEnabled：

类型：布尔
默认值：true
描述：（可选项）是否支持滑动返回。iOS7.0及以上系统中，在新打开的页面中向右滑动，可以返回到上一个页面，该字段只 iOS 有效

slidBackType：

类型：字符串
默认值：full
描述：（可选项）当支持滑动返回时，设置手指在页面右滑的有效作用区域。取值范围（full:整个页面范围都可以右滑返回，edge:在页面左边缘右滑才可以返回），该字段只iOS有效

animation：

类型：JSON 对象
默认值：无
描述：（可选项）动画参数，不传时使用默认动画
内部字段：

{
    type:"none",                //动画类型（详见动画类型常量）
    subType:"from_right",       //动画子类型（详见动画子类型常量）
    duration:300                //动画过渡时间，默认300毫秒
}


type 取值范围：


none            //无动画效果
push            //新视图将旧视图推开
movein          //新视图移到旧视图上面
fade            //交叉淡化过渡（不支持过渡方向）
flip            //翻转效果
reveal          //将旧视图移开,显示下面的新视图
ripple          //滴水效果（不支持过渡方向）
curl            //向上翻一页
un_curl         //向下翻一页
suck            //收缩效果（不支持过渡方向）
cube            //立方体翻滚效果


subType 取值范围：


from_right      //从右边开始动画
from_left       //从左边开始动画
from_top        //从顶部开始动画
from_bottom     //从底部开始动画


（Android系统flip，ripple，curl，un_curl，suck，cube 类型不支持）

progress：

类型：JSON 对象
默认值：无
描述：（可选项）页面加载进度配置信息，若不传则无加载进度效果
内部字段：

{
    type:            //加载进度效果类型，默认值为 default，取值范围为 default|page，为 page 时，进度效果为仿浏览器类型，固定在页面的顶部
    title:           //type 为 default 时显示的加载框标题，字符串类型
    text:            //type 为 default 时显示的加载框内容，字符串类型
    color:           //type 为 page 时进度条的颜色，默认值为 #45C01A，支持#FFF，#FFFFFF，rgb(255,255,255)，rgba(255,255,255,1.0)等格式
    height:          //type 为 page 时进度条高度，默认值为3，数字类型
}

delay：

类型：数字
默认值：0
描述：（可选项）window 显示延迟时间，适用于将被打开的 window 中可能需要打开有耗时操作的模块时，可延迟 window 展示到屏幕的时间，保持 UI 的整体性

reload：

类型：布尔
默认值：false
描述：（可选项）页面已经打开时，是否重新加载页面，重新加载页面后 apiready 方法将会被执行

allowEdit：

类型：布尔
默认值：false
描述：（可选项）是否允许长按页面时弹出选择菜单

softInputMode：

类型：字符串
默认值：auto
描述：（可选项）当键盘弹出时，输入框被盖住时，当前页面的调整方式，只iOS有效，Android请在 config.xml 里面配置并云编译使用
取值范围：

resize            //若键盘盖住输入框，页面会自动上移
pan               //若键盘盖住输入框，页面不会自动上移
auto              //默认值，由系统决定如何处理，iOS平台该字段等同于resize

softInputDismissMode：

类型：字符串数组
默认值：['tap']
描述：（可选项）收起键盘的方式，只iOS有效。
取值范围：

tap               //点击页面收起键盘，可以和drag或interactive同时使用
drag              //拖拽页面时收起键盘，可以和tap同时使用
interactive       //在键盘和页面交界处上下滑动收起键盘，可以和tap同时使用

softInputBarEnabled：

类型：布尔
默认值：true
描述：（可选项）是否显示键盘上方的工具条。只支持iOS

overScrollMode:

类型：字符串
默认值：never
描述：（可选项）设置页面滚动到头部或尾部时，显示回弹阴影效果的模式，仅Android有效。
取值范围：

never            //永远不显示
always           //总是显示
scrolls          //只有当页面内容超出设备屏幕大小，发生滚动行为时显示，建议设置为该模式。

dragAndDrop：

类型：布尔
默认值：false
描述：（可选项）是否允许iOS 11及以上系统中页面元素默认的拖拽行为。只支持iOS

hideHomeIndicator：

类型：布尔
默认值：false
描述：（可选项）是否隐藏虚拟home键。设置为true时，虚拟home键会在屏幕没有触摸操作时自动隐藏，触摸后又会显示出来。只支持iOS

defaultRefreshHeader：

类型：字符串
默认值：pull
描述：（可选项）设置使用默认下拉刷新类型，取值范围：pull、swipe

customRefreshHeader：

类型：字符串
默认值：无
描述：（可选项）设置使用自定义下拉刷新模块的名称，设置后可以使用 api.setCustomRefreshHeaderInfo 方法来使用自定义下拉刷新组件

示例代码

api.openWin({
    name: 'page1',
    url: './page1.html',
    pageParam: {
        name: 'test'
    }
});

补充说明

窗口操作

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openWin

params

示例代码

补充说明

可用性

推荐文章

推荐教程

推荐课程