JS API 列表
收藏
我的收藏

基础​

API
描述
判断小程序的 API、回调、参数、组件等是否在当前版本可用。
将 base64 字符串转成 arraybuffer 对象。
小程序中的一些组件是由客户端实现的,如 videoad 等。如果开发者希望通过 css 等途径往这些组件的上方放置一些其他组件,是需要小程序所在 App 具备一定能力才可以实现的。​

生命周期​

API
描述
获取本次小程序启动时的参数。
获取小程序冷启动时的参数,其值与 App.onLaunch 方法传入的参数一致,并且不会随着小程序使用而发生变化。
退出当前小程序到后台。

版本更新​

API
描述
获取全局唯一的版本更新管理器 updateManager 实例,用于管理小程序更新。关于小程序更新的原理,可以查看小程序运行机制
通过 tt.getUpdateManager 获取的小程序版本更新管理器对象。​
当向字节小程序后台请求完新版本信息,此函数被调用。
当新版本下载完成,会进行回调。
小程序冷启动后,如果有更新版本,客户端会触发新版本下载,当新版本下载失败(比如网络错误),会进行回调。
当小程序新版本下载完成(即收到 onUpdateReady 回调)时,调用该方法会强制应用新版本并重启。

定时器​

API
描述
设置一个定时器,在一定延时后触发回调函数。
清除一个定时器。
设定一个定时器。按照指定的周期(以毫秒计)来执行注册的回调函数。
清除一个定时器。

应用级事件​

API
描述
监听小程序切前台事件,该事件回调参数与 App.onShow 一致。
取消监听小程序进前台事件。
监听小程序切后台事件,该事件回调参数与 App.onHide 一致。
取消监听小程序切后台事件。
取消监听未处理的 Promise 拒绝事件。
监听小程序错误事件,如脚本错误或 API 调用报错等。该事件与 App.onError 获取的小程序版本更新管理器对象。​
取消监听小程序错误事件。
监听未处理的 Promise 拒绝事件。该事件与 App.onUnhandledRejection 的回调时机与参数一致。
监听小程序异步组件加载失败事件。​
移除小程序异步组件加载失败事件的监听函数。​
监听小程序启动事件。该事件与 App.onLaunch 的回调时机与参数一致。​

环境变量​

API
描述
获取小程序环境信息。​

性能​

API​
描述​
创建全局性能事件监听器。​
设置当前缓冲区中可缓存的页面的性能数据的页面数,默认缓存 10 页面的数据。​
该方法返回当前缓冲区中的所有性能数据。​
获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据。​
获取当前缓冲区中所有类型为 [entryType] 的性能数据。​
获取当前缓冲区中当前页面的性能数据。​
获取当前缓冲区中页面路径为 [pagePath] 的性能数据。​
在性能缓冲区中使用给定名称添加一个 name 为 [name] 的性能数据。​
清空性能缓冲区中 name 为 [name] 的自定义性能数据。​
性能数据的实例。​

线程​

API​
描述​
创建一个 Worker 线程,目前限制最多只能创建一个 Worker,创建下一个 Worker 前请调用 Worker.terminate() 销毁当前 Worker 实例​
通过在主线程调用 tt.createWorker 创建/Worker 线程内置的实例,可以实现主线程和 Worker 线程之间的通信。​
监听接收主线程/Worker 线程向当前线程发送的消息,支持在主线程/Worker 线程内调用​
向主线程/Worker 线程发送消息,支持在主线程/Worker 线程内调用。​
结束当前 Worker 线程,仅限在主线程 Worker 对象上调用。​

窗口尺寸变化​

API​
描述​
监听窗口尺寸变化事件,仅 Andriod 支持。​
取消监听窗口尺寸变化事件,仅 Android 支持。​

网络​

