FinClip为企业提供小程序生态圈技术产品,开发者可在FinClip小程序开发帮助中心找到相关FinClip小程序指引

# 小组件 API

# 1. 基础

名称 功能说明 版本 备注
ft.canIUse 判断小程序的API,回调,参数,组件等是否在当前版本可用 1.0.0
ft.base64ToArrayBuffer 将 Base64 字符串转成 ArrayBuffer 对象 1.0.0
ft.arrayBufferToBase64 将 ArrayBuffer 对象转成 Base64 字符串 1.0.0

# 2. 系统

名称 功能说明 版本 备注
ft.getSystemInfoSync ft.getSystemInfo 的同步版本 1.0.0
ft.getSystemInfoAsync 异步获取系统信息 1.0.0
ft.getSystemInfo 获取系统信息 1.0.0
ft.openSystemBluetoothSetting 跳转系统蓝牙设置页 3.0.45 iOS:❌;Android:✅
ft.openAppAuthorizeSetting 跳转系统授权管理页 3.0.45
ft.getWindowInfo 获取窗口信息 3.0.45
ft.getSystemSetting 获取设备设置 3.0.45
ft.getRendererUserAgent 获取 Webview 小程序的 UserAgent 3.0.45
ft.getDeviceInfo 获取设备基础信息 3.0.45
ft.getAppBaseInfo 获取APP基础信息 3.0.45
ft.getAppAuthorizeSetting 获取APP授权设置 3.0.45

# 3. 更新

名称 功能说明 版本 备注
ft.getUpdateManager 获取全局唯一的版本更新管理器,用于管理小程序更新 1.0.0

# UpdateManager

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

# 4. 生命周期

名称 功能说明 版本 备注
ft.getLaunchOptionsSync 获取小程序启动时的参数 1.0.0
ft.getEnterOptionsSync 获取本次小程序启动时的参数 1.0.0

# 5. 调试

名称 功能说明 版本 备注
ft.setEnableDebug 设置是否打开调试开关 1.0.0

# console

名称 功能说明 版本 备注
console.debug 向调试面板中打印 debug 日志 1.0.0
console.error 向调试面板中打印 error 日志 1.0.0
console.group 在调试面板中创建一个新的分组 1.0.0
console.groupEnd 结束由 console.group 创建的分组 1.0.0
console.info 向调试面板中打印 info 日志 1.0.0
console.log 向调试面板中打印 log 日志 1.0.0
console.warn 向调试面板中打印 warn 日志 1.0.0

# 6. 定时器

名称 功能说明
setTimeout 设置超时
clearTimeout 清除超时
setInterval 设置定时器
clearInterval 清除定时器

# 7. 跳转

名称 功能说明 版本 备注
ft.navigateToMiniProgram 打开一个小程序 1.0.0

# 8. 交互

名称 功能说明 版本 备注
ft.showModal 显示模态对话框 1.0.0

# 9. 字体

名称 功能说明 版本 备注
ft.loadFontFace 动态加载网络字体,文件地址需为下载类型 1.0.0

# 10. 滚动

# ft.pageScrollTo

名称 功能说明 版本 备注
ft.pageScrollTo 将页面滚动到目标位置,支持选择器和滚动距离两种方式定位 1.0.0

# ScrollViewContext

名称 功能说明 版本 备注
ScrollViewContext ScrollView 操作实例,可通过 ft.createSelectorQuery 的 NodesRef.node 方法获取。 3.0.45
ScrollViewContext.scrollIntoView 滚动至指定位置 3.0.45
ScrollViewContext.scrollTo 滚动至指定位置 3.0.45

# 11. 动画

名称 功能说明 版本 备注
ft.createAnimation 创建一个动画实例 animation 1.0.0

# Animation

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

# 12. 菜单

名称 功能说明 版本 备注
ft.getMenuButtonBoundingClientRect 获取菜单按钮(右上角胶囊按钮)的布局位置信息 1.0.0

