ready
论坛版主
论坛版主
  • UID24
  • 粉丝0
  • 关注0
  • 发帖数433
  • 社区居民
  • 忠实会员
  • 原创写手
阅读:5662回复:0

微信小程序开发API 文档总结 20191009

楼主#
更多 发布于:2019-10-09 11:19
[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.canIUse[/td][td]判断小程序的API,回调,参数,组件等是否在当前版本可用[/td][/tr][tr][td]wx.base64ToArrayBuffer[/td][td]将 Base64 字符串转成 ArrayBuffer 对象[/td][/tr][tr][td]wx.arrayBufferToBase64[/td][td]将 ArrayBuffer 对象转成 Base64 字符串[/td][/tr][/table]


系统




系统信息

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.getSystemInfoSync[/td][td]wx.getSystemInfo 的同步版本[/td][/tr][tr][td]wx.getSystemInfo[/td][td]获取系统信息[/td][/tr][/table]


更新


[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.getUpdateManager[/td][td]获取全局唯一的版本更新管理器,用于管理小程序更新[/td][/tr][/table]


UpdateManager

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]UpdateManager.applyUpdate[/td][td]强制小程序重启并使用新版本[/td][/tr][tr][td]UpdateManager.onCheckForUpdate[/td][td]监听向微信后台请求检查更新结果事件[/td][/tr][tr][td]UpdateManager.onUpdateFailed[/td][td]监听小程序更新失败事件[/td][/tr][tr][td]UpdateManager.onUpdateReady[/td][td]监听小程序有版本更新事件[/td][/tr][/table]


小程序



生命周期

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.getLaunchOptionsSync[/td][td]获取小程序启动时的参数[/td][/tr][/table]


应用级事件

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.onPageNotFound[/td][td]监听小程序要打开的页面不存在事件[/td][/tr][tr][td]wx.onError[/td][td]监听小程序错误事件[/td][/tr][tr][td]wx.onAudioInterruptionEnd[/td][td]监听音频中断结束事件[/td][/tr][tr][td]wx.onAudioInterruptionBegin[/td][td]监听音频因为受到系统占用而被中断开始事件[/td][/tr][tr][td]wx.onAppShow[/td][td]监听小程序切前台事件[/td][/tr][tr][td]wx.onAppHide[/td][td]监听小程序切后台事件[/td][/tr][tr][td]wx.offPageNotFound[/td][td]取消监听小程序要打开的页面不存在事件[/td][/tr][tr][td]wx.offError[/td][td]取消监听小程序错误事件[/td][/tr][tr][td]wx.offAudioInterruptionEnd[/td][td]取消监听音频中断结束事件[/td][/tr][tr][td]wx.offAudioInterruptionBegin[/td][td]取消监听音频因为受到系统占用而被中断开始事件[/td][/tr][tr][td]wx.offAppShow[/td][td]取消监听小程序切前台事件[/td][/tr][tr][td]wx.offAppHide[/td][td]取消监听小程序切后台事件[/td][/tr][/table]


调试

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.setEnableDebug[/td][td]设置是否打开调试开关[/td][/tr][tr][td]wx.getRealtimeLogManager[/td][td]获取实时日志管理器对象[/td][/tr][tr][td]wx.getLogManager[/td][td]获取日志管理器对象[/td][/tr][/table]


console

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]console.debug[/td][td]向调试面板中打印 debug 日志[/td][/tr][tr][td]console.error[/td][td]向调试面板中打印 error 日志[/td][/tr][tr][td]console.group[/td][td]在调试面板中创建一个新的分组[/td][/tr][tr][td]console.groupEnd[/td][td]结束由 console.group 创建的分组[/td][/tr][tr][td]console.info[/td][td]向调试面板中打印 info 日志[/td][/tr][tr][td]console.log[/td][td]向调试面板中打印 log 日志[/td][/tr][tr][td]console.warn[/td][td]向调试面板中打印 warn 日志[/td][/tr][/table]


LogManager

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]LogManager.debug[/td][td]写 debug 日志[/td][/tr][tr][td]LogManager.info[/td][td]写 info 日志[/td][/tr][tr][td]LogManager.log[/td][td]写 log 日志[/td][/tr][tr][td]LogManager.warn[/td][td]写 warn 日志[/td][/tr][/table]


RealtimeLogManager

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]RealtimeLogManager.addFilterMsg[/td][td]添加过滤关键字[/td][/tr][tr][td]RealtimeLogManager.error[/td][td]写 error 日志[/td][/tr][tr][td]RealtimeLogManager.info[/td][td]写 info 日志[/td][/tr][tr][td]RealtimeLogManager.setFilterMsg[/td][td]设置过滤关键字[/td][/tr][tr][td]RealtimeLogManager.warn[/td][td]写 warn 日志[/td][/tr][/table]