API
描述
通过 tt.request 获取的实例,能够控制网络请求任务。
中断请求任务。其中 RequestTask 是通过 tt.request() 返回的对象。
下载文件资源到本地。
发起 HTTPS 网络请求。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求
通过 tt.uploadFile 获取的实例,能够控制网络上传任务。
中断上传任务。其中 UploadTask 是通过 tt.uploadFile() 返回的对象。​
监听上传进度变化事件,其中 UploadTasktt.uploadFile() 返回的对象。
取消监听上传进度变化事件,其中 UploadTask 是通过 tt.uploadFile() 返回的对象。​
通过 tt.downloadFile 获取的实例,能够控制网络下载任务。​
中断下载任务。其中 DownloadTask 是通过 tt.downloadFile() 返回的对象。
监听下载进度变化事件,其中 DownloadTasktt.downloadFile() 返回的对象。
取消监听下载进度变化事件,其中 DownloadTask 是通过 tt.downloadFile() 返回的对象。
将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-typemultipart/form-data。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求
创建一个 WebSocket 连接实例,并通过返回的 socketTask 操作该连接。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求。
通过 tt.connectSocket 获取的 WebSocket 任务实例。​
WebSocket 发送给服务端数据的方法。
关闭 WebSocket 连接的方法。
监听 WebSocket 连接服务器成功的事件。表示 WebSocket 的状态变成 open,可以发送数据给服务器。
监听 WebSocket 与服务器连接断开的事件。
监听 WebSocket 接收到服务器发送信息的事件。
监听 WebSocket 发生错误的事件。

媒体​

图片​

API
描述
从系统相册中选择图片,或使用相机拍摄图片,选取成功后将存入本地临时文件,并在 success 回调中返回相应路径列表。该 API 需要用户授权方可调用,详细信息可参考用户授权
保存图片到系统相册。
预览一组图片。
获取图片信息。
压缩图片接口,可选压缩质量,并可以产出压缩后的图片到本地临时文件。仅对 jpg 格式图片有效。

录音​

API
描述
获取全局唯一recorderManager。通过 recorderManager 进行录音操作和管理。该 api 多次调用时返回的是同一个实例,在多页面使用时,会操作到同一个上下文对象。
通过 tt.getRecorderManager 获取的全局唯一的录音管理器。
暂停录音。
开始录音。该方法需要用户授权方可调用,详细信息可参考用户授权
继续录音。在调用暂停录音之后,可以调用 resume 继续录音,继续录音的内容会拼接到上一次暂停录音之后。
停止录音。
监听录音暂停事件。
监听录音结束事件,成功时回调录音文件临时路径。
监听录音开始事件。
监听录音错误事件,录音出错时回调错误信息。
监听录音继续事件。
监听已录制完指定帧大小的文件事件。如果设置了 frameSize,则会回调此事件,不设置则没有此回调。

音频​

获取全局唯一的背景音频管理器 BackgroundAudioManager
BackgroundAudioManager 实例。可通过 tt.getBackgroundAudioManager 接口获取,通过它能够操作背景音频播放。
播放。
暂停播放。
停止播放。
当前音频跳转到指定位置,并开始播放。
监听音频进入可以播放状态,此时文件资源的元信息解析完成,但不保证后面可以流畅播放,具体可播放时机取决于播放器的实现。
监听背景音频播放事件。
监听音频暂停事件。
监听音频停止事件。
监听音频停止事件。触发时机:调用 seek 跳转到音频结尾,或自动播放结束。
监听音频进度更新事件,回调执行时机为音频开始播放时,状态更新间隔约为 250ms,暂停或停止播放时音频进度也停止更新。
监听音频播放错误事件。包括设置的属性类型不合法,API 调用过程中错误等。
监听加载中事件,当音频因为数据不足,需要停下来加载时会触发,音频开始播放后需要停下来加载资源时也会触发,此时首先会暂停播放,待资源加载完成后继续播放。
监听背景音频完成跳转操作事件。仅 Android 支持。
监听用户在系统音乐播放面板点击下一曲事件(暂仅支持 iOS)。
监听背景音频开始跳转操作事件。若存在多次添加监听,只触发最后一个监听事件的回调。仅 Android 支持。
监听用户在系统音乐播放面板点击上一曲事件(暂仅支持 iOS)。
取消监听 timeUpdate 事件。
创建并返回内部 audio 上下文 innerAudioContext 实例,通过它能够操作音频播放。
通过 tt.createInnerAudioContext 获取的实例,通过它能够操作音频播放。
播放音频。
暂停播放。暂停后再次播放时基于此状态继续播放。
停止播放。停止后再次播放时从头开始播放。
跳转到指定位置播放。
销毁当前实例。销毁后该实例将不存在,如需播放需要再次创建。
监听音频进入可以播放状态,但不保证后面可以流畅播放。
监听音频播放事件。
监听音频暂停事件。
监听音频自然播放结束事件。
监听音频进度更新事件。
监听音频播放错误事件。
监听音频加载中事件,当音频因为数据不足,需要停下来加载时会触发。
监听音频开始进行 seek 操作的事件。
监听音频完成 seek 操作的事件。
取消 InnerAudioContext.onPlay 监听的事件。
取消 InnerAudioContext.onPause 监听的事件。
取消 InnerAudioContext.onStop 监听的事件。
取消 InnerAudioContext.onEnded 监听的事件。
取消 InnerAudioContext.onTimeUpdate 监听的事件。
取消 InnerAudioContext.onError 监听的事件。
取消 InnerAudioContext.onWaiting 监听的事件。
取消 InnerAudioContext.onSeeking 监听的事件。
取消 InnerAudioContext.onSeeked 监听的事件。
监听音频停止播放事件。

