Page(Object object)

注册小程序中的一个页面。接受一个 Object 类型参数，其指定页面的初始数据、生命周期回调、事件处理函数等。

参数

Object object

属性	类型	默认值	必填	说明
data	Object	-	-	页面的初始数据
onLoad	Function	-	-	生命周期回调—监听页面加载
onShow	Function	-	-	生命周期回调—监听页面显示
onHide	Function	-	-	生命周期回调—监听页面隐藏
onReady	Function	-	-	生命周期回调—监听页面初次渲染完成
onUnload	Function	-	-	生命周期回调—监听页面卸载
onPullDownRefresh	Function	-	-	监听用户下拉动作
onReachBottom	Function	-	-	页面上拉触底事件的处理函数
onPageScroll	Function	-	-	页面滚动触发事件的处理函数
onResize	Function	-	-	页面尺寸改变时触发，详见 响应显示区域变化
onTabItemTap	Function	-	-	当前是 tab 页时，点击 tab 时触发
onPlayVideoStart	Function	-	-	半屏播放器视频开始播放时触发
onPlayVideoPause	Function	-	-	半屏播放器视频暂停播放时触发
onPlayVideoEnd	Function	-	-	半屏播放器视频结束播放时触发
onPlayVideoTimeUpdate	Function	-	-	半屏播放器视频每秒进度播放时触发
onPlayVideoError	Function	-	-	半屏播放器视频发生错误时触发
其它	any	-	-	半开发者可以添加任意的函数或数据到 Object 参数中，在页面的函数中用 this 可以访问

data

data 是页面第一次渲染使用的初始数据。

页面加载时，data 将会以 JSON 字符串的形式由逻辑层传至渲染层，因此 data 中的数据必须是可以转成 JSON 的类型：字符串，数字，布尔值，对象，数组。 渲染层可以通过 MXML 对数据进行绑定。

<view>{{text}}</view> <view>{{array[0].msg}}</view>

Page({
  data: {
    text: "init data",
    array: [{ msg: "1" }, { msg: "2" }],
  },
});

生命周期回调函数

生命周期的触发以及页面的路由方式详见路由

onLoad(Object query)

页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。

参数：

名称	类型	说明
query	Object	打开当前页面路径中的参数

onShow()

页面显示/切入前台时触发。

onReady()

页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。

信息

对界面内容进行设置的 API 如 mgtv.setNavigationBarTitle，请在 onReady 之后进行。详见生命周期

onHide()

页面隐藏/切入后台时触发。 如 mgtv.navigateTo 或底部 tab 切换到其他页面，小程序切入后台等。

onUnload()

页面卸载时触发。如 mgtv.redirectTo 或 mgtv.navigateBack 到其他页面时。

页面事件处理函数

onPullDownRefresh()

监听用户下拉刷新事件。

• 需要在 app.json 的 window 选项中或页面配置中开启 enablePullDownRefresh。
• 可以通过 mgtv.startPullDownRefresh 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。
• 当处理完数据刷新后，mgtv.stopPullDownRefresh 可以停止当前页面的下拉刷新。

onReachBottom()

监听用户上拉触底事件。

• 可以在 app.json 的 window 选项中或页面配置中设置触发距离 onReachBottomDistance。
• 在触发距离内滑动期间，本事件只会被触发一次。

onPageScroll(Object object)

监听用户滑动页面事件。

参数 Object object

名称	类型	说明
scrollTop	Number	页面在垂直方向已滚动的距离（单位 px）

• 需要在 app.json 的 window 选项中或页面配置中开启 enableScrollEvent。

注意

请只在需要的时候才在 page 中定义此方法，不要定义空方法。以减少不必要的事件派发对渲染层-逻辑层通信的影响。

请避免在 onPageScroll 中过于频繁的执行 setData 等引起逻辑层-渲染层通信的操作。尤其是每次传输大量数据，会影响通信耗时。

onResize(Object object)

小程序屏幕旋转时触发。详见 响应显示区域变化

onTabItemTap(Object object)

点击 tab 时触发

Object 参数

参数	类型	说明
index	String	被点击 tabItem 的序号，
pagePath	String	被点击 tabItem 的页面路径
text	String	被点击 tabItem 的按钮文字

onPlayVideoStart()

半屏播放器视频开始播放时触发

• 需要小程序以半屏启动在播放器页面才有该页面事件。

onPlayVideoPause()

半屏播放器视频暂停播放时触发

• 需要小程序以半屏启动在播放器页面才有该页面事件。

onPlayVideoEnd()

半屏播放器视频结束播放时触发

• 需要小程序以半屏启动在播放器页面才有该页面事件。

onPlayVideoError()

半屏播放器视频发生错误时触发

• 需要小程序以半屏启动在播放器页面才有该页面事件。

onPlayVideoTimeUpdate()

半屏播放器视频进度更新事件

• 需要小程序以半屏启动在播放器页面才有该页面事件。
• 需要在 app.json 的 window 选项中或页面配置中开启 enableHalfPageVideoUpdateEvent

Page.route

到当前页面的路径，类型为 String。

Page.prototype.setData(Object data)

setData 函数用于将数据从逻辑层发送到视图层（异步），同时改变对应的 this.data 的值（同步）。

Object 以 key: value 的形式表示，将 this.data 中的 key 对应的值改变成 value。

其中 key 可以以数据路径的形式给出，支持改变数组中的某一项或对象的某个属性，如 array[2].message，a.b.c.d，并且不需要在 this.data 中预先定义。

注意

1. 直接修改 this.data 而不调用 this.setData 是无法改变页面的状态的，还会造成数据不一致。
2. 仅支持设置可 JSON 化的数据。
3. 单次设置的数据不能超过 1024kB，请尽量避免一次设置过多的数据。
4. 请不要把 data 中任何一项的 value 设为 undefined ，否则这一项将不被设置并可能遗留一些潜在问题。

示例代码

//index.js
Page({
  data: {
    text: "This is page data.",
  },
  onLoad: function (options) {
    // Do some initialize when page load.
  },
  onShow: function () {
    // Do something when page show.
  },
  onReady: function () {
    // Do something when page ready.
  },
  onHide: function () {
    // Do something when page hide.
  },
  onUnload: function () {
    // Do something when page close.
  },
  onPullDownRefresh: function () {
    // Do something when pull down.
  },
  onReachBottom: function () {
    // Do something when page reach bottom.
  },
  // onShareAppMessage: function () {
  //   // return custom share data when user share.
  // },
  onPageScroll: function () {
    // Do something when page scroll
  },
  onResize: function () {
    // Do something when page resize
  },
  onTabItemTap(item) {
    console.log(item.index);
    console.log(item.pagePath);
    console.log(item.text);
  },
  onPlayVideoStart() {
    // Do something when half screen video start playing
  },
  onPlayVideoPause() {
    // Do something when half screen video paused
  },
  onPlayVideoEnd() {
    // Do something when half screen video end
  },
  onPlayVideoTimeUpdate(res) {
    // Do something when half screen video time tick
  },
  onPlayVideoError(reason) {
    // Do something when half screen video goes wrong
  },
  // Event handler.
  viewTap: function () {
    this.setData(
      {
        text: "Set some data for updating view.",
      },
      function () {
        // this is setData callback
      }
    );
  },
  customData: {
    hi: "MINA",
  },
});