# 13. 窗口

名称 功能说明 版本 备注
ft.onWindowResize 监听窗口尺寸变化事件 1.0.0
ft.offWindowResize 取消监听窗口尺寸变化事件 1.0.0

# 14. 网络

# 发起请求

名称 功能说明 版本 备注
ft.request 发起 HTTPS 网络请求 1.0.0

# RequestTask

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

# 下载

名称 功能说明 版本 备注
ft.downloadFile 下载文件资源到本地 1.0.0

# DownloadTask

名称 功能说明 版本 备注
DownloadTask.abort 中断下载任务 1.0.0
DownloadTask.offHeadersReceived 移除 HTTP Response Header 事件的监听函数 1.0.0
DownloadTask.onHeadersReceived 监听 HTTP Response Header 事件。会比请求完成事件更早 1.0.0
DownloadTask.offProgressUpdate 移除下载进度变化事件的监听函数 1.0.0
DownloadTask.onProgressUpdate 监听下载进度变化事件 1.0.0

# 上传

名称 功能说明 版本 备注
ft.uploadFile 将本地资源上传到服务器 1.0.0

# UploadTask

名称 功能说明 版本 备注
UploadTask.abort 中断上传任务 1.0.0
UploadTask.offHeadersReceived 移除 HTTP Response Header 事件的监听函数 1.0.0
UploadTask.onHeadersReceived 监听 HTTP Response Header 事件。会比请求完成事件更早 1.0.0
UploadTask.offProgressUpdate 移除上传进度变化事件的监听函数 1.0.0
UploadTask.onProgressUpdate 监听上传进度变化事件 1.0.0

# WebSocket

名称 功能说明 版本 备注
ft.sendSocketMessage 通过 WebSocket 连接发送数据 1.0.0
ft.onSocketOpen 监听 WebSocket 连接打开事件 1.0.0
ft.onSocketMessage 监听 WebSocket 接受到服务器的消息事件 1.0.0
ft.onSocketError 监听 WebSocket 错误事件 1.0.0
ft.onSocketClose 监听 WebSocket 连接关闭事件 1.0.0
ft.connectSocket 创建一个 WebSocket 连接 1.0.0
ft.closeSocket 关闭 WebSocket 连接 1.0.0

# SocketTask

名称 功能说明 版本 备注
SocketTask.close 关闭 WebSocket 连接 1.0.0
SocketTask.onClose 监听 WebSocket 连接关闭事件 1.0.0
SocketTask.onError 监听 WebSocket 错误事件 1.0.0
SocketTask.onMessage 监听 WebSocket 接受到服务器的消息事件 1.0.0
SocketTask.onOpen 监听 WebSocket 连接打开事件 1.0.0
SocketTask.send 通过 WebSocket 连接发送数据 1.0.0

# 15. 数据缓存

名称 功能说明 版本 备注
ft.setStorageSync ft.setStorage 的同步版本 1.0.0
ft.setStorage 将数据存储在本地缓存中指定的 key 中 1.0.0
ft.removeStorageSync ft.removeStorage 的同步版本 1.0.0
ft.removeStorage 从本地缓存中移除指定 key 1.0.0
ft.getStorageSync ft.getStorage 的同步版本 1.0.0
ft.getStorageInfoSync ft.getStorageInfo 的同步版本 1.0.0
ft.getStorageInfo 异步获取当前storage的相关信息 1.0.0
ft.getStorage 从本地缓存中异步获取指定 key 的内容 1.0.0
ft.clearStorageSync ft.clearStorage 的同步版本 1.0.0
ft.clearStorage 清理本地数据缓存 1.0.0
ft.batchSetStorageSync 将数据批量存储在本地缓存中指定的 key 中 3.0.49
ft.batchSetStorage 将数据批量存储在本地缓存中指定的 key 中 3.0.49
ft.batchGetStorageSync 从本地缓存中同步批量获取指定 key 的内容 3.0.49
ft.batchGetStorage 从本地缓存中同步批量获取指定 key 的内容 3.0.49