视频​

API
描述
从系统相册中选择视频,或使用相机拍摄视频,返回视频的临时文件路径。
保存视频到系统相册。
创建视频预加载任务。预加载成功后的视频资源生效区间为整个小程序。
通过 tt.preloadVideo 实例,通过它能够操作音频播放。
中断视频预加载任务。预加载成功后执行该操作不生效。
调用该 API 拍摄或从手机相册中选择图片或视频。
根据组件 ID 创建可以控制组件的上下文 VideoContext 对象。​
播放视频。
暂停视频。
停止视频播放。
进入全屏。
视频点播。
退出全屏。
设置普通水印,目前仅抖音支持,展示的水印内容为抖音 id,水印会铺满整个视频容器。
获取音量。
设置音量。
设置倍速播放。

相机​

API
描述
创建并返回 camera 上下文 CameraContext 对象。
获取 Camera 实时帧数据,返回监听器 CameraFrameListener
设置 Camera 缩放级别。
拍摄照片。
开始录像。
结束录像。
CameraContext.onCameraFrame() 返回的监听器。
开始监听帧数据。开始监听后,CameraContext.onCameraFrame 回调中开始接收帧数据。
停止监听帧数据。

特效相机​

API
描述
创建并返回特效相机数据流实例 EffectCameraStream,通过该对象的 API 可操作相机数据的开始、暂停、绘制等能力。同步 API。
EffectCameraStream 实例。可通过 tt.createEffectCameraStream 接口获取,后续可通过它调用特效相机相关能力,当前仅提供相机基本能力。
设置数据源(相机)参数,并请求相机资源,用户授权后将占用相机资源。
监听相机资源请求成功事件,资源请求成功后触发,可通过 EffectCameraStream.offRequest 取消监听。
取消监听相机资源请求事件,取消后 EffectCameraStream.onRequest 的回调参数将不被触发。
开启相机。
监听相机开启事件成功事件,资源请求成功后触发。
取消监听相机开启事件,取消后 EffectCameraStream.onPlay 中的回调参数将不被触发。
暂停相机的使用并停止更新数据,调用后若有其他数据流处理事件,则继续执行该处理逻辑到 stop 前的最后一帧(没有销毁底层相机图像缓冲区,只是不再更新数据)。
监听相机暂停事件 EffectCameraStream.stop 成功事件。
取消监听相机暂停事件。
将相机数据绘制到指定的 canvas 画布区域(仅适用于 canvas V2)。
监听 EffectCameraStream 生命周期中的业务错误,包括 request、 play、stop。​
取消对 EffectCameraStream 生命周期错误事件的监听,包括 request、 play、stop。​
关闭相机并释放相机资源。
EffectCameraVideo 为特效相机返回数据类型。

Canvas 录制​

API
描述
小程序中的 Canvas 录制器 MediaRecorder 可以录制 Canvas(v2) 上绘制的所有画面,可以精确的控制录制的开始暂停,并且在录制结束时会自动导出 mp4 视频文件。
通过 tt.createMediaRecorder 获取的实例。
开始录制。
监听录制开始事件。
监听录制结束事件。
结束录制。真正结束录制写入文件完成后会触发注册的MediaRecorder.onstop回调。stop后无法重新调用start
暂停录制。
恢复录制。
监听 Canvas 录制器的错误事件。
手动模式中主动录制当前 Canvas 上的当前画面到视频帧中,仅在手动模式中生效。
销毁 Canvas 录制器并释放资源,建议在不使用录制器后及时调用本函数释放资源。