定时器

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]clearInterval[/td][td]取消由 setInterval 设置的定时器[/td][/tr][tr][td]clearTimeout[/td][td]取消由 setTimeout 设置的定时器[/td][/tr][tr][td]setInterval[/td][td]设定一个定时器[/td][/tr][tr][td]setTimeout[/td][td]设定一个定时器[/td][/tr][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]--[/td][td]--[/td][/tr][tr][td]envObj[/td][td][/td][/tr][/table]


路由

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.switchTab[/td][td]跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面[/td][/tr][tr][td]wx.reLaunch[/td][td]关闭所有页面,打开到应用内的某个页面[/td][/tr][tr][td]wx.redirectTo[/td][td]关闭当前页面,跳转到应用内的某个页面[/td][/tr][tr][td]wx.navigateTo[/td][td]保留当前页面,跳转到应用内的某个页面[/td][/tr][tr][td]wx.navigateBack[/td][td]关闭当前页面,返回上一页面或多级页面[/td][/tr][/table]


EventChannel

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]EventChannel.emit[/td][td]触发一个事件[/td][/tr][tr][td]EventChannel.off[/td][td]取消监听一个事件[/td][/tr][tr][td]EventChannel.on[/td][td]持续监听一个事件[/td][/tr][tr][td]EventChannel.once[/td][td]监听一个事件一次,触发后失效[/td][/tr][/table]


界面



交互

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.showToast[/td][td]显示消息提示框[/td][/tr][tr][td]wx.showModal[/td][td]显示模态对话框[/td][/tr][tr][td]wx.showLoading[/td][td]显示 loading 提示框[/td][/tr][tr][td]wx.showActionSheet[/td][td]显示操作菜单[/td][/tr][tr][td]wx.hideToast[/td][td]隐藏消息提示框[/td][/tr][tr][td]wx.hideLoading[/td][td]隐藏 loading 提示框[/td][/tr][/table]


导航栏

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.showNavigationBarLoading[/td][td]在当前页面显示导航条加载动画[/td][/tr][tr][td]wx.setNavigationBarTitle[/td][td]动态设置当前页面的标题[/td][/tr][tr][td]wx.setNavigationBarColor[/td][td]设置页面导航条颜色[/td][/tr][tr][td]wx.hideNavigationBarLoading[/td][td]在当前页面隐藏导航条加载动画[/td][/tr][tr][td]wx.hideHomeButton[/td][td]隐藏返回首页按钮[/td][/tr][/table]


背景

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.setBackgroundTextStyle[/td][td]动态设置下拉背景字体、loading 图的样式[/td][/tr][tr][td]wx.setBackgroundColor[/td][td]动态设置窗口的背景色[/td][/tr][/table]


Tab Bar

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.showTabBarRedDot[/td][td]显示 tabBar 某一项的右上角的红点[/td][/tr][tr][td]wx.showTabBar[/td][td]显示 tabBar[/td][/tr][tr][td]wx.setTabBarStyle[/td][td]动态设置 tabBar 的整体样式[/td][/tr][tr][td]wx.setTabBarItem[/td][td]动态设置 tabBar 某一项的内容,2.7.0 起图片支持临时文件和网络文件[/td][/tr][tr][td]wx.setTabBarBadge[/td][td]为 tabBar 某一项的右上角添加文本[/td][/tr][tr][td]wx.removeTabBarBadge[/td][td]移除 tabBar 某一项右上角的文本[/td][/tr][tr][td]wx.hideTabBarRedDot[/td][td]隐藏 tabBar 某一项的右上角的红点[/td][/tr][tr][td]wx.hideTabBar[/td][td]隐藏 tabBar[/td][/tr][/table]


字体

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.loadFontFace[/td][td]动态加载网络字体[/td][/tr][/table]


下拉刷新

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.stopPullDownRefresh[/td][td]停止当前页面下拉刷新[/td][/tr][tr][td]wx.startPullDownRefresh[/td][td]开始下拉刷新[/td][/tr][/table]


滚动

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.pageScrollTo[/td][td]将页面滚动到目标位置,支持选择器和滚动距离两种方式定位[/td][/tr][/table]


动画

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.createAnimation[/td][td]创建一个动画实例 animation[/td][/tr][/table]