# 周期性更新

名称 功能说明 版本 备注
ft.setBackgroundFetchToken 设置自定义登录态,在周期性拉取数据时带上,便于第三方服务器验证请求合法性 基础库 3.2.1 起支持
ft.onBackgroundFetchData 监听收到 backgroundFetch 数据时的回调 基础库 3.2.1 起支持
ft.getBackgroundFetchToken 获取设置过的自定义登录态 基础库 3.2.1 起支持
ft.getBackgroundFetchData 拉取 backgroundFetch 客户端缓存数据 基础库 3.2.1 起支持

# 16. 画布

名称 功能说明 版本 备注
ft.canvasToTempFilePath 把当前画布指定区域的内容导出生成指定大小的图片 1.0.0
ft.canvasPutImageData 将像素数据绘制到画布 1.0.0
ft.canvasGetImageData 获取 canvas 区域隐含的像素数据 1.0.0

# Canvas

名称 功能说明 版本 备注
Canvas.createImage 创建一个 image 对象,仅 createSelectorQuery 获取到的 canvas 有该方法 1.0.0
Canvas.getContext 该方法返回 Canvas 的绘图上下文 1.0.0
Canvas.createImageData 创建一个 ImageData 对象 1.0.0

# CanvasContext

名称 功能说明 版本 备注
CanvasContext.arc 创建一条弧线 1.0.0
CanvasContext.arcTo 根据控制点和半径绘制圆弧路径 1.0.0
CanvasContext.beginPath 开始创建一个路径 1.0.0
CanvasContext.clearRect 清除画布上在该矩形区域内的内容 1.0.0
CanvasContext.drawImage 绘制图像到画布 1.0.0
CanvasContext.createCircularGradient 创建一个圆形的渐变颜色 1.0.0
CanvasContext.createLinearGradient 创建一个线性的渐变颜色 1.0.0
CanvasContext.createPattern 对指定的图像创建模式的方法,可在指定的方向上重复元图像 1.0.0
CanvasContext.clip 从原始画布中剪切任意形状和尺寸 1.0.0
CanvasContext.bezierCurveTo 创建三次方贝塞尔曲线路径 1.0.0
CanvasContext.draw 将之前在绘图上下文中的描述(路径、变形、样式)画到 canvas 中 1.0.0
CanvasContext.fill 对当前路径中的内容进行填充 1.0.0
CanvasContext.fillRect 填充一个矩形 1.0.0
CanvasContext.fillText 在画布上绘制被填充的文本 1.0.0
CanvasContext.lineTo 增加一个新点,然后创建一条从上次指定点到目标点的线 1.0.0
CanvasContext.setLineDash 设置虚线样式 1.0.0
CanvasContext.setLineCap 设置线条的端点样式 1.0.0
CanvasContext.setGlobalAlpha 设置全局画笔透明度 1.0.0
CanvasContext.setFontSize 设置字体的字号 1.0.0
CanvasContext.setFillStyle 设置填充色 1.0.0
CanvasContext.scale 在调用后,之后创建的路径其横纵坐标会被缩放 1.0.0
CanvasContext.save 保存绘图上下文 1.0.0
CanvasContext.rotate 以原点为中心顺时针旋转当前坐标轴 1.0.0
CanvasContext.restore 恢复之前保存的绘图上下文 1.0.0
CanvasContext.rect 创建一个矩形路径 1.0.0
CanvasContext.quadraticCurveTo 创建二次贝塞尔曲线路径 1.0.0
CanvasContext.moveTo 把路径移动到画布中的指定点,不创建线条 1.0.0
CanvasContext.setStrokeStyle 设置描边颜色 1.0.0
CanvasContext.setShadow 设定阴影样式 1.0.0
CanvasContext.setMiterLimit 设置最大斜接长度 1.0.0
CanvasContext.setLineWidth 设置线条的宽度 1.0.0
CanvasContext.setLineJoin 设置线条的交点样式 1.0.0
CanvasContext.setTransform 使用矩阵重新设置(覆盖)当前变换的方法 1.0.0
CanvasContext.setTextBaseline 设置文字的竖直对齐 1.0.0
CanvasContext.setTextAlign 设置文字的对齐 1.0.0
CanvasContext.measureText 测量文本尺寸信息 1.0.0
CanvasContext.strokeRect 画一个矩形(非填充) 1.0.0
CanvasContext.strokeText 给定的 (x, y) 位置绘制文本描边的方法 1.0.0
CanvasContext.transform 使用矩阵多次叠加当前变换的方法 1.0.0
CanvasContext.translate 对当前坐标系的原点 (0, 0) 进行变换 1.0.0
CanvasContext.stroke 画出当前路径的边框 1.0.0