地图​

API
描述
通过 tt.createMapContext 获取的实例,通过它能够操作地图。​
获取当前地图中心的经纬度,返回的是 gcj02 坐标系,可以用于 tt.openLocation()
获取地图视野范围。
获取地图缩放值。
将地图中心移动到定位点。地图能力基于 gcj02 坐标系,请注意入参的经纬度信息转换。
获取地图的旋转角。
缩放视野展示所有经纬度。
获取当前地图的倾斜角。
平移 marker,带动画。
沿指定路径移动 marker,用于轨迹回放等场景。动画完成时触发回调事件,若动画进行中,对同一 marker 再次调用 moveAlong 方法,前一次的动画将被打断。
用于将地图经纬度坐标系转换成屏幕坐标系。
用于将屏幕坐标系转换成地图经纬度坐标系。
设置定位点图标,支持网络路径、本地路径、代码包路径。
拉起地图 APP 选择导航。
创建自定义图片图层,图片会随着地图缩放而缩放。
设置地图中心点偏移,未设置时默认偏移为 [0.5, 0.5]。
更新自定义图片图层。
移除自定义图片图层。

文件​

API
描述
保存临时文件到用户目录, 用户目录以 ttfile://user 开头。
获取文件信息。
获取该小程序下用户目录文件列表, 用户目录以 ttfile://user 开头。
新开页面打开文档,支持格式:doc,docx,xls,xlsx,ppt,pptx,pdf。
删除该小程序下用户目录内的文件, 用户目录以 ttfile://user 开头。
获取全局唯一的文件管理器。
通过 tt.getFileSystemManager 获取的实例,通过它可以管理文件。​
判断文件/目录是否存在。
判断文件/目录是否存在。
在文件结尾追加内容,只有用户目录(ttfile://user)下的文件可以追加,文件不存在时会新建。
在文件结尾追加内容,只有用户目录(ttfile://user)下的文件可以追加,文件不存在时会新建。
同步复制文件。
复制文件。
获取临时目录(ttfile://temp) 或用户目录(ttfile://user)下的文件信息。
获取该小程序下用户目录文件列表, 用户目录以 ttfile://user 开头。​
用户目录下创建目录。​
用户目录下创建目录。​
读取本地文件内容。
读取本地文件内容。
读取目录内文件列表。
读取目录内文件列表。
删除该小程序下用户目录内的文件, 用户目录以 ttfile://user 开头。
重命名文件,可以把文件从 oldPath 移动到 newPath。
重命名文件,可以把文件从 oldPath 移动到 newPath。
删除目录, 开发者只能删除 用户目录(ttfile://user)下的目录。
删除目录, 只能是 ttfile://user 下的目录。​
保存临时文件到用户目录, 用户目录以 ttfile://user 开头。​
保存临时文件到用户目录, 用户目录以 ttfile://user 开头。
获取文件 Stat 对象。
获取文件 Stat 对象。
对文件内容进行截断操作,只有用户目录(ttfile://user)下的文件可以截断。
对文件内容进行截断操作,只有用户目录(ttfile://user)下的文件可以截断。
删除文件,只能删除 用户目录(ttfile://user)下的文件。
删除文件,只能在 ttfile://user 开头的用户目录下操作。​
解压文件。
写文件。
写文件,只能写入用户目录(ttfile://user)。
Stat
描述文件状态的对象。
判断当前文件是否一个目录。
判断当前文件是否一个普通文件。

开放接口​

环境信息​

API
描述
获取小程序环境信息。

登录​

API
描述
调用该 API 可以获取用户临时的登录凭证。
用户的登录态具有时效性,随着用户未使用小程序的时间增加,用户的登录态越容易失效;反之,则用户登录态可持续保持有效。使用该 API 可检查用户当前的 session 状态是否有效,登录态过期后开发者可以再调用 tt.login 获取新的用户登录态。

用户信息​

API
描述
获取用户的基本信息,只可在 tap 事件回调中调用,每次调用都会弹出授权提示窗,若用户同意,则会返回用户的真实数据。

广告​

API
描述
开发者可以在小程序中使用激励视频广告获得收入。具体接入方式可参考广告组件接入规范
绑定 load 事件的监听器。​
解除绑定 load 事件的监听器。​
当广告素材加载出现错误时,可以通过 load 方法手动加载。​
绑定 error 事件的监听器。
解除绑定 error 事件的监听器。
绑定 close 事件的监听器。 当用户点击了激励视频广告上的关闭按钮时,会触发 close 事件的监听器。
解除绑定 close 事件的监听器。
创建插屏广告组件,开发者可以在小程序中使用插屏广告获得收入。
广告创建后默认是隐藏的,可以通过该方法显示广告。
当广告素材加载出现错误时,可以通过 load 方法手动加载。
手动销毁插屏广告实例。
绑定 load 事件的监听器。
解除绑定 load 事件的监听器。

支付​

API
描述
调起字节小程序收银台进行支付。开发接入之前,请先完成商户入驻流程,详细文档见:小程序担保支付接入准备

小程序跳转​

API
描述
跳转到另一个小程序。
返回到跳转来的上一个小程序。

收货地址​

API
描述
获取用户收货地址。调起用户编辑收货地址原生界面,并在编辑完成后返回用户选择的地址。

设置​

API
描述
获取用户已经授权过的配置。
打开设置页面,返回用户设置过的授权结果。
用户授权的设置信息。

授权​

API
描述
提供小程序获取抖音权限的能力,展示出抖音权限授权弹窗。在使用接口前,需要小程序拥有者前往抖音开放平台-管理中心-应用管理申请开通小程序需要的权限。下图以开通视频发布权限为例。

评价能力​

API
描述
根据传入的订单列表,返回订单是否可以评价。
该 API 只支持抖音宿主。
根据传入的订单 id,跳转到抖音评价页面,供用户填写评价。待评价订单中的商品必须在 POI 商品库中,非商品库中的商品订单暂不支持该能力。
该 API 只支持抖音宿主。

数据分析​

API
描述
自定义分析数据上报接口,调用后,会将数据上报到小程序开发者平台,开发者可以在小程序开发者平台中查看上报数据。使用前,需要在小程序管理后台事件中新建事件,配置好事件名与字段。

视频跳转​

API
描述
跳转到分享的视频播放页面,目前仅抖音支持。

引导关注​

API
描述
关注小程序绑定的头条号。​
查看用户是否已关注小程序绑定的头条号。​
调用此 API 会弹出弹框,用户可以点击按钮关注绑定的抖音号。只支持在抖音和抖音 Lite App 上使用。
提供从小程序查看抖音号是否关注的能力。

订阅消息​

API
描述
调起客户端订阅消息界面,返回用户订阅消息的操作结果。当用户勾选了订阅面板中的 “总是保持以上选择,不再询问” 时,或是点击了订阅面板中 “拒绝,不再询问” 时,模板消息会被添加到用户的小程序设置页,用户可以在设置页面进行管理。

数据缓存​

API
描述
获取本地缓存数据。​
获取本地缓存数据。
以「键值对」的形式设置本地缓存数据。
以「键值对」的形式设置本地缓存数据,是tt.setStorage的同步版本。
从本地缓存数据中删除 key 对应的值。
从本地缓存数据中删除 key 对应的值。
清理本地数据缓存。
清理本地数据缓存的同步接口。
获取本地缓存数据的相关信息。
同步获取当前本地缓存数据的相关信息。

地理位置​

API
描述
获取设备当前的地理位置。​
打开地图选择位置。
使用内置地图查看位置。
开始接收位置更新。
停止接收位置更新。
注册地理位置变化回调。
取消注册地理位置变化回调。
注册位置更新异常回调。
取消注册位置更新错误回调。

设备​

网络状态​

API
描述
监听网络状态变化。
请求获取 Wi-Fi 列表(对应打开手机 Wi-Fi 配置可以扫描到的 Wi-Fi 列表)。
使用 tt.getWifiList 后通过该回调监听获取到 Wi-Fi 列表数据。​
取消监听获取到 Wi-Fi 列表数据事件。

系统信息​

API
描述
获取系统信息。
获取系统信息。

Wi-Fi​

API
描述
获取设备当前所连的 WiFi 信息。

罗盘​

API
描述
开始监听罗盘数据。罗盘数据会在用户手机发生“朝向变化/加速前进&后退/摇一摇”等手势时触发变化。
停止监听罗盘数据。
监听罗盘数据变化。罗盘数据会在用户手机发生“朝向变化/加速前进&后退/摇一摇”等手势时触发变化。

加速度计​

API
描述
开始监听加速度数据。
停止监听加速度数据。
监听加速度数据。回调的频率为 5 次 / 秒,暂不支持设置。

拨打电话​

API
描述
调用宿主拨打电话功能,用户选择拨打电话或取消。

扫码​

API
描述
调用宿主的扫码界面功能,扫码成功后返回对应的扫描结果。

剪切板​

API
描述
获取系统剪贴板内容。基础库 2.53.0 开始,调用成功后,会弹出 toast 提示"已读取剪切板内容",持续 1.5s。
设置系统剪贴板内容。基础库 2.53.0 开始,调用成功后,会弹出 toast 提示"已设置剪切板内容",持续 1.5s。可以和 tt.getClipboardData 配套使用。

黑屏​

API
描述
设置是否保持屏幕常亮状态。
监听用户主动截屏事件,用户使用系统截屏按键截屏时触发此事件,只能添加一个监听器。
取消监听用户主动截屏事件,卸载通过 tt.onUserCaptureScreen 注册的截屏事件监听函数。
获取屏幕亮度。
设置屏幕亮度。
调用该 API 可以禁止用户录屏,该 API 仅支持在 Android 上调用。
调用该 API 可以取消禁止用户录屏,该 API 仅支持在 Android 上调用。
监听用户主动录屏事件,用户使用系统录屏按键录屏时触发此事件,该 API 仅支持在 iOS 上调用。​
取消监听用户主动录屏事件,卸载通过 tt.onUserScreenRecord 注册的截屏事件监听函数。​

振动​

API
描述
使手机发生较短时间的振动。Android 震动时间为 30ms,iOS 震动时间为 15ms。
使手机发生较长时间的振动(400 ms)。

性能​

API
描述
监听内存不足的告警事件。当手机内存占用过高时,触发回调函数。该事件不会杀掉小程序, 建议开发者可以在接受到告警后释放不必要的资源。 Android 下有告警等级划分。

画布​

V1​

API
描述
根据 canvas 组件 canvas-id 创建可以控制组件的上下文 CanvasContext 对象。
canvas 组件 V1 的上下文(即 canvas 组件未指定 type 属性)。可以用来控制如何在画布中绘制。
开始创建一个新的路径。
从原始画布中剪切任意形状和尺寸。一旦剪切了某个区域,则所有之后的绘图都会被限制在被剪切的区域内(即不能访问画布上的其他区域)。
将之前在绘图上下文中的描述(路径、变形、样式)画到 canvas 中。
增加一个新点,然后创建一条从上次指定点到目标点的线。
设置字体的字号。
设置填充的颜色。
创建一个线性的渐变颜色。
CanvasContext.setStrokeStyle
设置边框颜色。
设置全局画笔透明度。
使用矩阵多次叠加当前变换的方法,矩阵由方法的参数进行描述。可以缩放、旋转、移动和倾斜上下文。
对当前路径中的内容进行填充。默认的填充色为黑色。
用于画出当前路径的边框。默认颜色为黑色。
设置线条虚线样式的间距和长度。
填充一个矩形。
画一个矩形(非填充)。
绘制图像到画布。
测量文本尺寸信息。目前仅返回文本宽度。
在调用后,之后创建的路径其横纵坐标会被缩放。多次调用倍数会相乘。
以原点为中心顺时针旋转当前坐标轴。多次调用旋转的角度会叠加。
变换当前坐标系的原点 (0, 0) 。默认的坐标系原点为页面左上角。
保存绘图上下文,保存当前的绘制状态,包括变换矩阵、剪切区域、虚线列表等。
恢复之前保存的绘图上下文。包括变换矩阵、剪切区域、虚线列表等。
清除画布上在该矩形区域内的内容。
在画布上填充指定文本。
设置文字的对齐方式。
设置线条的端点样式。
设置线条的交点样式。不设置时默认为尖角样式。
设置线条的宽度。不设置时线条宽度默认为 1px。
设置最大斜接长度。
设置文字垂直方向的对齐方式。不设置时表现默认为 alphabetic
将一个新的子路径的起始点移动到指定点,不创建线条。绘制线条请调用 CanvasContext.stroke 方法。
将一个新的子路径的起始点移动到指定点,不创建线条。绘制线条请调用 CanvasContext.stroke 方法。
创建一个矩形路径。
根据指定方向(默认顺时针)从起始点开始创建一条弧线。
创建二次贝塞尔曲线路径。需要 2 个点。 第一个点是控制点,第二个点是终点。
创建三次方贝塞尔曲线路径。该方法需要三个点。 第一、第二个点是控制点,第三个点是结束点。
关闭一个路径。会连接起点和终点。
渐变的不透明对象,可通过 CanvasContext.createLinearGradient 生成。
添加颜色的渐变点。小于最小 stop 的部分会按最小 stopcolor 来渲染,大于最大 stop 的部分会按最大 stopcolor 来渲染。
设置颜色值。

V2​

API
描述
创建离屏 canvas 实例。
通过 Canvas.getContext 或者 OffscreenCanvas.getContext 获取的 Canvas 绘图上下文。
图片对象。
Canvas 实例,可通过 SelectorQuery 获取。
获取 Canvas 的绘图上下文。
在下次进行重绘时执行。
取消由 Canvas.requestAnimationFrame 添加到计划中的动画帧请求。
创建一个图片对象。
离屏 canvas 实例,可通过 tt.createOffscreenCanvas 创建。
获取 OffscreenCanvas 的绘图上下文。​

界面​

交互反馈​

API
描述
显示灰色背景的消息提示框,用以提供成功、警告和错误等反馈信息。
隐藏灰色背景的消息提示框。
显示灰色背景的 loading 提示框。该提示框不会主动隐藏。
隐藏 loading 提示框。
显示模态弹窗。用于同步用户重要信息,并要求用户进行确认,或执行特定操作以决策下一步骤。
显示操作菜单
在小程序内调起关注小程序的引导组件,用于引导用户关注小程序。

导航栏​

API
描述
在当前页面显示导航条加载动画。
在当前页面隐藏导航条加载动画。
隐藏返回首页按钮。
    基础库 1.48.0 版本起,当用户打开的小程序最底层页面是非首页时,默认展示【返回首页】按钮,开发者可在页面 onShow 中调用 hideHomeButton 进行隐藏。
    基础库 2.42.0 版本起,【返回首页】按钮 UI 改版,当用户打开小程序为一级页面,会露出小程序 logo,如果此时为非首页,点击 logo 会回到首页。此能力只能关闭返回首页的能力,但不影响左上角小程序 logo 按钮的露出。
设置导航栏标题。相关设计规范请参考导航栏 Navigation Bar
设置导航栏颜色。

菜单​

API
描述
获取自定义导航栏下不可改变的元素(比如左上角 logo/返回位置+ 右上角反馈+more+close)的位置信息。坐标信息以屏幕左上角为原点。
获取菜单按钮(右上角胶囊按钮)的布局位置信息,不包括反馈按钮。坐标信息以屏幕左上角为原点。

动画​

API
描述
创建一个动画实例 Animation

滑动返回​

API
描述
设置滑动返回的模式。

下拉刷新​

API
描述
在 Page 中注册下拉刷新的监听方法,当用户触发下拉刷新时会调用。
下拉刷新,小程序会主动触发下拉刷新动画,直到调用 tt.stopPullDownRefresh 成功后停止,调用该方法与用户手动触发下拉刷新效果一致。
停止当前页面下拉刷新。相关接口:tt.startPullDownRefresh

TabBar​

API
描述
显示 tabBar 某一项的右上角的红点,可以使用底部标签栏红点给予用户提示。相关 API:tt.hideTabBarRedDot
显示 tabBar。
动态设置 tabBar 的整体样式。底部标签栏位于小程序底部,方便用户在不同功能模块之间进行快速切换。为保证可用性,底部导航栏承载 2-5 个功能,如果超出 5 个功能项,请酌情移入页面或菜单内。
动态设置 tabBar 某一项的内容。
为 tabBar 某一项的右上角添加文本,可以利用此功能进行提示。
移除 tabBar 某一项右上角的文本。相关 API:tt.setTabBarBadge
隐藏 Tab 右上角的红点。相关 API:tt.showTabBarRedDot
隐藏 tabBar。

AI/AR 能力​

算法管理器方案​

API
描述
获取传入字段对应的算法管理器。非白名单合作用户仅支持 IDE 中「扫码体验」使用算法能力,不可在线上使用算法能力,合作事宜参见算法能力简介
AlgorithmManager 实例。可通过 tt.getAlgorithmManager 接口获取,可以通过该实例使用相应的算法能力,使用的算法与创建时传入的算法名称有关。
对输入的图像进行算法处理,获取所需算法结果数据。
通过 AlgorithmManager.doExecute 获取的算法结果。​
通过 AlgorithmManager.doExecute 获取的算法结果。​
通过 AlgorithmManager.doExecute 获取的算法结果。​
通过 AlgorithmManager.doExecute 获取的算法结果。​
通过 AlgorithmManager.doExecute 获取的算法结果。​
通过 AlgorithmManager.doExecute 获取的算法结果。​
通过 AlgorithmManager.doExecute 获取的算法结果。​

特效贴纸方案​

API
描述
获取传入贴纸 ID 对应的算法管理器。
通过 tt.createStickerManager 获取的贴纸管理器实例,能够管理贴纸资源加载。​
加载对应传入 ID 的贴纸。
通过 StickerManageronLoad 回调获取的算法处理器。​
将输入的图像纹理经过贴纸处理后绘制到输出图像纹理上。

原生神经网络方案​

API
描述
创建并返回 BytennEngineContext 神经网络管理器,可通过该对象加载 BytennEngine 神经网络引擎。
BytennEngineContext 实例。可以通过 tt.createBytennEngineContext 获取。
加载配置好的神经网络引擎。
设置当前 context 的加载失败回调。
设置当前 context 的加载成功回调。
BytennEngine 实例。可通过 tt.createBytennEngineContexonLoad 回调获取,内部网络结构和传入的网络名称有关。​
使用神经网络对输入数据进行推理。

导航​

API​
描述​
保留当前页面,跳转到应用内的某个页面,但是不能跳转到 tabBar 页面,使用 tt.navigateBack 可以返回到原页面。
关闭当前页面,跳转到应用内的某个页面,不能跳转到 tabBar 页面。
跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面,目标 tabBar 页面需要在 app.json 中定义。
关闭当前页面,返回上一页面或多级页面。
关闭所有页面,打开应用内的某个页面。

转发​

API​
描述​
传给 Page.onShareAppMessage 回调函数的参数。
开发者最终传递给发布器的数据,可以根据约定传入部分自定义数据。
显示当前小程序页面的转发按钮。转发按钮位于小程序页面右上角的“更多”中。
隐藏当前小程序页面的转发按钮。转发按钮位于小程序页面右上角的“更多”中。

第三方平台​

API
描述
获取第三方平台自定义的数据字段。
获取第三方平台自定义的数据字段。tt.getExtConfig 的同步版本。

TTML​

API
描述
返回一个 SelectorQuery 的实例,该实例上有 selectselectViewport 等方法用于选择页面节点或显示区域。
通过 tt.createSelectorQuery 获取的实例,用于查询页面节点及显示区域的信息。​
将节点的选取范围更改为指定的自定义组件内。未使用 SelectorQuery.in 的场景下,并不会选取任何自定义组件内的节点。​
在当前页面或自定义组件中选择第一个匹配选择器的节点,返回一个 NodesRef 对象实例,可以用于获取节点信息。
在当前页面或自定义组件中选择所有匹配选择器的节点,返回一个 NodesRef 对象实例,可以用于获取节点信息。
选择显示区域。可用于获取显示区域的尺寸、滚动位置等信息。
执行所有的查询。查询结果按次序构成数组,在 callback 的第一个参数中返回。
本方法创建并返回一个 IntersectionObserver 对象实例,使用方法类似于浏览器中的 Intersection Observer API。​
用于获取 TTML 节点信息的类。
添加节点的布局位置的查询请求。查询结果相对于显示区域,以像素为单位。
添加节点的滚动位置的查询请求,以像素为单位。
添加节点的相关信息的查询,在 fields 中指定需要获取的字段。
获取 Node 节点实例。目前仅支持 Canvas 的获取。
IntersectionObserver 对象,用于推断某些节点是否可以被用户看见、有多大比例可以被用户看见。
使用选择器指定一个节点,作为参照区域之一。
指定页面显示区域作为参照区域之一。
指定目标节点并开始监听目标节点和参照区域相交状态的变化情况。
停止监听,通过 IntersectionObserver.observe 方法注册的回调函数将不再触发。​