Animation

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]Animation.height[/td][td]设置高度[/td][/tr][tr][td]Animation.left[/td][td]设置 left 值[/td][/tr][tr][td]Animation.matrix[/td][td]同 transform-function matrix[/td][/tr][tr][td]Animation.matrix3d[/td][td]同 transform-function matrix3d[/td][/tr][tr][td]Animation.opacity[/td][td]设置透明度[/td][/tr][tr][td]Animation.right[/td][td]设置 right 值[/td][/tr][tr][td]Animation.rotate[/td][td]从原点顺时针旋转一个角度[/td][/tr][tr][td]Animation.rotate3d[/td][td]从 X 轴顺时针旋转一个角度[/td][/tr][tr][td]Animation.rotateX[/td][td]从 X 轴顺时针旋转一个角度[/td][/tr][tr][td]Animation.rotateY[/td][td]从 Y 轴顺时针旋转一个角度[/td][/tr][tr][td]Animation.rotateZ[/td][td]从 Z 轴顺时针旋转一个角度[/td][/tr][tr][td]Animation.scale[/td][td]缩放[/td][/tr][tr][td]Animation.scale3d[/td][td]缩放[/td][/tr][tr][td]Animation.scaleX[/td][td]缩放 X 轴[/td][/tr][tr][td]Animation.scaleY[/td][td]缩放 Y 轴[/td][/tr][tr][td]Animation.scaleZ[/td][td]缩放 Z 轴[/td][/tr][tr][td]Animation.skew[/td][td]对 X、Y 轴坐标进行倾斜[/td][/tr][tr][td]Animation.skewX[/td][td]对 X 轴坐标进行倾斜[/td][/tr][tr][td]Animation.skewY[/td][td]对 Y 轴坐标进行倾斜[/td][/tr][tr][td]Animation.step[/td][td]表示一组动画完成[/td][/tr][tr][td]Animation.top[/td][td]设置 top 值[/td][/tr][tr][td]Animation.translate[/td][td]平移变换[/td][/tr][tr][td]Animation.translate3d[/td][td]对 xyz 坐标进行平移变换[/td][/tr][tr][td]Animation.translateX[/td][td]对 X 轴平移[/td][/tr][tr][td]Animation.translateY[/td][td]对 Y 轴平移[/td][/tr][tr][td]Animation.translateZ[/td][td]对 Z 轴平移[/td][/tr][tr][td]Animation.width[/td][td]设置宽度[/td][/tr][tr][td]Animation.backgroundColor[/td][td]设置背景色[/td][/tr][tr][td]Animation.bottom[/td][td]设置 bottom 值[/td][/tr][tr][td]Animation.export[/td][td]导出动画队列[/td][/tr][/table]


置顶

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.setTopBarText[/td][td]动态设置置顶栏文字内容[/td][/tr][/table]


自定义组件

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.nextTick[/td][td]延迟一部分操作到下一个时间片再执行[/td][/tr][/table]


菜单

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.getMenuButtonBoundingClientRect[/td][td]获取菜单按钮(右上角胶囊按钮)的布局位置信息[/td][/tr][/table]


窗口

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.onWindowResize[/td][td]监听窗口尺寸变化事件[/td][/tr][tr][td]wx.offWindowResize[/td][td]取消监听窗口尺寸变化事件[/td][/tr][/table]


键盘

[table=720][tr][td]名称[/td][td]功能说明[/td][/tr][tr][td]wx.onKeyboardHeightChange[/td][td]监听键盘高度变化[/td][/tr][tr][td]wx.hideKeyboard[/td][td]在input、textarea等focus拉起键盘之后,手动调用此接口收起键盘[/td][/tr][tr][td]wx.getSelectedTextRange[/td][td]在input、textarea等focus之后,获取输入框的光标位置[/td][/tr][/table]


网络



发起请求

名称功能说明
wx.request发起 HTTPS 网络请求



RequestTask

名称功能说明
RequestTask.abort中断请求任务
RequestTask.offHeadersReceived取消监听 HTTP Response Header 事件
RequestTask.onHeadersReceived监听 HTTP Response Header 事件



下载

名称功能说明
wx.downloadFile下载文件资源到本地



DownloadTask

名称功能说明
DownloadTask.abort中断下载任务
DownloadTask.offHeadersReceived取消监听 HTTP Response Header 事件
DownloadTask.offProgressUpdate取消监听下载进度变化事件
DownloadTask.onHeadersReceived监听 HTTP Response Header 事件
DownloadTask.onProgressUpdate监听下载进度变化事件



上传

名称功能说明
wx.uploadFile将本地资源上传到服务器



https://developers.weixin.qq.com/miniprogram/dev/api/
游客


返回顶部