# CanvasGradient

名称 功能说明
CanvasGradient.addColorStop 添加颜色的渐变点
Color 颜色
Image 图像
ImageData ImageData 对象

# OffscreenCanvas

名称 功能说明 版本 备注
OffscreenCanvas.createImage 创建一个图片对象 1.0.0
OffscreenCanvas.getContext 该方法返回 OffscreenCanvas 的绘图上下文 1.0.0

# 17. 地图

名称 功能说明 版本 备注
ft.createMapContext 创建 map 上下文 MapContext 对象 1.0.0

# MapContext

名称 功能说明 版本 备注
MapContext.addArc 添加弧线,途经点与夹角必须设置一个 未支持
MapContext.addCustomLayer 添加个性化图层 未支持
MapContext.addGroundOverlay 创建自定义图片图层,图片会随着地图缩放而缩放 未支持
MapContext.addVisualLayer 添加可视化图层 未支持
MapContext.addMarkers 添加 marker 1.0.0
MapContext.fromScreenLocation 获取屏幕上的点对应的经纬度,坐标原点为地图左上角 1.0.0
MapContext.getCenterLocation 获取当前地图中心的经纬度 1.0.0
MapContext.getRegion 获取当前地图的视野范围 1.0.0
MapContext.getRotate 获取当前地图的旋转角 1.0.0
MapContext.getSkew 获取当前地图的倾斜角 1.0.0
MapContext.getScale 获取当前地图的缩放级别 1.0.0
MapContext.includePoints 缩放视野展示所有经纬度 1.0.0
MapContext.initMarkerCluster 初始化点聚合的配置,未调用时采用默认配置 1.0.0
MapContext.moveAlong 沿指定路径移动 marker,用于轨迹回放等场景 1.0.0
MapContext.moveToLocation 将地图中心移置当前定位点,此时需设置地图组件 show-location 为true 1.0.0
MapContext.openMapApp 拉起地图APP选择导航 1.0.0
MapContext.removeCustomLayer 移除个性化图层 未支持
MapContext.removeGroundOverlay 移除自定义图片图层 未支持
MapContext.removeMarkers 移除 marker 1.0.0
MapContext.removeVisualLayer 移除可视化图层 未支持
MapContext.setBoundary 限制地图的显示范围 未支持
MapContext.setCenterOffset 设置地图中心点偏移,向后向下为增长,屏幕比例范围(0.25~0.75),默认偏移为[0.5, 0.5] 1.0.0
MapContext.setLocMarkerIcon 设置定位点图标,支持网络路径、本地路径、代码包路径 1.0.0
MapContext.toScreenLocation 获取经纬度对应的屏幕坐标,坐标原点为地图左上角 1.0.0
MapContext.translateMarker 平移marker,带动画 1.0.0
MapContext.updateGroundOverlay 更新自定义图片图层 未支持
MapContext.on 监听地图事件 1.0.0

# 18. 图片

名称 功能说明 版本 备注
ft.saveImageToPhotosAlbum 保存图片到系统相册 1.0.0
ft.previewMedia 预览图片和视频 1.0.0
ft.previewImage 在新页面中全屏预览图片 1.0.0
ft.getImageInfo 获取图片信息 1.0.0
ft.compressImage 压缩图片接口,可选压缩质量 1.0.0
ft.chooseFile 从文件选择器选择文件 3.0.35
ft.chooseMessageFile 从客户端会话选择文件 2.0.32 需要app自定义注入
ft.chooseImage 从本地相册选择图片或使用相机拍照 1.0.0

# 19. 视频

名称 功能说明 版本 备注
ft.saveVideoToPhotosAlbum 保存视频到系统相册 1.0.0
ft.createVideoContext 创建 video 上下文 VideoContext 对象 1.0.0
ft.compressVideo 压缩视频接口 1.0.0
ft.chooseVideo 拍摄视频或从手机相册中选视频 1.0.0
ft.chooseMedia 拍摄或从手机相册中选择图片或视频 1.0.0
ft.previewVideo 预览视频 1.0.0
ft.getVideoInfo 获取视频详细信息 3.1.17

# videoContext

名称 功能说明 版本 备注
videoContext.exitBackgroundPlayback 退出后台音频播放模式 1.0.0
videoContext.exitFullScreen 退出全屏 1.0.0
videoContext.exitPictureInPicture 退出小窗,该方法可在任意页面调用 1.0.0
videoContext.hideStatusBar 隐藏状态栏,仅在iOS全屏下有效 1.0.0
videoContext.pause 暂停视频 1.0.0
videoContext.play 播放视频 1.0.0
videoContext.playbackRate 设置倍速播放 1.0.0
videoContext.requestBackgroundPlayback 进入后台音频播放模式 1.0.0
videoContext.requestFullScreen 进入全屏 1.0.0
videoContext.seek 跳转到指定位置 1.0.0
videoContext.sendDanmu 发送弹幕 1.0.0
videoContext.showStatusBar 显示状态栏,仅在iOS全屏下有效 1.0.0
videoContext.stop 停止视频 1.0.0

# 20. 音频

名称 功能说明 版本 备注
ft.stopVoice 结束播放语音 1.0.0
ft.setInnerAudioOption 设置 InnerAudioContext 的播放选项 1.0.0
ft.playVoice 开始播放语音 1.0.0
ft.pauseVoice 暂停正在播放的语音 1.0.0
ft.createInnerAudioContext 创建内部 audio 上下文 InnerAudioContext 对象 1.0.0
ft.createAudioContext 创建 audio 上下文 AudioContext 对象 1.0.0
ft.getAvailableAudioSources 获取当前支持的音频输入源 3.1.7 开发工具中获取到的是固定值 auto

# audiocontext

名称 功能说明 版本 备注
audiocontext.setSrc 设置音频地址 1.0.0
audiocontext.play 播放音频 1.0.0
audiocontext.pause 暂停音频 1.0.0
audiocontext.seek 跳转到指定位置 1.0.0

# InnerAudioContext

名称 功能说明 版本 备注
InnerAudioContext.destroy 销毁当前实例 1.0.0
InnerAudioContext.offCanplay 取消监听音频进入可以播放状态的事件 1.0.0
InnerAudioContext.offEnded 取消监听音频自然播放至结束的事件 1.0.0
InnerAudioContext.offError 取消监听音频播放错误事件 1.0.0
InnerAudioContext.offTimeUpdate 取消监听音频播放进度更新事件 1.0.0
InnerAudioContext.offSeeking 取消监听音频进行跳转操作的事件 1.0.0
InnerAudioContext.offWaiting 取消监听音频加载中事件 1.0.0
InnerAudioContext.onEnded 监听音频自然播放至结束的事件 1.0.0
InnerAudioContext.offPlay 取消监听音频播放事件 1.0.0
InnerAudioContext.onCanplay 监听音频进入可以播放状态的事件 1.0.0
InnerAudioContext.onPause 监听音频暂停事件 1.0.0
InnerAudioContext.offPause 取消监听音频暂停事件 1.0.0
InnerAudioContext.offSeeked 取消监听音频完成跳转操作的事件 1.0.0
InnerAudioContext.offStop 取消监听音频停止事件 1.0.0
InnerAudioContext.onError 监听音频播放错误事件 1.0.0
InnerAudioContext.onPlay 监听音频播放事件 1.0.0
InnerAudioContext.onSeeked 监听音频完成跳转操作的事件 1.0.0
InnerAudioContext.onSeeking 监听音频进行跳转操作的事件 1.0.0
InnerAudioContext.onStop 监听音频停止事件 1.0.0
InnerAudioContext.onTimeUpdate 监听音频播放进度更新事件 1.0.0
InnerAudioContext.onWaiting 监听音频加载中事件 1.0.0
InnerAudioContext.pause 暂停 1.0.0
InnerAudioContext.play 播放 1.0.0
InnerAudioContext.seek 跳转到指定位置 1.0.0
InnerAudioContext.stop 停止 1.0.0

# 21. 背景音频

名称 功能说明 版本 备注
ft.stopBackgroundAudio 停止播放音乐 1.0.0
ft.seekBackgroundAudio 控制音乐播放进度 1.0.0
ft.playBackgroundAudio 使用后台播放器播放音乐 1.0.0
ft.pauseBackgroundAudio 暂停播放音乐 1.0.0
ft.onBackgroundAudioStop 监听音乐停止事件 1.0.0
ft.onBackgroundAudioPlay 监听音乐播放事件 1.0.0
ft.onBackgroundAudioPause 监听音乐暂停事件 1.0.0
ft.getBackgroundAudioPlayerState 获取后台音乐播放状态 1.0.0
ft.getBackgroundAudioManager 获取全局唯一的背景音频管理器 小程序切入后台,如果音频处于播放状态,可以继续播放。但是后台状态不能通过调用API操纵音频的播放状态。 2.12.12

# backgroundaudiomanager

名称 功能说明 版本 备注
backgroundaudiomanager.onCanplay 监听背景音频进入可播放状态事件 1.0.0
backgroundaudiomanager.onEnded 监听背景音频自然播放结束事件 1.0.0
BackgroundAudioManager.onError 监听背景音频播放错误事件 1.0.0
backgroundaudiomanager.onNext 监听用户在系统音乐播放面板点击下一曲事件(仅iOS) 1.0.0
backgroundaudiomanager.onPause 监听背景音频暂停事件 1.0.0
backgroundaudiomanager.onPlay 监听背景音频播放事件 1.0.0
backgroundaudiomanager.onPrev 监听用户在系统音乐播放面板点击上一曲事件(仅iOS) 1.0.0
backgroundaudiomanager.onSeeked 监听背景音频完成跳转操作事件 1.0.0
backgroundaudiomanager.onSeeking 监听背景音频开始跳转操作事件 1.0.0
backgroundaudiomanager.onStop 监听背景音频停止事件 1.0.0
backgroundaudiomanager.onTimeUpdate 监听背景音频播放进度更新事件,只有小程序在前台时会回调 1.0.0
backgroundaudiomanager.onWaiting 监听音频加载中事件 1.0.0
backgroundaudiomanager.pause 暂停音乐 1.0.0
backgroundaudiomanager.play 播放音乐 1.0.0
backgroundaudiomanager.seek 跳转到指定位置 1.0.0
backgroundaudiomanager.stop 停止音乐 1.0.0

# 22. 富文本

# EditorContext

名称 功能说明 版本 备注
EditorContext.blur 编辑器失焦,同时收起键盘 1.0.0
EditorContext.clear 清空编辑器内容 1.0.0
EditorContext.format 修改样式 1.0.0
EditorContext.getContents 获取编辑器内容 1.0.0
EditorContext.getSelectionText 获取编辑器已选区域内的纯文本内容 1.0.0
EditorContext.insertDivider 插入分割线 1.0.0
EditorContext.insertImage 插入图片 1.0.0
EditorContext.insertText 覆盖当前选区,设置一段文本 1.0.0
EditorContext.redo 恢复 1.0.0
EditorContext.removeFormat 清除当前选区的样式 1.0.0
EditorContext.scrollIntoView 使得编辑器光标处滚动到窗口可视区域内 1.0.0
EditorContext.setContents 初始化编辑器内容,html和delta同时存在时仅delta生效 1.0.0
EditorContext.undo 撤销 1.0.0

# 23. 文件

名称 功能说明 版本 备注
ft.saveFile 保存文件到本地 1.0.0
ft.removeSavedFile 删除本地缓存文件 1.0.0
ft.openDocument 新开页面打开文档 1.0.0
ft.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 1.0.0
ft.getSavedFileInfo 获取本地文件的文件信息 1.0.0
ft.getFileSystemManager 获取全局唯一的文件管理器 1.0.0
ft.getFileInfo 获取文件信息 1.0.0
ft.saveFileToDisk 保存文件系统的文件到用户磁盘,仅在 PC 端支持 1.0.0

# FileSystemManager

名称 功能说明 版本 备注
FileSystemManager.accessSync 判断文件/目录是否存在 1.0.0
FileSystemManager.access 判断文件/目录是否存在 1.0.0
FileSystemManager.appendFile 在文件结尾追加内容 1.0.0
FileSystemManager.appendFileSync FileSystemManager.appendFile 的同步版本 1.0.0
FileSystemManager.close 关闭文件 1.0.0
FileSystemManager.closeSync 同步关闭文件 1.0.0
FileSystemManager.copyFile 复制文件 1.0.0
FileSystemManager.copyFileSync FileSystemManager.copyFile 的同步版本 1.0.0
FileSystemManager.getFileInfo 获取该小程序下的 本地临时文件 或 本地缓存文件 信息 1.0.0
FileSystemManager.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 1.0.0
FileSystemManager.mkdir 创建目录 1.0.0
FileSystemManager.mkdirSync FileSystemManager.mkdir 的同步版本 1.0.0
FileSystemManager.readdir 读取目录内文件列表 1.0.0
FileSystemManager.readdirSync FileSystemManager.readdir 的同步版本 1.0.0
FileSystemManager.readFile 读取本地文件内容 1.0.0
FileSystemManager.readFileSync FileSystemManager.readFile 的同步版本 1.0.0
FileSystemManager.removeSavedFile 删除该小程序下已保存的本地缓存文件 1.0.0
FileSystemManager.rename 重命名文件 1.0.0
FileSystemManager.renameSync FileSystemManager.rename 的同步版本 1.0.0
FileSystemManager.rmdir 删除目录 1.0.0
FileSystemManager.rmdirSync FileSystemManager.rmdir 的同步版本 1.0.0
FileSystemManager.saveFile 保存临时文件到本地 1.0.0
FileSystemManager.saveFileSync FileSystemManager.saveFile 的同步版本 1.0.0
FileSystemManager.stat 获取文件 Stats 对象 1.0.0
FileSystemManager.statSync FileSystemManager.stat 的同步版本 1.0.0
FileSystemManager.unlink 删除文件 1.0.0
FileSystemManager.unlinkSync FileSystemManager.unlink 的同步版本 1.0.0
FileSystemManager.unzip 解压文件 1.0.0
FileSystemManager.writeFile 写文件 1.0.0
FileSystemManager.writeFileSync FileSystemManager.writeFile 的同步版本 1.0.0
FileSystemManager.write 写入文件 1.0.0
FileSystemManager.writeSync FileSystemManager.write同步版本 1.0.0
FileSystemManager.fstat 获取文件的状态信息 1.0.0
FileSystemManager.fstatSync 同步获取文件的状态信息 1.0.0
FileSystemManager.ftruncate 对文件内容进行截断操作 1.0.0
FileSystemManager.ftruncateSync 对文件内容进行截断操作 1.0.0
FileSystemManager.open 打开文件,返回文件描述符 1.0.0
FileSystemManager.openSync 同步打开文件,返回文件描述符 1.0.0
FileSystemManager.read 读文件 1.0.0
FileSystemManager.readCompressedFile 读取指定压缩类型的本地文件内容 1.0.0
FileSystemManager.readCompressedFileSync 同步读取指定压缩类型的本地文件内容 1.0.0
FileSystemManager.readSync 读文件 1.0.0
FileSystemManager.readZipEntry 读取压缩包内的文件 1.0.0
FileSystemManager.truncate 对文件内容进行截断操作 1.0.0
FileSystemManager.truncateSync 对文件内容进行截断操作 (truncate 的同步版本) 1.0.0
ReadResult 文件读取结果 1.0.0

# Stats

名称 功能说明 版本 备注
Stats.isDirectory 判断当前文件是否一个目录 1.0.0
Stats.isFile 判断当前文件是否一个普通文件 1.0.0
WriteResult 文件写入结果 1.0.0

# 24. 加密

名称 功能说明 版本 备注
ft.getRandomValues 获取密码学安全随机数 1.0.0

# 25. 屏幕

名称 功能说明 版本 备注
ft.setScreenBrightness 设置屏幕亮度 1.0.0
ft.setKeepScreenOn 设置是否保持常亮状态 1.3.9
ft.onUserCaptureScreen 监听用户主动截屏事件 1.0.0
ft.offUserCaptureScreen 用户主动截屏事件 1.0.0
ft.getScreenBrightness 获取屏幕亮度 1.0.0

# 26. 陀螺仪

名称 功能说明 版本 备注
ft.stopGyroscope 停止监听陀螺仪数据 3.0.46
ft.startGyroscope 开始监听陀螺仪数据 3.0.46
ft.onGyroscopeChange 监听陀螺仪数据变化事件 3.0.46
ft.offGyroscopeChange 取消监听陀螺仪数据变化事件 3.0.46

# 27. 振动

名称 功能说明 版本 备注
ft.vibrateShort 使手机发生较短时间的振动(15 ms) 1.0.0
ft.vibrateLong 使手机发生较长时间的振动(400 ms) 1.0.0

# 28. FXML

名称 功能说明 版本 备注
ft.createSelectorQuery 返回一个 SelectorQuery 对象实例 1.0.0
ft.createIntersectionObserver 创建并返回一个 IntersectionObserver 对象实例 1.0.0

# IntersectionObserver

名称 功能说明 版本 备注
IntersectionObserver.disconnect 停止监听 1.0.0
IntersectionObserver.observe 指定目标节点并开始监听相交状态变化情况 1.0.0
IntersectionObserver.relativeTo 使用选择器指定一个节点,作为参照区域之一 1.0.0
IntersectionObserver.relativeToViewport 指定页面显示区域作为参照区域之一 1.0.0

# SelectorQuery

名称 功能说明 版本 备注
SelectorQuery.exec 执行所有的请求 1.0.0
SelectorQuery.in 将选择器的选取范围更改为自定义组件 component 内 1.0.0
SelectorQuery.select 在当前页面下选择第一个匹配选择器 selector 的节点 1.0.0
SelectorQuery.selectAll 在当前页面下选择匹配选择器 selector 的所有节点 1.0.0
SelectorQuery.selectViewport 选择显示区域 1.0.0
© FinClip with ❤ , Since 2017